|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@NotExtensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public interface InMemoryInterceptedSearchResult
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 was processed. |
LDAPResult |
getResult()
Retrieves the search result to be returned to the client. |
void |
sendIntermediateResponse(IntermediateResponse intermediateResponse)
Sends the provided intermediate response message to the client. |
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 |
setResult(LDAPResult searchResult)
Replaces the search result to be returned to the client. |
Methods inherited from interface com.unboundid.ldap.listener.interceptor.InMemoryInterceptedResult |
---|
getConnectedAddress, getConnectedPort, getConnectionID, getMessageID, getProperty, sendUnsolicitedNotification |
Method Detail |
---|
ReadOnlySearchRequest getRequest()
LDAPResult getResult()
void setResult(LDAPResult searchResult)
searchResult
- The search 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
.void sendSearchEntry(Entry entry) throws LDAPException
InMemoryOperationInterceptor.processSearchEntry(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedSearchEntry)
method of
all registered operation interceptors.
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.
LDAPException
- If a problem is encountered while trying to send
the search result entry.void sendSearchReference(SearchResultReference reference) throws LDAPException
InMemoryOperationInterceptor.processSearchReference(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedSearchReference)
method of all
registered operation interceptors.
reference
- The search result reference to be returned to the
client. It must not be null
.
LDAPException
- If a problem is encountered while trying to send
the search result reference.void sendIntermediateResponse(IntermediateResponse intermediateResponse) throws LDAPException
InMemoryOperationInterceptor.processIntermediateResponse(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedIntermediateResponse)
method of
all registered operation interceptors.
intermediateResponse
- The intermediate response to send to the
client. It must not be null
.
LDAPException
- If a problem is encountered while trying to send
the intermediate response.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |