org.opends.server.protocols.ldap
Class AbandonRequestProtocolOp

java.lang.Object
  extended by org.opends.server.protocols.ldap.ProtocolOp
      extended by org.opends.server.protocols.ldap.AbandonRequestProtocolOp

public class AbandonRequestProtocolOp
extends ProtocolOp

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

AbandonRequestProtocolOp

public AbandonRequestProtocolOp(int idToAbandon)
Creates a new abandon request protocol op to abandon the specified operation.

Parameters:
idToAbandon - The message ID of the operation to abandon.
Method Detail

getIDToAbandon

public int getIDToAbandon()
Retrieves the message ID of the operation to abandon.

Returns:
The message ID of the operation to abandon.

setIDToAbandon

public void setIDToAbandon(int idToAbandon)
Specifies the message ID of the operation to abandon.

Parameters:
idToAbandon - The message ID of the operation to abandon.

getType

public byte getType()
Retrieves the BER type for this protocol op.

Specified by:
getType in class ProtocolOp
Returns:
The BER type for this protocol op.

getProtocolOpName

public java.lang.String getProtocolOpName()
Retrieves the name for this protocol op type.

Specified by:
getProtocolOpName in class ProtocolOp
Returns:
The name for this protocol op type.

encode

public ASN1Element encode()
Encodes this protocol op to an ASN.1 element suitable for including in an LDAP message.

Specified by:
encode in class ProtocolOp
Returns:
The ASN.1 element containing the encoded protocol op.

decodeAbandonRequest

public static AbandonRequestProtocolOp decodeAbandonRequest(ASN1Element element)
                                                     throws LDAPException
Decodes the provided ASN.1 element as an abandon request protocol op.

Parameters:
element - The ASN.1 element to decode.
Returns:
The decoded abandon request protocol op.
Throws:
LDAPException - If the provided ASN.1 element cannot be decoded as an abandon request protocol op.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP protocol op to the provided buffer.

Specified by:
toString in class ProtocolOp
Parameters:
buffer - The buffer to which the string should be appended.

toString

public void toString(java.lang.StringBuilder buffer,
                     int indent)
Appends a multi-line string representation of this LDAP protocol op to the provided buffer.

Specified by:
toString in class ProtocolOp
Parameters:
buffer - The buffer to which the information should be appended.
indent - The number of spaces from the margin that the lines should be indented.