public interface InternalModifyDnRequest extends SingleReplyRequest, InternalAbandonableRequest
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 | Field and Description |
---|---|
static MessageTypeEnum |
RESP_TYPE
Modify DN response message type enumeration value
|
static MessageTypeEnum |
TYPE
Modify DN request message type enumeration value
|
Modifier and Type | Method and Description |
---|---|
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.
|
void |
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.
|
void |
setName(DN name)
Sets the entry's distinguished name representing the entry PDU
field.
|
void |
setNewRdn(RDN newRdn)
Sets the new relative distinguished name for the entry which represents
the PDU's newrdn field.
|
void |
setNewSuperior(DN newSuperior)
Sets the optional distinguished name of the new superior entry where the
candidate entry is to be moved.
|
getResponseType
getResultResponse
hasResponse
add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove
abandon, addAbandonListener, isAbandoned
static final MessageTypeEnum TYPE
static final MessageTypeEnum RESP_TYPE
DN getName()
void setName(DN name)
name
- the distinguished name of the entry.RDN getNewRdn()
void setNewRdn(RDN newRdn)
newRdn
- the relative dn with one componentboolean getDeleteOldRdn()
void setDeleteOldRdn(boolean deleteOldRdn)
deleteOldRdn
- true if the old rdn is to be deleted, false if it is notDN getNewSuperior()
void setNewSuperior(DN newSuperior)
isMove
method.newSuperior
- the dn of the superior entry the candidate entry for DN
modification is moved under.boolean isMove()
Copyright © 2003–2016 The Apache Software Foundation. All rights reserved.