com.unboundid.ldap.listener

Interface SearchReferenceTransformer

All Known Implementing Classes:

InMemoryOperationInterceptorRequestHandler, LDAPDebuggerRequestHandler

@Extensible
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public interface SearchReferenceTransformer

This interface may be implemented by a class which wishes to intercept and alter search result references in some way before they are returned to the client, and/or to prevent them from being returned altogether. Search reference transformers may be enabled or disabled by adding them to or removing them from an LDAPListenerClientConnection.

Method Summary

Modifier and Type	Method and Description
ObjectPair<SearchResultReferenceProtocolOp,Control[]>	transformReference(int messageID, SearchResultReferenceProtocolOp reference, Control[] controls) Transforms the provided search result reference and/or set of controls to alter what will be returned to the client.

Method Detail

transformReference

@Nullable
ObjectPair<SearchResultReferenceProtocolOp,Control[]> transformReference(int messageID,
                                                                                   @NotNull
                                                                                   SearchResultReferenceProtocolOp reference,
                                                                                   @NotNull
                                                                                   Control[] controls)

Transforms the provided search result reference and/or set of controls to alter what will be returned to the client.

Parameters:

messageID - The message ID for the associated search operation.

reference - The search result reference 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 reference and set of controls, or null to indicate that the reference should not be returned to the client.