com.unboundid.ldap.listener
Interface SearchEntryTransformer
- All Known Implementing Classes:
- AccessLogRequestHandler, InMemoryOperationInterceptorRequestHandler, LDAPDebuggerRequestHandler
@Extensible
@ThreadSafety(level=INTERFACE_THREADSAFE)
public interface SearchEntryTransformer
This interface may be implemented by a class which wishes to intercept and
alter search result entries in some way before they are returned to the
client, and/or to prevent them from being returned altogether. Search entry
transformers may be enabled or disabled by adding them to or removing them
from an LDAPListenerClientConnection
.
transformEntry
ObjectPair<SearchResultEntryProtocolOp,Control[]> transformEntry(int messageID,
SearchResultEntryProtocolOp entry,
Control[] controls)
- Transforms the provided search result entry and/or set of controls to alter
what will be returned to the client.
- Parameters:
messageID
- The message ID for the associated search operation.entry
- The search result entry to be processed. It will not be
null
.controls
- The set of controls to be processed. It will not be
null
but may be empty if there are no controls.
- Returns:
- An
ObjectPair
containing a possibly updated entry and set
of controls, or null
to indicate that the entry should not
be returned to the client.