|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.protocols.ldap.ProtocolOp
org.opends.server.protocols.ldap.ExtendedResponseProtocolOp
public class ExtendedResponseProtocolOp
This class defines the structures and methods for an LDAP extended response protocol op, which is used to provide information about the result of processing a extended request.
Constructor Summary | |
---|---|
ExtendedResponseProtocolOp(int resultCode)
Creates a new extended response protocol op with the provided result code. |
|
ExtendedResponseProtocolOp(int resultCode,
Message errorMessage)
Creates a new extended response protocol op with the provided result code and error message. |
|
ExtendedResponseProtocolOp(int resultCode,
Message errorMessage,
DN matchedDN,
java.util.List<java.lang.String> referralURLs)
Creates a new extended response protocol op with the provided information. |
|
ExtendedResponseProtocolOp(int resultCode,
Message errorMessage,
DN matchedDN,
java.util.List<java.lang.String> referralURLs,
java.lang.String oid,
ASN1OctetString value)
Creates a new extended response protocol op with the provided information. |
Method Summary | |
---|---|
static ExtendedResponseProtocolOp |
decodeExtendedResponse(ASN1Element element)
Decodes the provided ASN.1 element as a extended response protocol op. |
ASN1Element |
encode()
Encodes this protocol op to an ASN.1 element suitable for including in an LDAP message. |
Message |
getErrorMessage()
Retrieves the error message for this response. |
DN |
getMatchedDN()
Retrieves the matched DN for this response. |
java.lang.String |
getOID()
Retrieves the OID for this extended response. |
java.lang.String |
getProtocolOpName()
Retrieves the name for this protocol op type. |
java.util.List<java.lang.String> |
getReferralURLs()
Retrieves the set of referral URLs for this response. |
int |
getResultCode()
Retrieves the result code for this response. |
byte |
getType()
Retrieves the BER type for this protocol op. |
ASN1OctetString |
getValue()
Retrieves the value for this extended response. |
void |
setErrorMessage(Message errorMessage)
Specifies the error message for this response. |
void |
setMatchedDN(DN matchedDN)
Specifies the matched DN for this response. |
void |
setOID(java.lang.String oid)
Specifies the OID for this extended response. |
void |
setReferralURLs(java.util.List<java.lang.String> referralURLs)
Specifies the set of referral URLs for this response. |
void |
setResultCode(int resultCode)
Specifies the result code for this response. |
void |
setValue(ASN1OctetString value)
Specifies the value for this extended response. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP protocol op to the provided buffer. |
void |
toString(java.lang.StringBuilder buffer,
int indent)
Appends a multi-line string representation of this LDAP protocol op to the provided buffer. |
Methods inherited from class org.opends.server.protocols.ldap.ProtocolOp |
---|
decode, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ExtendedResponseProtocolOp(int resultCode)
resultCode
- The result code for this response.public ExtendedResponseProtocolOp(int resultCode, Message errorMessage)
resultCode
- The result code for this response.errorMessage
- The error message for this response.public ExtendedResponseProtocolOp(int resultCode, Message errorMessage, DN matchedDN, java.util.List<java.lang.String> referralURLs)
resultCode
- The result code for this response.errorMessage
- The error message for this response.matchedDN
- The matched DN for this response.referralURLs
- The referral URLs for this response.public ExtendedResponseProtocolOp(int resultCode, Message errorMessage, DN matchedDN, java.util.List<java.lang.String> referralURLs, java.lang.String oid, ASN1OctetString value)
resultCode
- The result code for this response.errorMessage
- The error message for this response.matchedDN
- The matched DN for this response.referralURLs
- The referral URLs for this response.oid
- The OID for this extended response.value
- The value for this extended response.Method Detail |
---|
public int getResultCode()
public void setResultCode(int resultCode)
resultCode
- The result code for this response.public Message getErrorMessage()
null
if none
is available.public void setErrorMessage(Message errorMessage)
errorMessage
- The error message for this response.public DN getMatchedDN()
null
if none is
available.public void setMatchedDN(DN matchedDN)
matchedDN
- The matched DN for this response.public java.util.List<java.lang.String> getReferralURLs()
null
if none are available.public void setReferralURLs(java.util.List<java.lang.String> referralURLs)
referralURLs
- The set of referral URLs for this response.public java.lang.String getOID()
null
if none
was provided.public void setOID(java.lang.String oid)
oid
- The OID for this extended response.public ASN1OctetString getValue()
null
if none
was provided.public void setValue(ASN1OctetString value)
value
- The value for this extended response.public byte getType()
getType
in class ProtocolOp
public java.lang.String getProtocolOpName()
getProtocolOpName
in class ProtocolOp
public ASN1Element encode()
encode
in class ProtocolOp
public static ExtendedResponseProtocolOp decodeExtendedResponse(ASN1Element element) throws LDAPException
element
- The ASN.1 element to decode.
LDAPException
- If a problem occurs while attempting to decode the
ASN.1 element to a protocol op.public void toString(java.lang.StringBuilder buffer)
toString
in class ProtocolOp
buffer
- The buffer to which the string should be appended.public void toString(java.lang.StringBuilder buffer, int indent)
toString
in class ProtocolOp
buffer
- The buffer to which the information should be appended.indent
- The number of spaces from the margin that the lines should
be indented.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |