com.unboundid.ldap.listener.interceptor

Interface InMemoryInterceptedIntermediateResponse

All Superinterfaces:

InMemoryInterceptedResult

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

This class provides an API that can be used in the course of processing an intermediate response via the InMemoryOperationInterceptor API.

Method Summary

Methods

Modifier and Type	Method and Description
IntermediateResponse	getIntermediateResponse() Retrieves the intermediate response to be returned to the client.
InMemoryInterceptedRequest	getRequest() Retrieves the request associated with the operation that is being processed.
void	setIntermediateResponse(IntermediateResponse response) Replaces the intermediate response 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
InMemoryInterceptedRequest getRequest()

Retrieves the request associated with the operation that is being 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 request associated with the operation that is being processed.

getIntermediateResponse

@Nullable
IntermediateResponse getIntermediateResponse()

Retrieves the intermediate response to be returned to the client.

Returns:

The intermediate response to be returned to the client.

setIntermediateResponse

void setIntermediateResponse(@Nullable
                           IntermediateResponse response)

Replaces the intermediate response to be returned to the client. It may be null if the response should be suppressed rather than being returned to the client.

Parameters:

response - The intermediate response to be returned to the client. It may be null if the response should be suppressed rather than being returned to the client.