org.apache.directory.shared.dsmlv2.request
Class AbandonRequestDsml

java.lang.Object
  extended by org.apache.directory.shared.asn1.AbstractAsn1Object
      extended by org.apache.directory.shared.ldap.codec.LdapMessageCodec
          extended by org.apache.directory.shared.dsmlv2.LdapMessageDecorator
              extended by org.apache.directory.shared.dsmlv2.request.LdapRequestDecorator
                  extended by org.apache.directory.shared.dsmlv2.request.AbstractRequestDsml
                      extended by org.apache.directory.shared.dsmlv2.request.AbandonRequestDsml
All Implemented Interfaces:
Asn1Object, DsmlDecorator

public class AbandonRequestDsml
extends AbstractRequestDsml

DSML Decorator for AbandonRequest

Version:
$Rev$, $Date$
Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.dsmlv2.LdapMessageDecorator
instance
 
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
AbandonRequestDsml()
          Creates a new instance of AbandonRequestDsml.
AbandonRequestDsml(AbandonRequestCodec ldapMessage)
          Creates a new instance of AbandonRequestDsml.
 
Method Summary
 int getAbandonedMessageId()
          Get the abandoned message ID
 MessageTypeEnum getMessageType()
          Get the message type
 void setAbandonedMessageId(int abandonedMessageId)
          Set the abandoned message ID
 org.dom4j.Element toDsml(org.dom4j.Element root)
          Creates the Request Element and adds RequestID and Controls.
 
Methods inherited from class org.apache.directory.shared.dsmlv2.LdapMessageDecorator
addControl, addLength, computeLength, computeLengthProtocolOp, encode, encodeProtocolOp, getAbandonRequest, getAddRequest, getAddResponse, getBindRequest, getBindResponse, getCompareRequest, getCompareResponse, getControls, getControls, getCurrentControl, getCurrentLength, getDelRequest, getDelResponse, getExpectedLength, getExtendedRequest, getExtendedResponse, getLdapResponse, getMessageId, getMessageTypeName, getModifyDNRequest, getModifyDNResponse, getModifyRequest, getModifyResponse, getParent, getSearchRequest, getSearchResultDone, getSearchResultEntry, getSearchResultReference, getUnBindRequest, setCurrentLength, setExpectedLength, setMessageId, setParent, toString
 
Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec
addControls, encode, getCodecControl, initControls, toString
 
Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object
getTlvId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AbandonRequestDsml

public AbandonRequestDsml()
Creates a new instance of AbandonRequestDsml.


AbandonRequestDsml

public AbandonRequestDsml(AbandonRequestCodec ldapMessage)
Creates a new instance of AbandonRequestDsml.

Parameters:
ldapMessage - the message to decorate
Method Detail

getMessageType

public MessageTypeEnum getMessageType()
Get the message type

Overrides:
getMessageType in class LdapMessageDecorator
Returns:
The message type

toDsml

public org.dom4j.Element toDsml(org.dom4j.Element root)
Creates the Request Element and adds RequestID and Controls.

Specified by:
toDsml in interface DsmlDecorator
Overrides:
toDsml in class AbstractRequestDsml
Parameters:
root - the root element
Returns:
the Request Element of the given name containing

getAbandonedMessageId

public int getAbandonedMessageId()
Get the abandoned message ID

Returns:
Returns the abandoned MessageId.

setAbandonedMessageId

public void setAbandonedMessageId(int abandonedMessageId)
Set the abandoned message ID

Parameters:
abandonedMessageId - The abandoned messageID to set.


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.