com.unboundid.ldap.listener

Class InMemoryExtendedOperationHandler

java.lang.Object

com.unboundid.ldap.listener.InMemoryExtendedOperationHandler

Direct Known Subclasses:

PasswordModifyExtendedOperationHandler, TransactionExtendedOperationHandler, WhoAmIExtendedOperationHandler

@Extensible
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public abstract class InMemoryExtendedOperationHandler
extends java.lang.Object

This class defines an API that may be used to provide support for one or more types of extended operations in the in-memory directory server.

Constructor Summary

Constructors

Constructor and Description
InMemoryExtendedOperationHandler()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getExtendedOperationHandlerName() Retrieves the name that should be used for this extended operation handler.
abstract java.util.List<java.lang.String>	getSupportedExtendedRequestOIDs() Retrieves a list of the extended request OIDs supported by this extended operation handler.
abstract ExtendedResult	processExtendedOperation(InMemoryRequestHandler handler, int messageID, ExtendedRequest request) Performs the appropriate processing for the provided extended request.
java.lang.String	toString() Retrieves a string representation of this extended operation handler.

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryExtendedOperationHandler

public InMemoryExtendedOperationHandler()

Method Detail

getExtendedOperationHandlerName

@NotNull
public abstract java.lang.String getExtendedOperationHandlerName()

Retrieves the name that should be used for this extended operation handler.

Returns:

The name that should be used for this extended operation handler.

getSupportedExtendedRequestOIDs

@NotNull
public abstract java.util.List<java.lang.String> getSupportedExtendedRequestOIDs()

Retrieves a list of the extended request OIDs supported by this extended operation handler.

Returns:

A list of the extended request OIDs supported by this extended operation handler.

processExtendedOperation

@NotNull
public abstract ExtendedResult processExtendedOperation(@NotNull
                                                                 InMemoryRequestHandler handler,
                                                                 int messageID,
                                                                 @NotNull
                                                                 ExtendedRequest request)

Performs the appropriate processing for the provided extended request. This method is completely responsible for any controls associated with the provided request.

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 getSupportedExtendedRequestOIDs() method.

Returns:

The result that should be returned to the client in response to the provided request.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this extended operation handler.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this extended operation handler.