Package com.unboundid.ldap.protocol

Class BindResponseProtocolOp

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

  • Field Details

  • Constructor Details

    • BindResponseProtocolOp

      public BindResponseProtocolOp(int resultCode, @Nullable String matchedDN, @Nullable String diagnosticMessage, @Nullable List<String> referralURLs, @Nullable ASN1OctetString serverSASLCredentials)
      Creates a new instance of this bind response protocol op with the provided information.
      Parameters:
      resultCode - The result code for this response.
      matchedDN - The matched DN for this response, if available.
      diagnosticMessage - The diagnostic message for this response, if any.
      referralURLs - The list of referral URLs for this response, if any.
      serverSASLCredentials - The server SASL credentials for this response, if available.

    • BindResponseProtocolOp

      public BindResponseProtocolOp(@NotNull LDAPResult result)
      Creates a new bind response protocol op from the provided bind result object.
      Parameters:
      result - The LDAP result object to use to create this protocol op.

  • Method Details

    • getResultCode

      public int getResultCode()
      Retrieves the result code for this bind response.
      Returns:
      The result code for this bind response.

    • getMatchedDN

      @Nullable public String getMatchedDN()
      Retrieves the matched DN for this bind response, if any.
      Returns:
      The matched DN for this bind response, or null if there is no matched DN.

    • getDiagnosticMessage

      @Nullable public String getDiagnosticMessage()
      Retrieves the diagnostic message for this bind response, if any.
      Returns:
      The diagnostic message for this bind response, or null if there is no diagnostic message.

    • getReferralURLs

      @NotNull public List<String> getReferralURLs()
      Retrieves the list of referral URLs for this bind response.
      Returns:
      The list of referral URLs for this bind response, or an empty list if there are no referral URLs.

    • getServerSASLCredentials

      @Nullable public ASN1OctetString getServerSASLCredentials()
      Retrieves the server SASL credentials for this bind response, if any.
      Returns:
      The server SASL credentials for this bind response, or null if there are no server SASL credentials.

    • 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 BindResponseProtocolOp decodeProtocolOp(@NotNull ASN1Element element) throws LDAPException
      Decodes the provided ASN.1 element as a bind response protocol op.
      Parameters:
      element - The ASN.1 element to be decoded.
      Returns:
      The decoded bind response protocol op.
      Throws:
      LDAPException - If the provided ASN.1 element cannot be decoded as a bind response 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.

    • toBindResult

      @NotNull public BindResult toBindResult(@Nullable Control... controls)
      Creates a new LDAP result object from this response protocol op.
      Parameters:
      controls - The set of controls to include in the LDAP result. It may be empty or null if no controls should be included.
      Returns:
      The LDAP result 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.