com.unboundid.ldap.protocol

Class AbandonRequestProtocolOp

java.lang.Object

com.unboundid.ldap.protocol.AbandonRequestProtocolOp

All Implemented Interfaces:

ProtocolOp, java.io.Serializable

@InternalUseOnly
@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class AbandonRequestProtocolOp
extends java.lang.Object
implements ProtocolOp

This class provides an implementation of an LDAP abandon request protocol op.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbandonRequestProtocolOp(int idToAbandon) Creates a new abandon request protocol op with the provided information.

Method Summary

Methods

Modifier and Type	Method and Description
static AbandonRequestProtocolOp	decodeProtocolOp(ASN1Element element) Decodes the provided ASN.1 element as an abandon request protocol op.
ASN1Element	encodeProtocolOp() Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.
int	getIDToAbandon() Retrieves the message ID of the operation to abandon.
byte	getProtocolOpType() Retrieves the BER type for this 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.

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 with the provided information.

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.

getProtocolOpType

public byte getProtocolOpType()

Retrieves the BER type for this protocol op.

Specified by:

getProtocolOpType in interface ProtocolOp

Returns:

The BER type for this protocol op.

encodeProtocolOp

@NotNull
public ASN1Element encodeProtocolOp()

Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.

Specified by:

encodeProtocolOp in interface ProtocolOp

Returns:

The ASN.1 element containing the encoded protocol op.

decodeProtocolOp

@NotNull
public static AbandonRequestProtocolOp decodeProtocolOp(@NotNull
                                                ASN1Element element)
                                                 throws LDAPException

Decodes the provided ASN.1 element as an abandon request protocol op.

Parameters:

element - The ASN.1 element to be decoded.

Returns:

The decoded abandon request protocol op.

Throws:

LDAPException - If the provided ASN.1 element cannot be decoded as an abandon request protocol op.

writeTo

public void writeTo(@NotNull
           ASN1Buffer buffer)

Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer. This method is intended for internal use only and should not be used by third-party code.

Specified by:

writeTo in interface ProtocolOp

Parameters:

buffer - The ASN.1 buffer to which the encoded representation should be written.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this protocol op.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this protocol op.

toString

public void toString(@NotNull
            java.lang.StringBuilder buffer)

Appends a string representation of this LDAP protocol op to the provided buffer.

Specified by:

toString in interface ProtocolOp

Parameters:

buffer - The buffer to which the string representation should be appended.