Package com.unboundid.ldap.listener

Class TransactionExtendedOperationHandler

java.lang.Object

com.unboundid.ldap.listener.InMemoryExtendedOperationHandler

com.unboundid.ldap.listener.TransactionExtendedOperationHandler

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

This class provides an implementation of an extended operation handler for the start transaction and end transaction extended operations as defined in RFC 5805.

Constructor Summary

Constructors

Constructor	Description
TransactionExtendedOperationHandler()	Creates a new instance of this extended operation handler.

Method Summary

Modifier and Type	Method	Description
String	getExtendedOperationHandlerName()	Retrieves the name that should be used for this extended operation handler.
List<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 Details

TransactionExtendedOperationHandler

public TransactionExtendedOperationHandler()

Creates a new instance of this extended operation handler.

Method Details

getExtendedOperationHandlerName

@NotNull
public 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

@NotNull
public List<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

@NotNull
public 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.

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.