Interface InMemoryInterceptedSearchReference
-
- All Superinterfaces:
InMemoryInterceptedResult
@NotExtensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public interface InMemoryInterceptedSearchReference extends InMemoryInterceptedResult
This class provides an API that can be used in the course of processing a search request via theInMemoryOperationInterceptor
API.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ReadOnlySearchRequest
getRequest()
Retrieves the search request that is being processed.SearchResultReference
getSearchReference()
Retrieves the search result reference to be returned to the client.void
setSearchReference(SearchResultReference reference)
Replaces the search result reference 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 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.
-
getSearchReference
@Nullable SearchResultReference getSearchReference()
Retrieves the search result reference to be returned to the client.- Returns:
- The search result reference to be returned to the client.
-
setSearchReference
void setSearchReference(@Nullable SearchResultReference reference)
Replaces the search result reference to be returned to the client. It may benull
if the reference should be suppressed rather than being returned to the client.- Parameters:
reference
- The search result reference to be returned to the client. It may benull
if the reference should be suppressed rather than being returned to the client.
-
-