org.apache.directory.api.dsmlv2.request

Class ModifyRequestDsml

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<ModifyRequest,ModifyResponse>

org.apache.directory.api.dsmlv2.request.ModifyRequestDsml

All Implemented Interfaces:

DsmlDecorator<ModifyRequest>, AbandonableRequest, Message, ModifyRequest, Request, ResultResponseRequest, SingleReplyRequest

public class ModifyRequestDsml
extends AbstractResultResponseRequestDsml<ModifyRequest,ModifyResponse>
implements ModifyRequest

DSML Decorator for ModifyRequest

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
ModifyRequestDsml(LdapApiService codec) Creates a new getDecoratedMessage() of ModifyRequestDsml.
ModifyRequestDsml(LdapApiService codec, ModifyRequest ldapMessage) Creates a new getDecoratedMessage() of ModifyRequestDsml.

Method Summary

Modifier and Type	Method and Description
ModifyRequest	add(Attribute attr) marks a given attribute for addition in the target entry.
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	addAllControls(Control[] controls) Adds an array of controls to this Message.
void	addAttributeTypeAndValues(String type) Add a new attributeTypeAndValue
void	addAttributeValue(byte[] value) Add a new value to the current attribute
void	addAttributeValue(String value) Add a new value to the current attribute
ModifyRequest	addControl(Control control) Adds a control to this Message.
ModifyRequest	addModification(Attribute attr, ModificationOperation modOp) Add a modification
ModifyRequest	addModification(Modification mod) Adds a ModificationItem to the set of modifications composing this modify request.
String	getCurrentAttributeType()
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.
ModifyRequest	increment(Attribute attributeName) marks a given attribute for increment by 1 in the target entry.
ModifyRequest	increment(Attribute attributeName, int increment) marks a given attribute for increment in the target entry.
ModifyRequest	increment(String attr) marks a given attribute for increment by 1 in the target entry.
ModifyRequest	increment(String attr, int increment) marks a given attribute for increment in the target entry.
ModifyRequest	remove(Attribute attr) marks a given attribute for removal from 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	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(Attribute attr) marks a given attribute for replacement in the target entry.
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.
void	setCurrentOperation(int currentOperation) Store the current operation
ModifyRequest	setMessageId(int messageId) Sets the Message ID for this request
ModifyRequest	setName(Dn name) Sets the distinguished name of the entry to be modified 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, getType, 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.ResultResponseRequest

getResultResponse

Methods inherited from interface org.apache.directory.api.ldap.model.message.Request

hasResponse

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.AbandonableRequest

abandon, addAbandonListener, isAbandoned

Constructor Detail

ModifyRequestDsml

public ModifyRequestDsml(LdapApiService codec)

Creates a new getDecoratedMessage() of ModifyRequestDsml.

Parameters:

codec - The LDAP Service to use

ModifyRequestDsml

public ModifyRequestDsml(LdapApiService codec,
                         ModifyRequest ldapMessage)

Creates a new getDecoratedMessage() of ModifyRequestDsml.

Parameters:

codec - The LDAP Service to use

ldapMessage - the message to decorate

Method Detail

getCurrentAttributeType

public String getCurrentAttributeType()

Returns:

the current attribute's type

setCurrentOperation

public void setCurrentOperation(int currentOperation)

Store the current operation

Parameters:

currentOperation - The currentOperation to set.

addAttributeTypeAndValues

public void addAttributeTypeAndValues(String type)

Add a new attributeTypeAndValue

Parameters:

type - The attribute's name

addAttributeValue

public void addAttributeValue(byte[] value)
                       throws LdapException

Add a new value to the current attribute

Parameters:

value - The value to add

Throws:

LdapException - If we can't add a value

addAttributeValue

public void addAttributeValue(String value)
                       throws LdapException

Add a new value to the current attribute

Parameters:

value - The value to add

Throws:

LdapException - If we can't add a value

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<ModifyRequest>

Overrides:

toDsml in class AbstractResultResponseRequestDsml<ModifyRequest,ModifyResponse>

Parameters:

root - the root element

Returns:

the Request Element of the given name containing

getResponseType

public MessageTypeEnum getResponseType()

Gets the protocol response message type for this request which produces at least one response.

Specified by:

getResponseType in interface SingleReplyRequest

Returns:

the message type of the response.

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 interface ModifyRequest

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 interface ModifyRequest

Parameters:

name - the Dn of the modified entry.

Returns:

