com.unboundid.ldap.listener.interceptor
Interface InMemoryInterceptedSearchEntry

All Superinterfaces:
InMemoryInterceptedResult

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

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


Method Summary
 ReadOnlySearchRequest getRequest()
          Retrieves the search request that is being processed.
 SearchResultEntry getSearchEntry()
          Retrieves the search result entry to be returned to the client.
 void setSearchEntry(Entry entry)
          Replaces the search result entry 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

ReadOnlySearchRequest getRequest()
Retrieves the search request 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 search request that was processed.

getSearchEntry

SearchResultEntry getSearchEntry()
Retrieves the search result entry to be returned to the client.

Returns:
The search result entry to be returned to the client.

setSearchEntry

void setSearchEntry(Entry entry)
Replaces the search result entry to be returned to the client. It may be null if the entry should be suppressed rather than being returned to the client. 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.

Parameters:
entry - The search result entry to be returned to the client. It may be null if the entry should be suppressed rather than being returned to the client. 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.