org.apache.directory.shared.ldap.codec.abandon

Class AbandonRequestCodec

java.lang.Object

org.apache.directory.shared.asn1.AbstractAsn1Object

org.apache.directory.shared.ldap.codec.LdapMessageCodec

org.apache.directory.shared.ldap.codec.abandon.AbandonRequestCodec

All Implemented Interfaces:

Asn1Object

public class AbandonRequestCodec
extends LdapMessageCodec

A AbandonRequest Message. Its syntax is : AbandonRequest ::= [APPLICATION 16] MessageID MessageID ::= INTEGER (0 .. maxInt) maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) --

Version:

$Rev: 912399 $, $Date: 2010-02-21 21:52:31 +0100(dom, 21 feb 2010) $,

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec

ldapMessageLength

Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

parent

Constructor Summary

Constructors

Constructor and Description
AbandonRequestCodec() Creates a new AbandonRequest object.

Method Summary

Modifier and Type	Method and Description
protected int	computeLengthProtocolOp() Compute the AbandonRequest length AbandonRequest : 0x50 0x0(1..4) abandoned MessageId Length(AbandonRequest) = Length(0x50) + 1 + Length(abandoned MessageId)
protected void	encodeProtocolOp(ByteBuffer buffer) Encode the Abandon protocolOp part
int	getAbandonedMessageId() Get the abandoned message ID
MessageTypeEnum	getMessageType() Get the message type
String	getMessageTypeName() Get the message type Name
void	setAbandonedMessageId(int abandonedMessageId) Set the abandoned message ID
String	toString() Return a String representing an AbandonRequest

Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec

addControl, addControls, computeLength, encode, getCodecControl, getControls, getControls, getCurrentControl, getMessageId, initControls, setMessageId, toString

Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

addLength, encode, getCurrentLength, getExpectedLength, getParent, getTlvId, setCurrentLength, setExpectedLength, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbandonRequestCodec

public AbandonRequestCodec()

Creates a new AbandonRequest object.

Method Detail

getAbandonedMessageId

public int getAbandonedMessageId()

Get the abandoned message ID

Returns:

Returns the abandoned MessageId.

getMessageType

public MessageTypeEnum getMessageType()

Get the message type

Specified by:

getMessageType in class LdapMessageCodec

Returns:

Returns the type.

getMessageTypeName

public String getMessageTypeName()

Get the message type Name

Specified by:

getMessageTypeName in class LdapMessageCodec

Returns:

The message type name

setAbandonedMessageId

public void setAbandonedMessageId(int abandonedMessageId)

Set the abandoned message ID

Parameters:

abandonedMessageId - The abandoned messageID to set.

computeLengthProtocolOp

protected int computeLengthProtocolOp()

Compute the AbandonRequest length AbandonRequest : 0x50 0x0(1..4) abandoned MessageId Length(AbandonRequest) = Length(0x50) + 1 + Length(abandoned MessageId)

Specified by:

computeLengthProtocolOp in class LdapMessageCodec

encodeProtocolOp

protected void encodeProtocolOp(ByteBuffer buffer)
                         throws EncoderException

Encode the Abandon protocolOp part

Specified by:

encodeProtocolOp in class LdapMessageCodec

Throws:

EncoderException

toString

public String toString()

Return a String representing an AbandonRequest

Overrides:

toString in class Object

Returns:

A String representing the AbandonRequest