org.apache.directory.server.ldap.handlers.extended

Class StartTlsHandler

java.lang.Object

org.apache.directory.server.ldap.handlers.extended.StartTlsHandler

All Implemented Interfaces:

ExtendedOperationHandler<org.apache.directory.api.ldap.model.message.ExtendedRequest<org.apache.directory.api.ldap.model.message.ExtendedResponse>,org.apache.directory.api.ldap.model.message.ExtendedResponse>

public class StartTlsHandler
extends Object
implements ExtendedOperationHandler<org.apache.directory.api.ldap.model.message.ExtendedRequest<org.apache.directory.api.ldap.model.message.ExtendedResponse>,org.apache.directory.api.ldap.model.message.ExtendedResponse>

Handler for the StartTLS extended operation.

Author:

Apache Directory Project

See Also:

RFC 2830

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTENSION_OID

Constructor Summary

Constructors

Constructor and Description
StartTlsHandler()

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getExtensionOids() The OIDs of the extensions supported by this handler.
String	getOid() Returns the EXTENSION_OID of the extended request this handler can handle.
void	handleExtendedOperation(LdapSession session, org.apache.directory.api.ldap.model.message.ExtendedRequest<org.apache.directory.api.ldap.model.message.ExtendedResponse> req) Handles the specified extended operation.
void	setLdapServer(LdapServer ldapServer) Sets the LDAP server for this extendedOperation handler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXTENSION_OID

public static final String EXTENSION_OID

See Also:

Constant Field Values

Constructor Detail

StartTlsHandler

public StartTlsHandler()

Method Detail

handleExtendedOperation

public void handleExtendedOperation(LdapSession session,
                           org.apache.directory.api.ldap.model.message.ExtendedRequest<org.apache.directory.api.ldap.model.message.ExtendedResponse> req)
                             throws Exception

Description copied from interface: ExtendedOperationHandler

Handles the specified extended operation.

Specified by:

handleExtendedOperation in interface ExtendedOperationHandler<org.apache.directory.api.ldap.model.message.ExtendedRequest<org.apache.directory.api.ldap.model.message.ExtendedResponse>,org.apache.directory.api.ldap.model.message.ExtendedResponse>

Parameters:

session - the session object related with current connection

req - the LDAP Extended operation request

Throws:

Exception - if failed to handle the operation

getExtensionOids

public final Set<String> getExtensionOids()

Description copied from interface: ExtendedOperationHandler

The OIDs of the extensions supported by this handler. This includes the request as well as any responses associated with the request. These OIDs will be registered with the server to publish them as supportedExtensions.

Specified by:

getExtensionOids in interface ExtendedOperationHandler<org.apache.directory.api.ldap.model.message.ExtendedRequest<org.apache.directory.api.ldap.model.message.ExtendedResponse>,org.apache.directory.api.ldap.model.message.ExtendedResponse>

Returns:

the OIDs supported by this handler.

getOid

public final String getOid()

Description copied from interface: ExtendedOperationHandler

Returns the EXTENSION_OID of the extended request this handler can handle.

Specified by:

getOid in interface ExtendedOperationHandler<org.apache.directory.api.ldap.model.message.ExtendedRequest<org.apache.directory.api.ldap.model.message.ExtendedResponse>,org.apache.directory.api.ldap.model.message.ExtendedResponse>

setLdapServer

public void setLdapServer(LdapServer ldapServer)

Description copied from interface: ExtendedOperationHandler

Sets the LDAP server for this extendedOperation handler.

Specified by:

setLdapServer in interface ExtendedOperationHandler<org.apache.directory.api.ldap.model.message.ExtendedRequest<org.apache.directory.api.ldap.model.message.ExtendedResponse>,org.apache.directory.api.ldap.model.message.ExtendedResponse>

Parameters:

ldapServer - the ldap protocol server