org.apache.directory.api.ldap.model.message
Class ModifyDnRequestImpl

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

All Implemented Interfaces:

AbandonableRequest, Message, ModifyDnRequest, Request, ResultResponseRequest<ModifyDnResponse>, SingleReplyRequest<ModifyDnResponse>

public class ModifyDnRequestImpl
extends AbstractAbandonableRequest
implements ModifyDnRequest

ModifyDNRequest implementation.

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

controls

Fields inherited from interface org.apache.directory.api.ldap.model.message.ModifyDnRequest

RESP_TYPE, TYPE

Constructor Summary

ModifyDnRequestImpl()
Creates a ModifyDnRequest implementing object used to perform a dn change on an entry potentially resulting in an entry move.

Method Summary

ModifyDnRequest	addAllControls(Control[] controls) Adds an array of controls to this Message.
ModifyDnRequest	addControl(Control control) Adds a control to this Message.
boolean	equals(Object obj) Checks to see of an object equals this ModifyDnRequest stub.
boolean	getDeleteOldRdn() Gets the flag which determines if the old Rdn attribute is to be removed from the entry when the new Rdn is used in its stead.
Dn	getName() Gets the entry's distinguished name representing the entry PDU field.
Rdn	getNewRdn() Gets the new relative distinguished name for the entry which represents the PDU's newrdn field.
Dn	getNewSuperior() Gets the optional distinguished name of the new superior entry where the candidate entry is to be moved.
MessageTypeEnum	getResponseType() Gets the protocol response message type for this request which produces at least one response.
ModifyDnResponse	getResultResponse() The result containing response for this request.
int	hashCode()
boolean	isMove() Gets whether or not this request is a Dn change resulting in a move operation.
ModifyDnRequest	removeControl(Control control) Deletes a control removing it from this Message.
ModifyDnRequest	setDeleteOldRdn(boolean deleteOldRdn) Sets the flag which determines if the old Rdn attribute is to be removed from the entry when the new Rdn is used in its stead.
ModifyDnRequest	setMessageId(int messageId) Sets the Message ID for this request
ModifyDnRequest	setName(Dn name) Sets the entry's distinguished name representing the entry PDU field.
ModifyDnRequest	setNewRdn(Rdn newRdn) Sets the new relative distinguished name for the entry which represents the PDU's newrdn field.
ModifyDnRequest	setNewSuperior(Dn newSuperior) Sets the optional distinguished name of the new superior entry where the candidate entry is to be moved.
String	toString() Get a String representation of a ModifyDNRequest

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 class java.lang.Object

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

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

ModifyDnRequestImpl

public ModifyDnRequestImpl()

Creates a ModifyDnRequest implementing object used to perform a dn change on an entry potentially resulting in an entry move.

Method Detail

getDeleteOldRdn

public boolean getDeleteOldRdn()

Gets the flag which determines if the old Rdn attribute is to be removed from the entry when the new Rdn is used in its stead. This property corresponds to the deleteoldrdn.

Specified by:

getDeleteOldRdn in interface ModifyDnRequest

Returns:

true if the old rdn is to be deleted, false if it is not

setDeleteOldRdn

public ModifyDnRequest setDeleteOldRdn(boolean deleteOldRdn)

Sets the flag which determines if the old Rdn attribute is to be removed from the entry when the new Rdn is used in its stead. This property corresponds to the deleteoldrdn.

Specified by:

setDeleteOldRdn in interface ModifyDnRequest

Parameters:

deleteOldRdn - true if the old rdn is to be deleted, false if it is not

Returns:

The ModifyDnRequest instance

isMove

public boolean isMove()

Gets whether or not this request is a Dn change resulting in a move operation. Setting the newSuperior property to a non-null name, toggles this flag.

Specified by:

isMove in interface ModifyDnRequest

Returns:

true if the newSuperior property is NOT null, false otherwise.

getName

public Dn getName()

Gets the entry's distinguished name representing the entry PDU field.

Specified by:

getName in interface ModifyDnRequest

Returns:

the distinguished name of the entry.

