public interface ModifyDnRequest extends SingleReplyRequest, AbandonableRequest
4.9. Modify Dn Operation The Modify Dn Operation allows a client to change the leftmost (least significant) component of the name of an entry in the directory, or to move a subtree of entries to a new location in the directory. The Modify Dn Request is defined as follows: ModifyDNRequest ::= [APPLICATION 12] SEQUENCE { entry LDAPDN, newrdn RelativeLDAPDN, deleteoldrdn BOOLEAN, newSuperior [0] LDAPDN OPTIONAL } Parameters of the Modify Dn Request are: - entry: the Distinguished Name of the entry to be changed. This entry may or may not have subordinate entries. - newrdn: the Rdn that will form the leftmost component of the new name of the entry. - deleteoldrdn: a boolean parameter that controls whether the old Rdn attribute values are to be retained as attributes of the entry, or deleted from the entry. - newSuperior: if present, this is the Distinguished Name of the entry which becomes the immediate superior of the existing entry.Note that this operation can move an entry and change its Rdn at the same time in fact it might have no choice to comply with name forms.
Modifier and Type | Method and Description |
---|---|
ModifyDnRequest |
addAllControls(Control[] controls)
Adds an array of controls to this Message.
|
ModifyDnRequest |
addControl(Control control)
Adds a control to this Message.
|
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.
|
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.
|
getResponseType
getResultResponse
hasResponse
get, getControl, getControls, getMessageId, getType, hasControl, put
abandon, addAbandonListener, isAbandoned
Dn getName()
ModifyDnRequest setName(Dn name)
name
- the distinguished name of the entry.Rdn getNewRdn()
ModifyDnRequest setNewRdn(Rdn newRdn)
newRdn
- the relative dn with one componentboolean getDeleteOldRdn()
ModifyDnRequest setDeleteOldRdn(boolean deleteOldRdn)
deleteOldRdn
- true if the old rdn is to be deleted, false if it is notDn getNewSuperior()
ModifyDnRequest setNewSuperior(Dn newSuperior)
isMove
method.newSuperior
- the dn of the superior entry the candidate entry for Dn
modification is moved under.boolean isMove()
ModifyDnRequest setMessageId(int messageId)
setMessageId
in interface Message
messageId
- The message IdModifyDnRequest addControl(Control control)
addControl
in interface Message
control
- the control to add.ModifyDnRequest addAllControls(Control[] controls)
addAllControls
in interface Message
controls
- the controls to add.ModifyDnRequest removeControl(Control control)
removeControl
in interface Message
control
- the control to remove.Copyright © 2003–2020 The Apache Software Foundation. All rights reserved.