Package org.opends.server.extensions

Class WhoAmIExtendedOperation

java.lang.Object

org.opends.server.api.ExtendedOperationHandler<WhoAmIExtendedOperationHandlerCfg>

org.opends.server.extensions.WhoAmIExtendedOperation

public final 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

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getExtendedOperationName()	Retrieves the name associated with this extended operation.
String	getExtendedOperationOID()	Retrieves the object OID associated with this extended operation.
void	processExtendedOperation(ExtendedOperation operation)	Processes the provided extended operation.

Methods inherited from class org.opends.server.api.ExtendedOperationHandler

finalizeExtendedOperationHandler, getServerContext, getSupportedControls, getSupportedFeatures, initializeExtendedOperationHandler, isConfigurationAcceptable, supportsControl

Methods inherited from class java.lang.Object

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

Constructor Details

WhoAmIExtendedOperation

public WhoAmIExtendedOperation()

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

Method Details

processExtendedOperation

public void processExtendedOperation(ExtendedOperation operation)
                              throws LdapException

Description copied from class: ExtendedOperationHandler

Processes the provided extended operation.

Specified by:

processExtendedOperation in class ExtendedOperationHandler<WhoAmIExtendedOperationHandlerCfg>

Parameters:

operation - The extended operation to be processed.

Throws:

LdapException - If the extended operation failed. The exception's result will be returned to the client.

getExtendedOperationOID

public String getExtendedOperationOID()

Description copied from class: ExtendedOperationHandler

Retrieves the object OID associated with this extended operation.

Specified by:

getExtendedOperationOID in class ExtendedOperationHandler<WhoAmIExtendedOperationHandlerCfg>

Returns:

the oid associated with this extended operation, if any, or null if there is none.

getExtendedOperationName

public String getExtendedOperationName()

Description copied from class: ExtendedOperationHandler

Retrieves the name associated with this extended operation.

Specified by:

getExtendedOperationName in class ExtendedOperationHandler<WhoAmIExtendedOperationHandlerCfg>

Returns:

The name associated with this extended operation, if any, or null if there is none.