Package com.unboundid.ldap.listener.interceptor

Interface InMemoryInterceptedSearchRequest

All Superinterfaces:

InMemoryInterceptedRequest

@NotExtensible
@ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface InMemoryInterceptedSearchRequest
extends InMemoryInterceptedRequest

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

Method Summary

Modifier and Type	Method	Description
ReadOnlySearchRequest	getRequest()	Retrieves the search request to be processed.
void	sendSearchEntry(Entry entry)	Sends the provided search result entry to the client.
void	sendSearchReference(SearchResultReference reference)	Sends the provided search result reference to the client.
void	setRequest(SearchRequest searchRequest)	Replaces the search request to be processed.

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

getConnectedAddress, getConnectedPort, getConnectionID, getMessageID, getProperty, sendIntermediateResponse, sendUnsolicitedNotification, setProperty

Method Details

getRequest

@NotNull
ReadOnlySearchRequest getRequest()

Retrieves the search request to be processed.

Returns:

The search request to be processed.

setRequest

void setRequest(@NotNull
 SearchRequest searchRequest)

Replaces the search request to be processed.

Parameters:

searchRequest - The search request that should be processed instead of the one that was originally received from the client. It must not be null.

sendSearchEntry

void sendSearchEntry(@NotNull
 Entry entry)
              throws LDAPException

Sends the provided search result entry to the client. It will be processed by the InMemoryOperationInterceptor.processSearchEntry(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedSearchEntry) method of all registered operation interceptors.

Parameters:

entry - The search result entry to be returned to the client. It must not be null. If the provided entry is a SearchResultEntry, then it may optionally include one or more controls to provide to the client. If it is any other type of Entry, then it will not include any controls.

Throws:

LDAPException - If a problem is encountered while trying to send the search result entry.

sendSearchReference

void sendSearchReference(@NotNull
 SearchResultReference reference)
                  throws LDAPException

Sends the provided search result reference to the client. It will be processed by the InMemoryOperationInterceptor.processSearchReference(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedSearchReference) method of all registered operation interceptors.

Parameters:

reference - The search result reference to be returned to the client. It must not be null.

Throws:

LDAPException - If a problem is encountered while trying to send the search result reference.