Class DelRequestDsml
- java.lang.Object
-
- org.apache.directory.api.dsmlv2.AbstractDsmlMessageDecorator<E>
-
- org.apache.directory.api.dsmlv2.request.AbstractRequestDsml<E>
-
- org.apache.directory.api.dsmlv2.request.AbstractResultResponseRequestDsml<DeleteRequest,DeleteResponse>
-
- org.apache.directory.api.dsmlv2.request.DelRequestDsml
-
- All Implemented Interfaces:
DsmlDecorator<DeleteRequest>
,AbandonableRequest
,DeleteRequest
,Message
,Request
,ResultResponseRequest
,SingleReplyRequest
public class DelRequestDsml extends AbstractResultResponseRequestDsml<DeleteRequest,DeleteResponse> implements DeleteRequest
DSML Decorator for DeleteRequest- Author:
- Apache Directory Project
-
-
Constructor Summary
Constructors Constructor Description DelRequestDsml(LdapApiService codec)
Creates a new getDecoratedMessage() of DelRequestDsml.DelRequestDsml(LdapApiService codec, DeleteRequest ldapMessage)
Creates a new getDecoratedMessage() of DelRequestDsml.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DeleteRequest
addAllControls(Control[] controls)
Adds an array of controls to this Message.DeleteRequest
addControl(Control control)
Adds a control to this Message.Dn
getEntry()
Get the entry to be deletedDn
getName()
Gets the distinguished name of the leaf entry to be deleted by this request.MessageTypeEnum
getResponseType()
Gets the protocol response message type for this request which produces at least one response.MessageTypeEnum
getType()
Gets the LDAP message type code associated with this Message.DeleteRequest
removeControl(Control control)
Deletes a control removing it from this Message.void
setEntry(Dn entry)
Set the entry to be deletedDeleteRequest
setMessageId(int messageId)
Sets the Message ID for this requestDeleteRequest
setName(Dn name)
Sets the distinguished name of the leaf entry to be deleted by this request.org.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.AbstractResultResponseRequestDsml
abandon, addAbandonListener, computeLength, encode, getResultResponse, isAbandoned
-
Methods inherited from class org.apache.directory.api.dsmlv2.request.AbstractRequestDsml
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.AbandonableRequest
abandon, addAbandonListener, isAbandoned
-
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
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.ResultResponseRequest
getResultResponse
-
-
-
-
Constructor Detail
-
DelRequestDsml
public DelRequestDsml(LdapApiService codec)
Creates a new getDecoratedMessage() of DelRequestDsml.- Parameters:
codec
- The LDAP Service to use
-
DelRequestDsml
public DelRequestDsml(LdapApiService codec, DeleteRequest ldapMessage)
Creates a new getDecoratedMessage() of DelRequestDsml.- 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<DeleteRequest>
- 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<DeleteRequest>
- Overrides:
toDsml
in classAbstractResultResponseRequestDsml<DeleteRequest,DeleteResponse>
- Parameters:
root
- the root element- Returns:
- the Request Element of the given name containing
-
setEntry
public void setEntry(Dn entry)
Set the entry to be deleted- Parameters:
entry
- The entry to set.
-
getResponseType
public MessageTypeEnum getResponseType()
Gets the protocol response message type for this request which produces at least one response.- Specified by:
getResponseType
in interfaceSingleReplyRequest
- Returns:
- the message type of the response.
-
getName
public Dn getName()
Gets the distinguished name of the leaf entry to be deleted by this request.- Specified by:
getName
in interfaceDeleteRequest
- Returns:
- the Dn of the leaf entry to delete.
-
setName
public DeleteRequest setName(Dn name)
Sets the distinguished name of the leaf entry to be deleted by this request.- Specified by:
setName
in interfaceDeleteRequest
- Parameters:
name
- the Dn of the leaf entry to delete.- Returns:
- The DeleteRequest instance
-
setMessageId
public DeleteRequest setMessageId(int messageId)
Sets the Message ID for this request- Specified by:
setMessageId
in interfaceDeleteRequest
- Specified by:
setMessageId
in interfaceMessage
- Overrides:
setMessageId
in classAbstractDsmlMessageDecorator<DeleteRequest>
- Parameters:
messageId
- The message Id- Returns:
- A Message reference
-
addControl
public DeleteRequest addControl(Control control)
Adds a control to this Message.- Specified by:
addControl
in interfaceDeleteRequest
- Specified by:
addControl
in interfaceMessage
- Overrides:
addControl
in classAbstractDsmlMessageDecorator<DeleteRequest>
- Parameters:
control
- the control to add.- Returns:
- A Message reference
-
addAllControls
public DeleteRequest addAllControls(Control[] controls)
Adds an array of controls to this Message.- Specified by:
addAllControls
in interfaceDeleteRequest
- Specified by:
addAllControls
in interfaceMessage
- Overrides:
addAllControls
in classAbstractDsmlMessageDecorator<DeleteRequest>
- Parameters:
controls
- the controls to add.- Returns:
- A Message reference
-
removeControl
public DeleteRequest removeControl(Control control)
Deletes a control removing it from this Message.- Specified by:
removeControl
in interfaceDeleteRequest
- Specified by:
removeControl
in interfaceMessage
- Overrides:
removeControl
in classAbstractDsmlMessageDecorator<DeleteRequest>
- Parameters:
control
- the control to remove.- Returns:
- A Message reference
-
-