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: 764131 $, $Date: 2009-04-11 03:03:00 +0200 (Sam, 11 avr 2009) $,

Author:

Apache Directory Project

Field Summary

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

parent

Constructor Summary

AbandonRequestCodec()
Creates a new AbandonRequest object.

Method Summary

int	computeLength() Compute the AbandonRequest length AbandonRequest : 0x50 0x0(1..4) abandoned MessageId Length(AbandonRequest) = Length(0x50) + 1 + Length(abandoned MessageId)
java.nio.ByteBuffer	encode(java.nio.ByteBuffer buffer) Encode the AbandonRequest message to a PDU.
int	getAbandonedMessageId() Get the abandoned message ID
int	getMessageType() Get the message type
void	setAbandonedMessageId(int abandonedMessageId) Set the abandoned message ID
java.lang.String	toString() Return a String representing an AbandonRequest

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

addControl, getAbandonRequest, getAddRequest, getAddResponse, getBindRequest, getBindResponse, getCompareRequest, getCompareResponse, getControls, getControls, getCurrentControl, getDelRequest, getDelResponse, getExtendedRequest, getExtendedResponse, getIntermediateResponse, getLdapResponse, getMessageId, getMessageTypeName, getModifyDNRequest, getModifyDNResponse, getModifyRequest, getModifyResponse, getSearchRequest, getSearchResultDone, getSearchResultEntry, getSearchResultReference, getUnBindRequest, initControls, setMessageId, setProtocolOP

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

addLength, 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 int getMessageType()

Get the message type

Overrides:

getMessageType in class LdapMessageCodec

Returns:

Returns the type.

setAbandonedMessageId

public void setAbandonedMessageId(int abandonedMessageId)

Set the abandoned message ID

Parameters:

abandonedMessageId - The abandoned messageID to set.

computeLength

public int computeLength()

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

Specified by:

computeLength in interface Asn1Object

Overrides:

computeLength in class LdapMessageCodec

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws EncoderException

Encode the AbandonRequest message to a PDU.

Specified by:

encode in interface Asn1Object

Overrides:

encode in class LdapMessageCodec

Parameters:

buffer - The buffer where to put the PDU

Returns:

The PDU.

Throws:

EncoderException - If anything goes wrong.

toString

public java.lang.String toString()

Return a String representing an AbandonRequest

Overrides:

toString in class LdapMessageCodec

Returns:

A String representing the AbandonRequest