com.unboundid.ldap.listener.interceptor

Interface InMemoryInterceptedModifyResult

All Superinterfaces:

InMemoryInterceptedResult

@NotExtensible
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface InMemoryInterceptedModifyResult
extends InMemoryInterceptedResult

This class provides an API that can be used in the course of processing a modify request via the InMemoryOperationInterceptor API.

Method Summary

Modifier and Type	Method and Description
ReadOnlyModifyRequest	getRequest() Retrieves the modify request that was processed.
LDAPResult	getResult() Retrieves the modify result to be returned to the client.
void	sendIntermediateResponse(IntermediateResponse intermediateResponse) Sends the provided intermediate response message to the client.
void	setResult(LDAPResult modifyResult) Replaces the modify result to be returned to the client.

Methods inherited from interface com.unboundid.ldap.listener.interceptor.InMemoryInterceptedResult

getConnectedAddress, getConnectedPort, getConnectionID, getMessageID, getProperty, sendUnsolicitedNotification

Method Detail

getRequest

@NotNull
ReadOnlyModifyRequest getRequest()

Retrieves the modify request that was processed. If the request was altered between the time it was received from the client and the time it was actually processed by the in-memory directory server, then this will be the most recently altered version.

Returns:

The modify request that was processed.

getResult

@Nullable
LDAPResult getResult()

Retrieves the modify result to be returned to the client.

Returns:

The modify result to be returned to the client.

setResult

void setResult(@NotNull
               LDAPResult modifyResult)

Replaces the modify result to be returned to the client.

Parameters:

modifyResult - The modify result that should be returned to the client instead of the result originally generated by the in-memory directory server. It must not be null.

sendIntermediateResponse

void sendIntermediateResponse(@NotNull
                              IntermediateResponse intermediateResponse)
                       throws LDAPException

Sends the provided intermediate response message to the client. It will be processed by the InMemoryOperationInterceptor.processIntermediateResponse(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedIntermediateResponse) method of all registered operation interceptors.

Parameters:

intermediateResponse - The intermediate response to send to the client. It must not be null.

Throws:

LDAPException - If a problem is encountered while trying to send the intermediate response.