Package com.unboundid.ldap.protocol
Class BindResponseProtocolOp
- java.lang.Object
-
- com.unboundid.ldap.protocol.BindResponseProtocolOp
-
- All Implemented Interfaces:
ProtocolOp
,java.io.Serializable
@InternalUseOnly @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class BindResponseProtocolOp extends java.lang.Object implements ProtocolOp
This class provides an implementation of a bind response protocol op.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static byte
TYPE_SERVER_SASL_CREDENTIALS
The BER type for the server SASL credentials element.
-
Constructor Summary
Constructors Constructor Description BindResponseProtocolOp(int resultCode, java.lang.String matchedDN, java.lang.String diagnosticMessage, java.util.List<java.lang.String> referralURLs, ASN1OctetString serverSASLCredentials)
Creates a new instance of this bind response protocol op with the provided information.BindResponseProtocolOp(LDAPResult result)
Creates a new bind response protocol op from the provided bind result object.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static BindResponseProtocolOp
decodeProtocolOp(ASN1Element element)
Decodes the provided ASN.1 element as a bind response protocol op.ASN1Element
encodeProtocolOp()
Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.java.lang.String
getDiagnosticMessage()
Retrieves the diagnostic message for this bind response, if any.java.lang.String
getMatchedDN()
Retrieves the matched DN for this bind response, if any.byte
getProtocolOpType()
Retrieves the BER type for this protocol op.java.util.List<java.lang.String>
getReferralURLs()
Retrieves the list of referral URLs for this bind response.int
getResultCode()
Retrieves the result code for this bind response.ASN1OctetString
getServerSASLCredentials()
Retrieves the server SASL credentials for this bind response, if any.BindResult
toBindResult(Control... controls)
Creates a new LDAP result object from this response protocol op.java.lang.String
toString()
Retrieves a string representation of this protocol op.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP protocol op to the provided buffer.void
writeTo(ASN1Buffer buffer)
Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer.
-
-
-
Field Detail
-
TYPE_SERVER_SASL_CREDENTIALS
public static final byte TYPE_SERVER_SASL_CREDENTIALS
The BER type for the server SASL credentials element.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BindResponseProtocolOp
public BindResponseProtocolOp(int resultCode, java.lang.String matchedDN, java.lang.String diagnosticMessage, java.util.List<java.lang.String> referralURLs, 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(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 Detail
-
getResultCode
public int getResultCode()
Retrieves the result code for this bind response.- Returns:
- The result code for this bind response.
-
getMatchedDN
public java.lang.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
public java.lang.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
public java.util.List<java.lang.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
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 interfaceProtocolOp
- Returns:
- The BER type for this protocol op.
-
encodeProtocolOp
public ASN1Element encodeProtocolOp()
Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.- Specified by:
encodeProtocolOp
in interfaceProtocolOp
- Returns:
- The ASN.1 element containing the encoded protocol op.
-
decodeProtocolOp
public static BindResponseProtocolOp decodeProtocolOp(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(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 interfaceProtocolOp
- Parameters:
buffer
- The ASN.1 buffer to which the encoded representation should be written.
-
toBindResult
public BindResult toBindResult(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 ornull
if no controls should be included.- Returns:
- The LDAP result that was created.
-
toString
public java.lang.String toString()
Retrieves a string representation of this protocol op.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this protocol op.
-
toString
public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP protocol op to the provided buffer.- Specified by:
toString
in interfaceProtocolOp
- Parameters:
buffer
- The buffer to which the string representation should be appended.
-
-