|
|||||||||
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.AbandonRequestProtocolOp
public class AbandonRequestProtocolOp
This class defines the structures and methods for an LDAP abandon request protocol op, which is used to indicate that the server should stop processing a previously requested operation.
Constructor Summary | |
---|---|
AbandonRequestProtocolOp(int idToAbandon)
Creates a new abandon request protocol op to abandon the specified operation. |
Method Summary | |
---|---|
static AbandonRequestProtocolOp |
decodeAbandonRequest(ASN1Element element)
Decodes the provided ASN.1 element as an abandon request protocol op. |
ASN1Element |
encode()
Encodes this protocol op to an ASN.1 element suitable for including in an LDAP message. |
int |
getIDToAbandon()
Retrieves the message ID of the operation to abandon. |
java.lang.String |
getProtocolOpName()
Retrieves the name for this protocol op type. |
byte |
getType()
Retrieves the BER type for this protocol op. |
void |
setIDToAbandon(int idToAbandon)
Specifies the message ID of the operation to abandon. |
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 AbandonRequestProtocolOp(int idToAbandon)
idToAbandon
- The message ID of the operation to abandon.Method Detail |
---|
public int getIDToAbandon()
public void setIDToAbandon(int idToAbandon)
idToAbandon
- The message ID of the operation to abandon.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 AbandonRequestProtocolOp decodeAbandonRequest(ASN1Element element) throws LDAPException
element
- The ASN.1 element to decode.
LDAPException
- If the provided ASN.1 element cannot be decoded as
an abandon request 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 |