Class ModifyRequestImpl
- java.lang.Object
-
- org.apache.directory.api.ldap.model.message.AbstractMessage
-
- org.apache.directory.api.ldap.model.message.AbstractRequest
-
- org.apache.directory.api.ldap.model.message.AbstractAbandonableRequest
-
- org.apache.directory.api.ldap.model.message.ModifyRequestImpl
-
- All Implemented Interfaces:
AbandonableRequest
,Message
,ModifyRequest
,Request
,ResultResponseRequest
,SingleReplyRequest
public class ModifyRequestImpl extends AbstractAbandonableRequest implements ModifyRequest
Lockable ModifyRequest implementation.- Author:
- Apache Directory Project
-
-
Constructor Summary
Constructors Constructor Description ModifyRequestImpl()
Creates a ModifyRequest implementing object used to modify the attributes of an entry.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ModifyRequest
add(String attributeName, byte[]... attributeValue)
ModifyRequest
add(String attributeName, String... attributeValue)
marks a given attribute for addition in the target entry with the given values.ModifyRequest
add(Attribute attr)
marks a given attribute for addition in the target entry.ModifyRequest
addAllControls(Control[] controls)
Adds an array of controls to this Message.ModifyRequest
addControl(Control control)
Adds a control to this Message.ModifyRequest
addModification(Attribute attr, ModificationOperation modOp)
Add a modificationModifyRequest
addModification(Modification mod)
Adds a ModificationItem to the set of modifications composing this modify request.boolean
equals(Object obj)
Checks to see if ModifyRequest stub equals another by factoring in checks for the name and modification items of the request.Collection<Modification>
getModifications()
Gets an immutable Collection of modification items representing the atomic changes to perform on the candidate entry to modify.Dn
getName()
Gets the distinguished name of the entry to be modified by this request.MessageTypeEnum
getResponseType()
Gets the protocol response message type for this request which produces at least one response.ModifyResponse
getResultResponse()
The result containing response for this request.int
hashCode()
ModifyRequest
increment(String attributeName)
marks a given attribute for increment by 1 in the target entry.ModifyRequest
increment(String attributeName, int increment)
marks a given attribute for increment in the target entry.ModifyRequest
increment(Attribute attr)
marks a given attribute for increment by 1 in the target entry.ModifyRequest
increment(Attribute attr, int increment)
marks a given attribute for increment in the target entry.ModifyRequest
remove(String attributeName)
marks a given attribute name for removal from the target entry.ModifyRequest
remove(String attributeName, byte[]... attributeValue)
ModifyRequest
remove(String attributeName, String... attributeValue)
marks a given attribute for removal with the given values from the target entry.ModifyRequest
remove(Attribute attr)
marks a given attribute for removal from the target entry.ModifyRequest
removeControl(Control control)
Deletes a control removing it from this Message.ModifyRequest
removeModification(Modification mod)
Removes a ModificationItem to the set of modifications composing this modify request.ModifyRequest
replace(String attributeName)
ModifyRequest
replace(String attributeName, byte[]... attributeValue)
ModifyRequest
replace(String attributeName, String... attributeValue)
marks a given attribute for replacement with the given values in the target entry.ModifyRequest
replace(Attribute attr)
marks a given attribute for replacement in the target entry.ModifyRequest
setMessageId(int messageId)
Sets the Message ID for this requestModifyRequest
setName(Dn name)
Sets the distinguished name of the entry to be modified by this request.String
toString()
Get a String representation of a ModifyRequest-
Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractAbandonableRequest
abandon, addAbandonListener, isAbandoned
-
Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractRequest
hasResponse
-
Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage
get, getControl, getControls, getMessageId, getType, hasControl, put, toString
-
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
-
-
-
-
Constructor Detail
-
ModifyRequestImpl
public ModifyRequestImpl()
Creates a ModifyRequest implementing object used to modify the attributes of an entry.
-
-
Method Detail
-
getModifications
public Collection<Modification> getModifications()
Gets an immutable Collection of modification items representing the atomic changes to perform on the candidate entry to modify.- Specified by:
getModifications
in interfaceModifyRequest
- Returns:
- an immutable Collection of Modification instances.
-
getName
public Dn getName()
Gets the distinguished name of the entry to be modified by this request. This property represents the PDU's object field.- Specified by:
getName
in interfaceModifyRequest
- Returns:
- the Dn of the modified entry.
-
setName
public ModifyRequest setName(Dn name)
Sets the distinguished name of the entry to be modified by this request. This property represents the PDU's object field.- Specified by:
setName
in interfaceModifyRequest
- Parameters:
name
- the Dn of the modified entry.- Returns:
- The ModifyRequest instance
-
addModification
public ModifyRequest addModification(Modification mod)
Adds a ModificationItem to the set of modifications composing this modify request.- Specified by:
addModification
in interfaceModifyRequest
- Parameters:
mod
- a Modification to add.- Returns:
- The ModifyRequest instance
-
addModification
public ModifyRequest addModification(Attribute attr, ModificationOperation modOp)
Add a modification- Specified by:
addModification
in interfaceModifyRequest
- Parameters:
attr
- The attribute to be modifiedmodOp
- The operation- Returns:
- The ModifyRequest instance
-
add
public ModifyRequest add(String attributeName, String... attributeValue)
marks a given attribute for addition in the target entry with the given values.- Specified by:
add
in interfaceModifyRequest
- Parameters:
attributeName
- name of the attribute to be addedattributeValue
- values of the attribute- Returns:
- The ModifyRequest instance
-
add
public ModifyRequest add(String attributeName, byte[]... attributeValue)
- Specified by:
add
in interfaceModifyRequest
- Parameters:
attributeName
- name of the attribute to be addedattributeValue
- values of the attribute- Returns:
- The ModifyRequest instance
- See Also:
add(String, String...)
-
add
public ModifyRequest add(Attribute attr)
marks a given attribute for addition in the target entry.- Specified by:
add
in interfaceModifyRequest
- Parameters:
attr
- the attribute to be added- Returns:
- The ModifyRequest instance
-
replace
public ModifyRequest replace(String attributeName)
- Specified by:
replace
in interfaceModifyRequest
- Parameters:
attributeName
- name of the attribute to be added- Returns:
- The ModifyRequest instance
- See Also:
replace(String, String...)
-
replace
public ModifyRequest replace(String attributeName, String... attributeValue)
marks a given attribute for replacement with the given values in the target entry.- Specified by:
replace
in interfaceModifyRequest
- Parameters:
attributeName
- name of the attribute to be addedattributeValue
- values of the attribute- Returns:
- The ModifyRequest instance
-
replace
public ModifyRequest replace(String attributeName, byte[]... attributeValue)
- Specified by:
replace
in interfaceModifyRequest
- Parameters:
attributeName
- name of the attribute to be addedattributeValue
- values of the attribute- Returns:
- The ModifyRequest instance
- See Also:
replace(String, String...)
-
replace
public ModifyRequest replace(Attribute attr)
marks a given attribute for replacement in the target entry.- Specified by:
replace
in interfaceModifyRequest
- Parameters:
attr
- the attribute to be added- Returns:
- The ModifyRequest instance
-
removeModification
public ModifyRequest removeModification(Modification mod)
Removes a ModificationItem to the set of modifications composing this modify request.- Specified by:
removeModification
in interfaceModifyRequest
- Parameters:
mod
- a Modification to remove.- Returns:
- The ModifyRequest instance
-
remove
public ModifyRequest remove(String attributeName, String... attributeValue)
marks a given attribute for removal with the given values from the target entry.- Specified by:
remove
in interfaceModifyRequest
- Parameters:
attributeName
- name of the attribute to be removedattributeValue
- values of the attribute- Returns:
- The ModifyRequest instance
-
remove
public ModifyRequest remove(String attributeName, byte[]... attributeValue)
- Specified by:
remove
in interfaceModifyRequest
- Parameters:
attributeName
- name of the attribute to be addedattributeValue
- values of the attribute- Returns:
- The ModifyRequest instance
- See Also:
ModifyRequest.remove(String, String...)
-
remove
public ModifyRequest remove(Attribute attr)
marks a given attribute for removal from the target entry.- Specified by:
remove
in interfaceModifyRequest
- Parameters:
attr
- the attribute to be removed- Returns:
- The ModifyRequest instance
-
remove
public ModifyRequest remove(String attributeName)
marks a given attribute name for removal from the target entry.- Specified by:
remove
in interfaceModifyRequest
- Parameters:
attributeName
- the attribute to be removed- Returns:
- The ModifyRequest instance
-
increment
public ModifyRequest increment(String attributeName)
marks a given attribute for increment by 1 in the target entry.- Specified by:
increment
in interfaceModifyRequest
- Parameters:
attributeName
- the attribute to be incremented- Returns:
- The ModifyRequest instance
-
increment
public ModifyRequest increment(String attributeName, int increment)
marks a given attribute for increment in the target entry.- Specified by:
increment
in interfaceModifyRequest
- Parameters:
attributeName
- the attribute to be incrementedincrement
- The increment value (>=1)- Returns:
- The ModifyRequest instance
-
increment
public ModifyRequest increment(Attribute attr)
marks a given attribute for increment by 1 in the target entry.- Specified by:
increment
in interfaceModifyRequest
- Parameters:
attr
- the attribute to be incremented- Returns:
- The ModifyRequest instance
-
increment
public ModifyRequest increment(Attribute attr, int increment)
marks a given attribute for increment in the target entry.- Specified by:
increment
in interfaceModifyRequest
- Parameters:
attr
- the attribute to be incrementedincrement
- The increment value (>=1)- Returns:
- The ModifyRequest instance
-
setMessageId
public ModifyRequest setMessageId(int messageId)
Sets the Message ID for this request- Specified by:
setMessageId
in interfaceMessage
- Specified by:
setMessageId
in interfaceModifyRequest
- Overrides:
setMessageId
in classAbstractMessage
- Parameters:
messageId
- The message Id- Returns:
- A Message reference
-
addControl
public ModifyRequest addControl(Control control)
Adds a control to this Message.- Specified by:
addControl
in interfaceMessage
- Specified by:
addControl
in interfaceModifyRequest
- Overrides:
addControl
in classAbstractMessage
- Parameters:
control
- the control to add.- Returns:
- A Message reference
-
addAllControls
public ModifyRequest addAllControls(Control[] controls)
Adds an array of controls to this Message.- Specified by:
addAllControls
in interfaceMessage
- Specified by:
addAllControls
in interfaceModifyRequest
- Overrides:
addAllControls
in classAbstractMessage
- Parameters:
controls
- the controls to add.- Returns:
- A Message reference
-
removeControl
public ModifyRequest removeControl(Control control)
Deletes a control removing it from this Message.- Specified by:
removeControl
in interfaceMessage
- Specified by:
removeControl
in interfaceModifyRequest
- Overrides:
removeControl
in classAbstractMessage
- Parameters:
control
- the control to remove.- Returns:
- A Message reference
-
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.
-
getResultResponse
public ModifyResponse getResultResponse()
The result containing response for this request.- Specified by:
getResultResponse
in interfaceResultResponseRequest
- Returns:
- the result containing response for this request
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classAbstractRequest
- Returns:
- the instance's hash code
- See Also:
Object.hashCode()
-
equals
public boolean equals(Object obj)
Checks to see if ModifyRequest stub equals another by factoring in checks for the name and modification items of the request.- Overrides:
equals
in classAbstractRequest
- Parameters:
obj
- the object to compare this ModifyRequest to- Returns:
- true if obj equals this ModifyRequest, false otherwise
-
-