public interface ModifyDNRequest extends Request, ChangeRecord
Modifier and Type | Method and Description |
---|---|
<R,P> R |
accept(ChangeRecordVisitor<R,P> v,
P p)
Applies a
ChangeRecordVisitor to this ChangeRecord . |
ModifyDNRequest |
addControl(Control control)
Adds the provided control to this request.
|
<C extends Control> |
getControl(ControlDecoder<C> decoder,
DecodeOptions options)
Decodes and returns the first control in this request having an OID
corresponding to the provided control decoder.
|
List<Control> |
getControls()
Returns a
List containing the controls included with this
request. |
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
<R,P> R accept(ChangeRecordVisitor<R,P> v, P p)
ChangeRecord
ChangeRecordVisitor
to this ChangeRecord
.accept
in interface ChangeRecord
R
- The return type of the visitor's methods.P
- The type of the additional parameters to the visitor's
methods.v
- The change record visitor.p
- Optional additional visitor parameter.ModifyDNRequest addControl(Control control)
Request
addControl
in interface Request
control
- The control to be added to this request.<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
Request
getControl
in interface Request
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 request.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()
Request
List
containing the controls included with this
request. The returned List
may be modified if permitted by this
request.getControls
in interface Request
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)
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)
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-2017 ForgeRock AS.