setName

public ModifyDnRequest setName(Dn name)

Sets the entry's distinguished name representing the entry PDU field.

Specified by:

setName in interface ModifyDnRequest

Parameters:

name - the distinguished name of the entry.

Returns:

The ModifyDnRequest instance

getNewRdn

public Rdn getNewRdn()

Gets the new relative distinguished name for the entry which represents the PDU's newrdn field.

Specified by:

getNewRdn in interface ModifyDnRequest

Returns:

the relative dn with one component

setNewRdn

public ModifyDnRequest setNewRdn(Rdn newRdn)

Sets the new relative distinguished name for the entry which represents the PDU's newrdn field.

Specified by:

setNewRdn in interface ModifyDnRequest

Parameters:

newRdn - the relative dn with one component

Returns:

The ModifyDnRequest instance

getNewSuperior

public Dn getNewSuperior()

Gets the optional distinguished name of the new superior entry where the candidate entry is to be moved. This property corresponds to the PDU's newSuperior field. May be null representing a simple Rdn change rather than a move operation.

Specified by:

getNewSuperior in interface ModifyDnRequest

Returns:

the dn of the superior entry the candidate entry is moved under.

setNewSuperior

public ModifyDnRequest setNewSuperior(Dn newSuperior)

Sets the optional distinguished name of the new superior entry where the candidate entry is to be moved. This property corresponds to the PDU's newSuperior field. May be null representing a simple Rdn change rather than a move operation. Setting this property to a non-null value toggles the move flag obtained via the isMove method.

Specified by:

setNewSuperior in interface ModifyDnRequest

Parameters:

newSuperior - the dn of the superior entry the candidate entry for Dn modification is moved under.

Returns:

The ModifyDnRequest instance

setMessageId

public ModifyDnRequest setMessageId(int messageId)

Sets the Message ID for this request

Specified by:

setMessageId in interface Message

Specified by:

setMessageId in interface ModifyDnRequest

Overrides:

setMessageId in class AbstractMessage

Parameters:

messageId - The message Id

Returns:

A Message reference

addControl

public ModifyDnRequest addControl(Control control)
                           throws MessageException

Adds a control to this Message.

Specified by:

addControl in interface Message

Specified by:

addControl in interface ModifyDnRequest

Overrides:

addControl in class AbstractMessage

Parameters:

control - the control to add.

Returns:

A Message reference

Throws:

MessageException - if controls cannot be added to this Message or the control is not known etc.

addAllControls

public ModifyDnRequest addAllControls(Control[] controls)
                               throws MessageException

Adds an array of controls to this Message.

Specified by:

addAllControls in interface Message

Specified by:

addAllControls in interface ModifyDnRequest

Overrides:

addAllControls in class AbstractMessage

Parameters:

controls - the controls to add.

Returns:

A Message reference

Throws:

MessageException - if controls cannot be added to this Message or they are not known etc.

removeControl

public ModifyDnRequest removeControl(Control control)
                              throws MessageException

Deletes a control removing it from this Message.

Specified by:

removeControl in interface Message

Specified by:

removeControl in interface ModifyDnRequest

Overrides:

removeControl in class AbstractMessage

Parameters:

control - the control to remove.

Returns:

A Message reference

Throws:

MessageException - if controls cannot be added to this Message or the control is not known etc.

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

Returns:

the message type of the response.

getResultResponse

public ModifyDnResponse getResultResponse()

The result containing response for this request.

Specified by:

getResultResponse in interface ResultResponseRequest<ModifyDnResponse>

Returns:

the result containing response for this request

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractRequest

Returns:

the instance's hash code

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Checks to see of an object equals this ModifyDnRequest stub. The equality presumes all ModifyDnRequest specific properties are the same.

Overrides:

equals in class AbstractRequest

Parameters:

obj - the object to compare with this stub

Returns:

true if the obj is equal to this stub, false otherwise

toString

public String toString()

Get a String representation of a ModifyDNRequest

Overrides:

toString in class Object

Returns:

A ModifyDNRequest String