com.unboundid.ldap.listener
Class WhoAmIExtendedOperationHandler

java.lang.Object
  extended by com.unboundid.ldap.listener.InMemoryExtendedOperationHandler
      extended by com.unboundid.ldap.listener.WhoAmIExtendedOperationHandler

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class WhoAmIExtendedOperationHandler
extends InMemoryExtendedOperationHandler

This class provides an implementation of an extended operation handler for the in-memory directory server that can be used to process the "Who Am I?" extended operation as defined in RFC 4532.


Constructor Summary
WhoAmIExtendedOperationHandler()
          Creates a new instance of this extended operation handler.
 
Method Summary
 java.lang.String getExtendedOperationHandlerName()
          Retrieves the name that should be used for this extended operation handler.
 java.util.List<java.lang.String> getSupportedExtendedRequestOIDs()
          Retrieves a list of the extended request OIDs supported by this extended operation handler.
 ExtendedResult processExtendedOperation(InMemoryRequestHandler handler, int messageID, ExtendedRequest request)
          Performs the appropriate processing for the provided extended request.
 
Methods inherited from class com.unboundid.ldap.listener.InMemoryExtendedOperationHandler
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WhoAmIExtendedOperationHandler

public WhoAmIExtendedOperationHandler()
Creates a new instance of this extended operation handler.

Method Detail

getExtendedOperationHandlerName

public java.lang.String getExtendedOperationHandlerName()
Retrieves the name that should be used for this extended operation handler.

Specified by:
getExtendedOperationHandlerName in class InMemoryExtendedOperationHandler
Returns:
The name that should be used for this extended operation handler.

getSupportedExtendedRequestOIDs

public java.util.List<java.lang.String> getSupportedExtendedRequestOIDs()
Retrieves a list of the extended request OIDs supported by this extended operation handler.

Specified by:
getSupportedExtendedRequestOIDs in class InMemoryExtendedOperationHandler
Returns:
A list of the extended request OIDs supported by this extended operation handler.

processExtendedOperation

public ExtendedResult processExtendedOperation(InMemoryRequestHandler handler,
                                               int messageID,
                                               ExtendedRequest request)
Performs the appropriate processing for the provided extended request. This method is completely responsible for any controls associated with the provided request.

Specified by:
processExtendedOperation in class InMemoryExtendedOperationHandler
Parameters:
handler - The in-memory request handler that accepted the extended request.
messageID - The message ID for the LDAP message that the client used to send the request.
request - The extended request to process, which will have a request OID which matches one of the OIDs in the list returned byt the InMemoryExtendedOperationHandler.getSupportedExtendedRequestOIDs() method.
Returns:
The result that should be returned to the client in response to the provided request.