Interface SearchReferenceTransformer

    • 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.