Class AbandonRequestDsml
- java.lang.Object
-
- org.apache.directory.api.dsmlv2.AbstractDsmlMessageDecorator<E>
-
- org.apache.directory.api.dsmlv2.request.AbstractRequestDsml<AbandonRequest>
-
- org.apache.directory.api.dsmlv2.request.AbandonRequestDsml
-
- All Implemented Interfaces:
DsmlDecorator<AbandonRequest>
,AbandonRequest
,Message
,Request
public class AbandonRequestDsml extends AbstractRequestDsml<AbandonRequest> implements AbandonRequest
DSML Decorator for AbandonRequest- Author:
- Apache Directory Project
-
-
Constructor Summary
Constructors Constructor Description AbandonRequestDsml(LdapApiService codec)
Creates a new instance of AbandonRequestDsml.AbandonRequestDsml(LdapApiService codec, AbandonRequest ldapMessage)
Creates a new instance of AbandonRequestDsml.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AbandonRequest
addAllControls(Control[] controls)
Adds an array of controls to this Message.AbandonRequest
addControl(Control control)
Adds a control to this Message.int
getAbandoned()
Gets the id of the request operation to terminate.int
getAbandonedMessageId()
Get the abandoned message IDMessageTypeEnum
getType()
Gets the LDAP message type code associated with this Message.AbandonRequest
removeControl(Control control)
Deletes a control removing it from this Message.AbandonRequest
setAbandoned(int requestId)
Sets the id of the request operation to terminate.AbandonRequest
setAbandonedMessageId(int abandonedMessageId)
Set the abandoned message IDAbandonRequest
setMessageId(int messageId)
Sets the Message ID for this requestorg.dom4j.Element
toDsml(org.dom4j.Element root)
Creates the Request Element and adds RequestID and Controls.-
Methods inherited from class org.apache.directory.api.dsmlv2.request.AbstractRequestDsml
computeLength, encode, hasResponse
-
Methods inherited from class org.apache.directory.api.dsmlv2.AbstractDsmlMessageDecorator
get, getCodecService, getControl, getControls, getCurrentControl, getDecorated, getMessageId, hasControl, put
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Message
get, getControl, getControls, getMessageId, hasControl, put
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Request
hasResponse
-
-
-
-
Constructor Detail
-
AbandonRequestDsml
public AbandonRequestDsml(LdapApiService codec)
Creates a new instance of AbandonRequestDsml.- Parameters:
codec
- The LDAP Service to use
-
AbandonRequestDsml
public AbandonRequestDsml(LdapApiService codec, AbandonRequest ldapMessage)
Creates a new instance of AbandonRequestDsml.- Parameters:
codec
- The LDAP Service to useldapMessage
- the message to decorate
-
-
Method Detail
-
getType
public MessageTypeEnum getType()
Gets the LDAP message type code associated with this Message. Each request and response type has a unique message type code defined by the protocol in RFC 2251.- Specified by:
getType
in interfaceMessage
- Overrides:
getType
in classAbstractDsmlMessageDecorator<AbandonRequest>
- Returns:
- the message type code.
-
toDsml
public org.dom4j.Element toDsml(org.dom4j.Element root)
Creates the Request Element and adds RequestID and Controls.- Specified by:
toDsml
in interfaceDsmlDecorator<AbandonRequest>
- Overrides:
toDsml
in classAbstractRequestDsml<AbandonRequest>
- 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 AbandonRequest setAbandonedMessageId(int abandonedMessageId)
Set the abandoned message ID- Parameters:
abandonedMessageId
- The abandoned messageID to set.- Returns:
- The modified AbandonRequest instance
-
getAbandoned
public int getAbandoned()
Gets the id of the request operation to terminate.- Specified by:
getAbandoned
in interfaceAbandonRequest
- Returns:
- the id of the request message to abandon
-
setAbandoned
public AbandonRequest setAbandoned(int requestId)
Sets the id of the request operation to terminate.- Specified by:
setAbandoned
in interfaceAbandonRequest
- Parameters:
requestId
- the sequence id of the request message to abandon- Returns:
- The AbandonRequest instance
-
setMessageId
public AbandonRequest setMessageId(int messageId)
Sets the Message ID for this request- Specified by:
setMessageId
in interfaceMessage
- Overrides:
setMessageId
in classAbstractDsmlMessageDecorator<AbandonRequest>
- Parameters:
messageId
- The message Id- Returns:
- A Message reference
-
addControl
public AbandonRequest addControl(Control control)
Adds a control to this Message.- Specified by:
addControl
in interfaceMessage
- Overrides:
addControl
in classAbstractDsmlMessageDecorator<AbandonRequest>
- Parameters:
control
- the control to add.- Returns:
- A Message reference
-
addAllControls
public AbandonRequest addAllControls(Control[] controls)
Adds an array of controls to this Message.- Specified by:
addAllControls
in interfaceMessage
- Overrides:
addAllControls
in classAbstractDsmlMessageDecorator<AbandonRequest>
- Parameters:
controls
- the controls to add.- Returns:
- A Message reference
-
removeControl
public AbandonRequest removeControl(Control control)
Deletes a control removing it from this Message.- Specified by:
removeControl
in interfaceMessage
- Overrides:
removeControl
in classAbstractDsmlMessageDecorator<AbandonRequest>
- Parameters:
control
- the control to remove.- Returns:
- A Message reference
-
-