org.opends.server.extensions
Class WhoAmIExtendedOperation

java.lang.Object
  org.opends.server.api.ExtendedOperationHandler<WhoAmIExtendedOperationHandlerCfg>
      org.opends.server.extensions.WhoAmIExtendedOperation

public class WhoAmIExtendedOperation
extends ExtendedOperationHandler<WhoAmIExtendedOperationHandlerCfg>

This class implements the "Who Am I?" extended operation defined in RFC 4532. It simply returns the authorized ID of the currently-authenticated user.

Constructor Summary

WhoAmIExtendedOperation()
Create an instance of this "Who Am I?" extended operation.

Method Summary

void	finalizeExtendedOperationHandler() Performs any finalization that may be necessary for this extended operation handler.
java.util.Set<java.lang.String>	getSupportedControls() Retrieves the OIDs of the controls that may be supported by this extended operation handler.
void	initializeExtendedOperationHandler(WhoAmIExtendedOperationHandlerCfg 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, 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

WhoAmIExtendedOperation

public WhoAmIExtendedOperation()

Create an instance of this "Who Am I?" extended operation. All initialization should be performed in the initializeExtendedOperationHandler method.

Method Detail

initializeExtendedOperationHandler

public void initializeExtendedOperationHandler(WhoAmIExtendedOperationHandlerCfg 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<WhoAmIExtendedOperationHandlerCfg>

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<WhoAmIExtendedOperationHandlerCfg>

getSupportedControls

public java.util.Set<java.lang.String> getSupportedControls()

Retrieves the OIDs of the controls that may be supported by this extended operation handler. It should be overridden by any extended operation handler which provides special support for one or more controls.

Overrides:

getSupportedControls in class ExtendedOperationHandler<WhoAmIExtendedOperationHandlerCfg>

Returns:

The OIDs of the controls that may be supported by this extended operation handler.

processExtendedOperation

public void processExtendedOperation(ExtendedOperation operation)

Processes the provided extended operation.

Specified by:

processExtendedOperation in class ExtendedOperationHandler<WhoAmIExtendedOperationHandlerCfg>

Parameters:

operation - The extended operation to be processed.