@InternalUseOnly @NotExtensible @ThreadSafety(level=COMPLETELY_THREADSAFE) public abstract class GenericResponseProtocolOp extends java.lang.Object implements ProtocolOp
Modifier and Type | Field and Description |
---|---|
static byte |
TYPE_REFERRALS
The BER type for the referral URLs elements.
|
Modifier | Constructor and Description |
---|---|
protected |
GenericResponseProtocolOp(ASN1StreamReader reader)
Creates a new response read from the provided ASN.1 stream reader.
|
protected |
GenericResponseProtocolOp(byte type,
int resultCode,
java.lang.String matchedDN,
java.lang.String diagnosticMessage,
java.util.List<java.lang.String> referralURLs)
Creates a new instance of this response with the provided information.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDiagnosticMessage()
Retrieves the diagnostic message for this response, if any.
|
java.lang.String |
getMatchedDN()
Retrieves the matched DN for this 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 response.
|
int |
getResultCode()
Retrieves the result code for this response.
|
LDAPResult |
toLDAPResult(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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
encodeProtocolOp
public static final byte TYPE_REFERRALS
protected GenericResponseProtocolOp(byte type, int resultCode, java.lang.String matchedDN, java.lang.String diagnosticMessage, java.util.List<java.lang.String> referralURLs)
type
- The BER type for this response.resultCode
- The result code for this response.matchedDN
- The matched DN for this result, if available.diagnosticMessage
- The diagnostic message for this response, if
available.referralURLs
- The list of referral URLs for this response, if
available.protected GenericResponseProtocolOp(ASN1StreamReader reader) throws LDAPException
reader
- The ASN.1 stream reader from which to read the response.LDAPException
- If a problem occurs while reading or parsing the
response.public final int getResultCode()
public final java.lang.String getMatchedDN()
null
if there is
no matched DN.public final java.lang.String getDiagnosticMessage()
null
if there
is no diagnostic message.public final java.util.List<java.lang.String> getReferralURLs()
public byte getProtocolOpType()
getProtocolOpType
in interface ProtocolOp
public final void writeTo(ASN1Buffer buffer)
writeTo
in interface ProtocolOp
buffer
- The ASN.1 buffer to which the encoded representation should
be written.public LDAPResult toLDAPResult(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 final java.lang.String toString()
toString
in class java.lang.Object
public final void toString(java.lang.StringBuilder buffer)
toString
in interface ProtocolOp
buffer
- The buffer to which the string representation should be
appended.