The ModifyRequest instance

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 interface ModifyRequest

Returns:

an immutable Collection of Modification instances.

addModification

public ModifyRequest addModification(Modification mod)

Adds a ModificationItem to the set of modifications composing this modify request.

Specified by:

addModification in interface ModifyRequest

Parameters:

mod - a Modification to add.

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 interface ModifyRequest

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 interface ModifyRequest

Parameters:

attributeName - name of the attribute to be removed

attributeValue - values of the attribute

Returns:

The ModifyRequest instance

remove

public ModifyRequest remove(String attributeName,
                            byte[]... attributeValue)

Specified by:

remove in interface ModifyRequest

Parameters:

attributeName - name of the attribute to be added

attributeValue - 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 interface ModifyRequest

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 interface ModifyRequest

Parameters:

attributeName - the attribute to be removed

Returns:

The ModifyRequest instance

addModification

public ModifyRequest addModification(Attribute attr,
                                     ModificationOperation modOp)

Add a modification

Specified by:

addModification in interface ModifyRequest

Parameters:

attr - The attribute to be modified

modOp - 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 interface ModifyRequest

Parameters:

attributeName - name of the attribute to be added

attributeValue - values of the attribute

Returns:

The ModifyRequest instance

add

public ModifyRequest add(String attributeName,
                         byte[]... attributeValue)

Specified by:

add in interface ModifyRequest

Parameters:

attributeName - name of the attribute to be added

attributeValue - values of the attribute

Returns:

The ModifyRequest instance

See Also:

ModifyRequest.add(String, String...)

add

public ModifyRequest add(Attribute attr)

marks a given attribute for addition in the target entry.

Specified by:

add in interface ModifyRequest

Parameters:

attr - the attribute to be added

Returns:

The ModifyRequest instance

replace

public ModifyRequest replace(String attributeName)

Specified by:

replace in interface ModifyRequest

Parameters:

attributeName - name of the attribute to be added

Returns:

The ModifyRequest instance

See Also:

ModifyRequest.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 interface ModifyRequest

Parameters:

attributeName - name of the attribute to be added

attributeValue - values of the attribute

Returns:

The ModifyRequest instance

replace

public ModifyRequest replace(String attributeName,
                             byte[]... attributeValue)

Specified by:

replace in interface ModifyRequest

Parameters:

attributeName - name of the attribute to be added

attributeValue - values of the attribute

Returns:

The ModifyRequest instance

See Also:

ModifyRequest.replace(String, String...)

replace

public ModifyRequest replace(Attribute attr)

marks a given attribute for replacement in the target entry.

Specified by:

replace in interface ModifyRequest

Parameters:

attr - the attribute to be added

Returns:

The ModifyRequest instance

increment

public ModifyRequest increment(Attribute attributeName)

marks a given attribute for increment by 1 in the target entry.

Specified by:

increment in interface ModifyRequest

Parameters:

attributeName - the attribute to be incremented

Returns:

The ModifyRequest instance

increment

public ModifyRequest increment(Attribute attributeName,
                               int increment)

marks a given attribute for increment in the target entry.

Specified by:

increment in interface ModifyRequest

Parameters:

attributeName - the attribute to be incremented

increment - The increment value (>=1)

Returns:

The ModifyRequest instance

increment

public ModifyRequest increment(String attr)

marks a given attribute for increment by 1 in the target entry.

Specified by:

increment in interface ModifyRequest

Parameters:

attr - the attribute to be incremented

Returns:

The ModifyRequest instance

increment

public ModifyRequest increment(String attr,
                               int increment)

marks a given attribute for increment in the target entry.

Specified by:

increment in interface ModifyRequest

Parameters:

attr - the attribute to be incremented

increment - 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 interface Message

Specified by:

setMessageId in interface ModifyRequest

Overrides:

setMessageId in class AbstractDsmlMessageDecorator<ModifyRequest>

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 interface Message

Specified by:

addControl in interface ModifyRequest

Overrides:

addControl in class AbstractDsmlMessageDecorator<ModifyRequest>

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 interface Message

Specified by:

addAllControls in interface ModifyRequest

Overrides:

addAllControls in class AbstractDsmlMessageDecorator<ModifyRequest>

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 interface Message

Specified by:

removeControl in interface ModifyRequest

Overrides:

removeControl in class AbstractDsmlMessageDecorator<ModifyRequest>

Parameters:

control - the control to remove.

Returns:

A Message reference