@InternalUseOnly @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class BindResponseProtocolOp extends java.lang.Object implements ProtocolOp
Modifier and Type | Field and Description |
---|---|
static byte |
TYPE_SERVER_SASL_CREDENTIALS
The BER type for the server SASL credentials element.
|
Constructor and 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.
|
Modifier and Type | Method and 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.
|
public static final byte TYPE_SERVER_SASL_CREDENTIALS
public BindResponseProtocolOp(int resultCode, java.lang.String matchedDN, java.lang.String diagnosticMessage, java.util.List<java.lang.String> referralURLs, ASN1OctetString serverSASLCredentials)
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.public BindResponseProtocolOp(LDAPResult result)
result
- The LDAP result object to use to create this protocol op.public int getResultCode()
public java.lang.String getMatchedDN()
null
if there is
no matched DN.public java.lang.String getDiagnosticMessage()
null
if
there is no diagnostic message.public java.util.List<java.lang.String> getReferralURLs()
public ASN1OctetString getServerSASLCredentials()
null
if there are no server SASL credentials.public byte getProtocolOpType()
getProtocolOpType
in interface ProtocolOp
public ASN1Element encodeProtocolOp()
encodeProtocolOp
in interface ProtocolOp
public static BindResponseProtocolOp decodeProtocolOp(ASN1Element element) throws LDAPException
element
- The ASN.1 element to be decoded.LDAPException
- If the provided ASN.1 element cannot be decoded as
a bind response protocol op.public void writeTo(ASN1Buffer buffer)
writeTo
in interface ProtocolOp
buffer
- The ASN.1 buffer to which the encoded representation should
be written.public BindResult toBindResult(Control... controls)
controls
- The set of controls to include in the LDAP result. It
may be empty or null
if no controls should be
included.public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
toString
in interface ProtocolOp
buffer
- The buffer to which the string representation should be
appended.