Package com.unboundid.ldap.protocol

Class SearchResultReferenceProtocolOp

java.lang.Object
com.unboundid.ldap.protocol.SearchResultReferenceProtocolOp
All Implemented Interfaces:
ProtocolOp, Serializable
@InternalUseOnly @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SearchResultReferenceProtocolOp extends Object implements ProtocolOp
This class provides an implementation of an LDAP search result reference protocol op.
See Also:

  • Constructor Details

    • SearchResultReferenceProtocolOp

      public SearchResultReferenceProtocolOp(@NotNull List<String> referralURLs)
      Creates a new search result reference protocol op with the provided information.
      Parameters:
      referralURLs - The list of referral URLs for this search result reference.

    • SearchResultReferenceProtocolOp

      public SearchResultReferenceProtocolOp(@NotNull SearchResultReference reference)
      Creates a new search result reference protocol op from the provided search result reference.
      Parameters:
      reference - The search result reference to use to create this protocol op.

  • Method Details

    • getReferralURLs

      @NotNull public List<String> getReferralURLs()
      Retrieves the list of referral URLs for this search result reference.
      Returns:
      The list of referral URLs for this search result reference.

    • getProtocolOpType

      public byte getProtocolOpType()
      Retrieves the BER type for this protocol op.
      Specified by:
      getProtocolOpType in interface ProtocolOp
      Returns:
      The BER type for this protocol op.

    • encodeProtocolOp

      @NotNull public ASN1Element encodeProtocolOp()
      Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.
      Specified by:
      encodeProtocolOp in interface ProtocolOp
      Returns:
      The ASN.1 element containing the encoded protocol op.

    • decodeProtocolOp

      @NotNull public static SearchResultReferenceProtocolOp decodeProtocolOp(@NotNull ASN1Element element) throws LDAPException
      Decodes the provided ASN.1 element as a search result reference protocol op.
      Parameters:
      element - The ASN.1 element to be decoded.
      Returns:
      The decoded search result reference protocol op.
      Throws:
      LDAPException - If the provided ASN.1 element cannot be decoded as a search result reference protocol op.

    • writeTo

      public void writeTo(@NotNull ASN1Buffer buffer)
      Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer. This method is intended for internal use only and should not be used by third-party code.
      Specified by:
      writeTo in interface ProtocolOp
      Parameters:
      buffer - The ASN.1 buffer to which the encoded representation should be written.

    • toSearchResultReference

      @NotNull public SearchResultReference toSearchResultReference(@Nullable Control... controls)
      Creates a search result reference from this protocol op.
      Parameters:
      controls - The set of controls to include in the search result reference. It may be empty or null if no controls should be included.
      Returns:
      The search result reference that was created.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this protocol op.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this protocol op.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this LDAP protocol op to the provided buffer.
      Specified by:
      toString in interface ProtocolOp
      Parameters:
      buffer - The buffer to which the string representation should be appended.