Package com.unboundid.ldap.sdk

Class SearchResultReference

java.lang.Object
com.unboundid.ldap.sdk.SearchResultReference
All Implemented Interfaces:
LDAPResponse, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SearchResultReference extends Object implements Serializable, LDAPResponse
This class provides a data structure for representing an LDAP search result reference. A search result reference consists of a set of referral URLs and may also include zero or more controls. It describes an alternate location in which additional results for the search may be found. If there are multiple referral URLs, then they should all be considered equivalent ways to access the information (e.g., referrals referencing different servers that may be contacted).
See Also:

  • Constructor Details

    • SearchResultReference

      public SearchResultReference(@NotNull String[] referralURLs, @NotNull Control[] controls)
      Creates a new search result reference with the provided information.
      Parameters:
      referralURLs - The set of referral URLs for this search result reference. It must not be null.
      controls - The set of controls returned with this search result reference. It must not be null.

    • SearchResultReference

      public SearchResultReference(int messageID, @NotNull String[] referralURLs, @NotNull Control[] controls)
      Creates a new search result reference with the provided information.
      Parameters:
      messageID - The message ID for the LDAP message containing this response.
      referralURLs - The set of referral URLs for this search result reference. It must not be null.
      controls - The set of controls returned with this search result reference. It must not be null.

  • Method Details

    • getMessageID

      public int getMessageID()
      Retrieves the message ID for the LDAP message containing this response.
      Specified by:
      getMessageID in interface LDAPResponse
      Returns:
      The message ID for the LDAP message containing this response.

    • getReferralURLs

      @NotNull public String[] getReferralURLs()
      Retrieves the set of referral URLs for this search result reference.
      Returns:
      The set of referral URLs for this search result reference.

    • getControls

      @NotNull public Control[] getControls()
      Retrieves the set of controls returned with this search result reference. Individual response controls of a specific type may be retrieved and decoded using the get method in the response control class.
      Returns:
      The set of controls returned with this search result reference.

    • getControl

      @Nullable public Control getControl(@NotNull String oid)
      Retrieves the control with the specified OID. If there is more than one control with the given OID, then the first will be returned.
      Parameters:
      oid - The OID of the control to retrieve.
      Returns:
      The control with the requested OID, or null if there is no such control for this search result reference.

    • toString

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

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this search result reference to the provided buffer.
      Specified by:
      toString in interface LDAPResponse
      Parameters:
      buffer - The buffer to which to append the string representation of this search result reference.