org.opends.server.extensions
Class StartTLSExtendedOperation

java.lang.Object
  extended by org.opends.server.api.ExtendedOperationHandler<StartTLSExtendedOperationHandlerCfg>
      extended by org.opends.server.extensions.StartTLSExtendedOperation

public class StartTLSExtendedOperation
extends ExtendedOperationHandler<StartTLSExtendedOperationHandlerCfg>

This class provides an implementation of the StartTLS extended operation as defined in RFC 2830. It can enable the TLS connection security provider on an established connection upon receiving an appropriate request from a client.


Constructor Summary
StartTLSExtendedOperation()
          Create an instance of this StartTLS extended operation handler.
 
Method Summary
 void finalizeExtendedOperationHandler()
          Performs any finalization that may be necessary for this extended operation handler.
 void initializeExtendedOperationHandler(StartTLSExtendedOperationHandlerCfg config)
          Initializes this extended operation handler based on the information in the provided configuration entry.
 void processExtendedOperation(ExtendedOperation operation)
          Processes the provided extended operation.
 
Methods inherited from class org.opends.server.api.ExtendedOperationHandler
deregisterControlsAndFeatures, getSupportedControls, getSupportedFeatures, isConfigurationAcceptable, registerControlsAndFeatures, supportsControl, supportsFeature
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StartTLSExtendedOperation

public StartTLSExtendedOperation()
Create an instance of this StartTLS extended operation handler. All initialization should be performed in the initializeExtendedOperationHandler method.

Method Detail

initializeExtendedOperationHandler

public void initializeExtendedOperationHandler(StartTLSExtendedOperationHandlerCfg config)
                                        throws ConfigException,
                                               InitializationException
Initializes this extended operation handler based on the information in the provided configuration entry. It should also register itself with the Directory Server for the particular kinds of extended operations that it will process.

Specified by:
initializeExtendedOperationHandler in class ExtendedOperationHandler<StartTLSExtendedOperationHandlerCfg>
Parameters:
config - The configuration that contains the information to use to initialize this extended operation handler.
Throws:
ConfigException - If an unrecoverable problem arises in the process of performing the initialization.
InitializationException - If a problem occurs during initialization that is not related to the server configuration.

finalizeExtendedOperationHandler

public void finalizeExtendedOperationHandler()
Performs any finalization that may be necessary for this extended operation handler. By default, no finalization is performed.

Overrides:
finalizeExtendedOperationHandler in class ExtendedOperationHandler<StartTLSExtendedOperationHandlerCfg>

processExtendedOperation

public void processExtendedOperation(ExtendedOperation operation)
Processes the provided extended operation.

Specified by:
processExtendedOperation in class ExtendedOperationHandler<StartTLSExtendedOperationHandlerCfg>
Parameters:
operation - The extended operation to be processed.