Package com.unboundid.ldap.listener.interceptor

Interface InMemoryInterceptedDeleteResult

All Superinterfaces:

InMemoryInterceptedResult

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

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

Method Summary

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

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

getConnectedAddress, getConnectedPort, getConnectionID, getMessageID, getProperty, sendUnsolicitedNotification

Method Details

getRequest

@NotNull
ReadOnlyDeleteRequest getRequest()

Retrieves the delete 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 delete request that was processed.

getResult

@Nullable
LDAPResult getResult()

Retrieves the delete result to be returned to the client.

Returns:

The delete result to be returned to the client.

setResult

void setResult(@NotNull
 LDAPResult deleteResult)

Replaces the delete result to be returned to the client.

Parameters:

deleteResult - The delete 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.