@InternalUseOnly @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ExtendedResponseProtocolOp extends java.lang.Object implements ProtocolOp
Modifier and Type | Field and Description |
---|---|
static byte |
TYPE_RESPONSE_OID
The BER type for the response OID element.
|
static byte |
TYPE_RESPONSE_VALUE
The BER type for the response value element.
|
Constructor and Description |
---|
ExtendedResponseProtocolOp(int resultCode,
java.lang.String matchedDN,
java.lang.String diagnosticMessage,
java.util.List<java.lang.String> referralURLs,
java.lang.String responseOID,
ASN1OctetString responseValue)
Creates a new instance of this extended response protocol op with the
provided information.
|
ExtendedResponseProtocolOp(LDAPResult result)
Creates a new extended response protocol op from the provided extended
result object.
|
Modifier and Type | Method and Description |
---|---|
static ExtendedResponseProtocolOp |
decodeProtocolOp(ASN1Element element)
Decodes the provided ASN.1 element as an extended 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 extended response, if any.
|
java.lang.String |
getMatchedDN()
Retrieves the matched DN for this extended 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 extended response.
|
java.lang.String |
getResponseOID()
Retrieves the OID for this extended response, if any.
|
ASN1OctetString |
getResponseValue()
Retrieves the value for this extended response, if any.
|
int |
getResultCode()
Retrieves the result code for this extended response.
|
ExtendedResult |
toExtendedResult(Control... controls)
Creates a extended result from this 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_RESPONSE_OID
public static final byte TYPE_RESPONSE_VALUE
public ExtendedResponseProtocolOp(int resultCode, java.lang.String matchedDN, java.lang.String diagnosticMessage, java.util.List<java.lang.String> referralURLs, java.lang.String responseOID, ASN1OctetString responseValue)
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.responseOID
- The response OID for this response, if any.responseValue
- The value for this response, if any.public ExtendedResponseProtocolOp(LDAPResult result)
result
- The extended 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 java.lang.String getResponseOID()
null
if there is no
response OID.public ASN1OctetString getResponseValue()
null
if there is
no response value.public byte getProtocolOpType()
getProtocolOpType
in interface ProtocolOp
public ASN1Element encodeProtocolOp()
encodeProtocolOp
in interface ProtocolOp
public static ExtendedResponseProtocolOp decodeProtocolOp(ASN1Element element) throws LDAPException
element
- The ASN.1 element to be decoded.LDAPException
- If the provided ASN.1 element cannot be decoded as
an extended 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 ExtendedResult toExtendedResult(Control... controls)
controls
- The set of controls to include in the extended 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.