Package org.opends.server.protocols.ldap

Class AbandonRequestProtocolOp

java.lang.Object

org.opends.server.protocols.ldap.ProtocolOp

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

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	getIDToAbandon()	Retrieves the message ID of the operation to abandon.
String	getProtocolOpName()	Retrieves the name for this protocol op type.
byte	getType()	Retrieves the BER type for this protocol op.
void	toString(StringBuilder buffer)	Appends a string representation of this LDAP protocol op to the provided buffer.
void	toString(StringBuilder buffer, int indent)	Appends a multi-line string representation of this LDAP protocol op to the provided buffer.
void	write(ASN1Writer stream)	Writes this protocol op to an ASN.1 output stream.

Methods inherited from class org.opends.server.protocols.ldap.ProtocolOp

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.

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 String getProtocolOpName()

Retrieves the name for this protocol op type.

Specified by:

getProtocolOpName in class ProtocolOp

Returns:

The name for this protocol op type.

write

public void write(ASN1Writer stream)
           throws IOException

Writes this protocol op to an ASN.1 output stream.

Specified by:

write in class ProtocolOp

Parameters:

stream - The ASN.1 output stream to write to.

Throws:

IOException - If a problem occurs while writing to the stream.

toString

public void toString(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(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.