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

java.lang.Object
  org.apache.directory.shared.ldap.message.AbstractMessage
      org.apache.directory.shared.ldap.message.AbstractRequest
          org.apache.directory.shared.ldap.message.AbstractAbandonableRequest
              org.apache.directory.shared.ldap.message.ModifyRequestImpl

All Implemented Interfaces:

AbandonableRequest, Message, ModifyRequest, Request, ResultResponseRequest, SingleReplyRequest

public class ModifyRequestImpl
extends AbstractAbandonableRequest
implements ModifyRequest

Lockable ModifyRequest implementation.

Version:

$Rev: 493916 $

Author:

Apache Directory Project

Field Summary

Fields inherited from interface org.apache.directory.shared.ldap.message.ModifyRequest

RESP_TYPE, TYPE

Constructor Summary

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

Method Summary

void	addModification(ModificationItemImpl mod) Adds a ModificationItem to the set of modifications composing this modify request.
boolean	equals(java.lang.Object obj) Checks to see if ModifyRequest stub equals another by factoring in checks for the name and modification items of the request.
java.util.Collection	getModificationItems() Gets an immutable Collection of modification items representing the atomic changes to perform on the candidate entry to modify.
LdapDN	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.
ResultResponse	getResultResponse() The result containing response for this request.
void	removeModification(ModificationItemImpl mod) Removes a ModificationItem to the set of modifications composing this modify request.
void	setName(LdapDN name) Sets the distinguished name of the entry to be modified by this request.
java.lang.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.AbstractRequest

hasResponse

Methods inherited from class org.apache.directory.shared.ldap.message.AbstractMessage

add, get, getControls, getMessageId, getType, initControls, put, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.directory.shared.ldap.message.Request

hasResponse

Methods inherited from interface org.apache.directory.shared.ldap.message.Message

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

Methods inherited from interface org.apache.directory.shared.ldap.message.AbandonableRequest

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 java.util.Collection 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 ModifyRequest

Returns:

an immutatble Collection of ModificationItem instances.

See Also:

<{javax.naming.directory.ModificationItem}>

getName

public LdapDN 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 void setName(LdapDN 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.

addModification

public void addModification(ModificationItemImpl mod)

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

Specified by:

addModification in interface ModifyRequest

Parameters:

mod - a ModificationItem to add.

removeModification

public void removeModification(ModificationItemImpl mod)

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

Specified by:

removeModification in interface ModifyRequest

Parameters:

mod - a ModificationItem 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 ResultResponse getResultResponse()

The result containing response for this request.

Specified by:

getResultResponse in interface ResultResponseRequest

Returns:

the result containing response for this request

equals

public boolean equals(java.lang.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 AbstractMessage

Parameters:

obj - the object to compare this ModifyRequest to

Returns:

true if obj equals this ModifyRequest, false otherwise

toString

public java.lang.String toString()

Get a String representation of a ModifyRequest

Overrides:

toString in class java.lang.Object

Returns:

A ModifyRequest String