Package com.unboundid.ldap.protocol
Class ExtendedResponseProtocolOp
- java.lang.Object
-
- com.unboundid.ldap.protocol.ExtendedResponseProtocolOp
-
- All Implemented Interfaces:
ProtocolOp
,java.io.Serializable
@InternalUseOnly @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ExtendedResponseProtocolOp extends java.lang.Object implements ProtocolOp
This class provides an implementation of a extended response protocol op.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field 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 Summary
Constructors Constructor 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.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.
-
-
-
Field Detail
-
TYPE_RESPONSE_OID
public static final byte TYPE_RESPONSE_OID
The BER type for the response OID element.- See Also:
- Constant Field Values
-
TYPE_RESPONSE_VALUE
public static final byte TYPE_RESPONSE_VALUE
The BER type for the response value element.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ExtendedResponseProtocolOp
public ExtendedResponseProtocolOp(int resultCode, @Nullable java.lang.String matchedDN, @Nullable java.lang.String diagnosticMessage, @Nullable java.util.List<java.lang.String> referralURLs, @Nullable java.lang.String responseOID, @Nullable ASN1OctetString responseValue)
Creates a new instance of this extended 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.responseOID
- The response OID for this response, if any.responseValue
- The value for this response, if any.
-
ExtendedResponseProtocolOp
public ExtendedResponseProtocolOp(@NotNull LDAPResult result)
Creates a new extended response protocol op from the provided extended result object.- Parameters:
result
- The extended result object to use to create this protocol op.
-
-
Method Detail
-
getResultCode
public int getResultCode()
Retrieves the result code for this extended response.- Returns:
- The result code for this extended response.
-
getMatchedDN
@Nullable public java.lang.String getMatchedDN()
Retrieves the matched DN for this extended response, if any.- Returns:
- The matched DN for this extended response, or
null
if there is no matched DN.
-
getDiagnosticMessage
@Nullable public java.lang.String getDiagnosticMessage()
Retrieves the diagnostic message for this extended response, if any.- Returns:
- The diagnostic message for this extended response, or
null
if there is no diagnostic message.
-
getReferralURLs
@NotNull public java.util.List<java.lang.String> getReferralURLs()
Retrieves the list of referral URLs for this extended response.- Returns:
- The list of referral URLs for this extended response, or an empty list if there are no referral URLs.
-
getResponseOID
@Nullable public java.lang.String getResponseOID()
Retrieves the OID for this extended response, if any.- Returns:
- The OID for this extended response, or
null
if there is no response OID.
-
getResponseValue
@Nullable public ASN1OctetString getResponseValue()
Retrieves the value for this extended response, if any.- Returns:
- The value for this extended response, or
null
if there is no response value.
-
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
@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 interfaceProtocolOp
- Returns:
- The ASN.1 element containing the encoded protocol op.
-
decodeProtocolOp
@NotNull public static ExtendedResponseProtocolOp decodeProtocolOp(@NotNull ASN1Element element) throws LDAPException
Decodes the provided ASN.1 element as an extended response protocol op.- Parameters:
element
- The ASN.1 element to be decoded.- Returns:
- The decoded extended response protocol op.
- Throws:
LDAPException
- If the provided ASN.1 element cannot be decoded as an extended 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 interfaceProtocolOp
- Parameters:
buffer
- The ASN.1 buffer to which the encoded representation should be written.
-
toExtendedResult
@NotNull public ExtendedResult toExtendedResult(@Nullable Control... controls)
Creates a extended result from this protocol op.- Parameters:
controls
- The set of controls to include in the extended result. It may be empty ornull
if no controls should be included.- Returns:
- The extended result that was created.
-
toString
@NotNull 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(@NotNull 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.
-
-