Interface AddRequest
-
- All Superinterfaces:
AbandonableRequest
,Message
,Request
,ResultResponseRequest
,SingleReplyRequest
- All Known Implementing Classes:
AddRequestDsml
,AddRequestImpl
public interface AddRequest extends SingleReplyRequest, AbandonableRequest
Add protocol operation request used to add a new entry to the DIT.- Author:
- Apache Directory Project
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AddRequest
addAllControls(Control[] controls)
Adds an array of controls to this Message.AddRequest
addControl(Control control)
Adds a control to this Message.Entry
getEntry()
Gets the entry to add.Dn
getEntryDn()
Gets the distinguished name of the entry to add.AddRequest
removeControl(Control control)
Deletes a control removing it from this Message.AddRequest
setEntry(Entry entry)
Sets the Entry to add.AddRequest
setEntryDn(Dn entry)
Sets the distinguished name of the entry to add.AddRequest
setMessageId(int messageId)
Sets the Message ID for this request-
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, getType, 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
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.SingleReplyRequest
getResponseType
-
-
-
-
Method Detail
-
getEntryDn
Dn getEntryDn()
Gets the distinguished name of the entry to add.- Returns:
- the Dn of the added entry.
-
setEntryDn
AddRequest setEntryDn(Dn entry)
Sets the distinguished name of the entry to add.- Parameters:
entry
- the Dn of the added entry.- Returns:
- The AddRequest instance
-
setEntry
AddRequest setEntry(Entry entry)
Sets the Entry to add.- Parameters:
entry
- the added Entry- Returns:
- The AddRequest instance
-
setMessageId
AddRequest setMessageId(int messageId)
Sets the Message ID for this request- Specified by:
setMessageId
in interfaceMessage
- Parameters:
messageId
- The message Id- Returns:
- A Message reference
-
addControl
AddRequest addControl(Control control)
Adds a control to this Message.- Specified by:
addControl
in interfaceMessage
- Parameters:
control
- the control to add.- Returns:
- A Message reference
-
addAllControls
AddRequest addAllControls(Control[] controls)
Adds an array of controls to this Message.- Specified by:
addAllControls
in interfaceMessage
- Parameters:
controls
- the controls to add.- Returns:
- A Message reference
-
removeControl
AddRequest removeControl(Control control)
Deletes a control removing it from this Message.- Specified by:
removeControl
in interfaceMessage
- Parameters:
control
- the control to remove.- Returns:
- A Message reference
-
-