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

java.lang.Object
  extended by org.apache.directory.shared.asn1.Asn1Object
      extended by org.apache.directory.shared.ldap.codec.LdapMessage
          extended by org.apache.directory.shared.ldap.codec.abandon.AbandonRequest

public class AbandonRequest
extends LdapMessage

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

Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.asn1.Asn1Object
parent
 
Constructor Summary
AbandonRequest()
          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)
 ByteBuffer encode(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
 String toString()
          Return a String representing an AbandonRequest
 
Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessage
addControl, getAbandonRequest, getAddRequest, getAddResponse, getBindRequest, getBindResponse, getCompareRequest, getCompareResponse, getControls, getControls, getCurrentControl, getDelRequest, getDelResponse, getExtendedRequest, getExtendedResponse, getLdapResponse, getMessageId, getMessageTypeName, getModifyDNRequest, getModifyDNResponse, getModifyRequest, getModifyResponse, getSearchRequest, getSearchResultDone, getSearchResultEntry, getSearchResultReference, getUnBindRequest, initControls, setMessageId, setProtocolOP
 
Methods inherited from class org.apache.directory.shared.asn1.Asn1Object
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

AbandonRequest

public AbandonRequest()
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 LdapMessage
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)

Overrides:
computeLength in class LdapMessage
Returns:
The object's computed length

encode

public ByteBuffer encode(ByteBuffer buffer)
                  throws EncoderException
Encode the AbandonRequest message to a PDU.

Overrides:
encode in class LdapMessage
Parameters:
buffer - The buffer where to put the PDU
Returns:
The PDU.
Throws:
EncoderException - If anything goes wrong.

toString

public String toString()
Return a String representing an AbandonRequest

Overrides:
toString in class LdapMessage
Returns:
A String representing the AbandonRequest


Copyright © 2004-2012. All Rights Reserved.