org.apache.directory.shared.ldap.message

Class ModifyRequestImpl

java.lang.Object

org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage

org.apache.directory.shared.ldap.message.internal.InternalAbstractRequest

org.apache.directory.shared.ldap.message.AbstractAbandonableRequest

org.apache.directory.shared.ldap.message.ModifyRequestImpl

All Implemented Interfaces:

InternalAbandonableRequest, InternalMessage, InternalModifyRequest, InternalRequest, InternalResultResponseRequest, SingleReplyRequest

public class ModifyRequestImpl
extends AbstractAbandonableRequest
implements InternalModifyRequest

Lockable ModifyRequest implementation.

Version:

$Rev: 918756 $

Author:

Apache Directory Project

Field Summary

Fields inherited from interface org.apache.directory.shared.ldap.message.internal.InternalModifyRequest

RESP_TYPE, TYPE

Constructor Summary

Constructors

Constructor and Description
ModifyRequestImpl(int id) Creates a Lockable ModifyRequest implementing object used to modify the attributes of an entry.

Method Summary

Modifier and Type	Method and Description
void	addModification(Modification mod) Adds a Modification 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>	getModificationItems() 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.
InternalResultResponse	getResultResponse() The result containing response for this request.
void	removeModification(Modification mod) Removes a Modification to the set of modifications composing this modify request.
void	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.shared.ldap.message.AbstractAbandonableRequest

abandon, addAbandonListener, isAbandoned

Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractRequest

hashCode, hasResponse

Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage

add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalRequest

hasResponse

Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalMessage

add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove

Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalAbandonableRequest

abandon, addAbandonListener, isAbandoned

Constructor Detail

ModifyRequestImpl

public ModifyRequestImpl(int id)

Creates a Lockable ModifyRequest implementing object used to modify the attributes of an entry.

Parameters:

id - the sequential message identifier

Method Detail

getModificationItems

public Collection<Modification> getModificationItems()

Gets an immutable Collection of modification items representing the atomic changes to perform on the candidate entry to modify.

Specified by:

getModificationItems in interface InternalModifyRequest

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

Returns:

the DN of the modified entry.

setName

public void 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 InternalModifyRequest

Parameters:

name - the DN of the modified entry.

addModification

public void addModification(Modification mod)

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

Specified by:

addModification in interface InternalModifyRequest

Parameters:

mod - a Modification to add

removeModification

public void removeModification(Modification mod)

Removes a Modification to the set of modifications composing this modify request.

Specified by:

removeModification in interface InternalModifyRequest

Parameters:

mod - a Modification to remove.

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.

getResultResponse

public InternalResultResponse getResultResponse()

The result containing response for this request.

Specified by:

getResultResponse in interface InternalResultResponseRequest

Returns:

the result containing response for this request

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 class InternalAbstractMessage

Parameters:

obj - the object to compare this ModifyRequest to

Returns:

true if obj equals this ModifyRequest, false otherwise

toString

public String toString()

Get a String representation of a ModifyRequest

Overrides:

toString in class Object

Returns:

A ModifyRequest String