public interface ModifyDnRequest extends Request, ChangeRecord
Request.RequestType
Modifier and Type | Method and Description |
---|---|
ModifyDnRequest |
addControl(Control control)
Adds the provided control to this protocol-op.
|
ModifyDnRequest |
addControls(Iterable<? extends Control> controls)
Adds the provided controls to this protocol-op.
|
<C extends Control> |
getControl(ControlDecoder<C> decoder,
DecodeOptions options)
Decodes and returns the first control in this protocol-op having an OID
corresponding to the provided control decoder.
|
List<Control> |
getControls()
Returns a
List containing the controls included with this
protocol-op. |
Dn |
getName()
Returns the distinguished name of the entry to be renamed.
|
Rdn |
getNewRdn()
Returns the new RDN of the entry to be renamed.
|
Dn |
getNewSuperior()
Returns the distinguished name of an existing entry that will become the
immediate superior (parent) of the entry to be renamed.
|
boolean |
isDeleteOldRdn()
Indicates whether the old RDN attribute values are to be retained as
attributes of the entry or deleted from the entry.
|
ModifyDnRequest |
setDeleteOldRdn(boolean deleteOldRdn)
Specifies whether the old RDN attribute values are to be retained as
attributes of the entry or deleted from the entry.
|
ModifyDnRequest |
setName(Dn dn)
Sets the distinguished name of the entry to be renamed.
|
ModifyDnRequest |
setName(String dn)
Sets the distinguished name of the entry to be renamed.
|
ModifyDnRequest |
setNewRdn(Rdn rdn)
Sets the new RDN of the entry to be renamed.
|
ModifyDnRequest |
setNewRdn(String rdn)
Sets the new RDN of the entry to be renamed.
|
ModifyDnRequest |
setNewSuperior(Dn dn)
Sets the distinguished name of an existing entry that will become the
immediate superior (parent) of the entry to be renamed.
|
ModifyDnRequest |
setNewSuperior(String dn)
Sets the distinguished name of an existing entry that will become the
immediate superior (parent) of the entry to be renamed.
|
containsControl, getControl
ModifyDnRequest addControl(Control control)
ProtocolOp
addControl
in interface ChangeRecord
addControl
in interface ProtocolOp
addControl
in interface Request
control
- The control to be added to this protocol-op.ModifyDnRequest addControls(Iterable<? extends Control> controls)
ProtocolOp
addControls
in interface ChangeRecord
addControls
in interface ProtocolOp
addControls
in interface Request
controls
- The controls to be added to this protocol-op.<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
ProtocolOp
getControl
in interface ProtocolOp
C
- The type of control to be decoded and returned.decoder
- The control decoder.options
- The set of decode options which should be used when decoding
the control.null
if the control is not
included with this protocol-op.DecodeException
- If the control could not be decoded because it was malformed in some way
(e.g. the control value was missing, or its content could not be decoded).List<Control> getControls()
ProtocolOp
List
containing the controls included with this
protocol-op. The returned List
may be modified if permitted by this
protocol-op.getControls
in interface ProtocolOp
List
containing the controls.Dn getName()
getName
in interface ChangeRecord
Rdn getNewRdn()
Dn getNewSuperior()
null
, indicating that the entry is to remain
under the same parent entry.null
if the entry is to remain under the same parent entry.boolean isDeleteOldRdn()
false
.true
if the old RDN attribute values are to be deleted
from the entry, or false
if they are to be retained.ModifyDnRequest setDeleteOldRdn(boolean deleteOldRdn)
false
.deleteOldRdn
- true
if the old RDN attribute values are to be deleted
from the entry, or false
if they are to be retained.UnsupportedOperationException
- If this modify DN request does not permit the delete old RDN
parameter to be set.ModifyDnRequest setName(Dn dn)
setName
in interface ChangeRecord
dn
- The distinguished name of the entry to be renamed.UnsupportedOperationException
- If this modify DN request does not permit the distinguished
name to be set.NullPointerException
- If dn
was null
.ModifyDnRequest setName(String dn)
setName
in interface ChangeRecord
dn
- The distinguished name of the entry to be renamed.LocalizedIllegalArgumentException
- If dn
could not be decoded using the default schema.UnsupportedOperationException
- If this modify DN request does not permit the distinguished
name to be set.NullPointerException
- If dn
was null
.ModifyDnRequest setNewRdn(Rdn rdn)
rdn
- The new RDN of the entry to be renamed.UnsupportedOperationException
- If this modify DN request does not permit the new RDN to be
set.NullPointerException
- If rdn
was null
.ModifyDnRequest setNewRdn(String rdn)
rdn
- The new RDN of the entry to be renamed.LocalizedIllegalArgumentException
- If rdn
could not be decoded using the default schema.UnsupportedOperationException
- If this modify DN request does not permit the new RDN to be
set.NullPointerException
- If rdn
was null
.ModifyDnRequest setNewSuperior(Dn dn)
null
, indicating that the entry is to remain
under the same parent entry.dn
- The distinguished name of an existing entry that will become
the immediate superior (parent) of the entry to be renamed,
may be null
.UnsupportedOperationException
- If this modify DN request does not permit the new superior to
be set.ModifyDnRequest setNewSuperior(String dn)
null
, indicating that the entry is to remain
under the same parent entry.dn
- The distinguished name of an existing entry that will become
the immediate superior (parent) of the entry to be renamed,
may be null
.LocalizedIllegalArgumentException
- If dn
could not be decoded using the default schema.UnsupportedOperationException
- If this modify DN request does not permit the new superior to
be set.Copyright 2010-2022 ForgeRock AS.