|
Oracle® Fusion Middleware Java API Reference for Oracle Unified Directory 11g Release 2 (11.1.2.2.0) E38583-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.oud.requests.ModifyDNRequestWrapper
public class ModifyDNRequestWrapper
This class wraps a Modify DN request.
Constructor Summary | |
---|---|
ModifyDNRequestWrapper(ModifyDNRequest request) Creates a new ModifyDNRequestWrapper that wraps the specified modify Dn request. |
Method Summary | ||
---|---|---|
ModifyDNRequest |
addControl(Control control) Adds the provided control to this request. |
|
java.lang.Object |
getAttachment(java.lang.String name) Retrieves the attachment with the specified name. |
|
java.util.Set<java.lang.String> |
getAttachmentNames() Retrieves the set of attachment names defined for this holder, as a mapping between the attachment name and the associated object. |
|
|
getControl(ControlDecoder<C> decoder) Decodes and returns the first control in this request having an OID corresponding to the provided control decoder. |
|
java.util.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. |
|
boolean |
isInternal() Returns true if this request is flagged as internal; false otherwise. |
|
java.lang.Object |
removeAttachment(java.lang.String name) Removes the attachment with the specified name. |
|
Request |
removeControl(Control control) Removes the provided control from this request. |
|
java.lang.Object |
setAttachment(java.lang.String name, java.lang.Object value) Sets the value of the specified attachment. |
|
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(java.lang.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(java.lang.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(java.lang.String dn) Sets the distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface oracle.oud.requests.Request |
---|
getControl, getControls, isInternal, removeControl |
Methods inherited from interface oracle.oud.plugin.AttachmentHolder |
---|
getAttachment, getAttachmentNames, removeAttachment, setAttachment |
Constructor Detail |
---|
public ModifyDNRequestWrapper(ModifyDNRequest request)
request
- the request to wrap.Method Detail |
---|
public ModifyDNRequest addControl(Control control) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
Request
addControl
in interface ModifyDNRequest
addControl
in interface Request
control
- The control to be added to this request.java.lang.UnsupportedOperationException
- If this request does not permit controls to be added.java.lang.NullPointerException
- If control
was null
.public DN getName()
ModifyDNRequest
getName
in interface ModifyDNRequest
public RDN getNewRDN()
ModifyDNRequest
getNewRDN
in interface ModifyDNRequest
public DN getNewSuperior()
ModifyDNRequest
getNewSuperior
in interface ModifyDNRequest
null
if the entry is to remain under the same parent entry.public boolean isDeleteOldRDN()
ModifyDNRequest
isDeleteOldRDN
in interface ModifyDNRequest
true
if the old RDN attribute values are to be deleted from the entry, or false
if they are to be retained.public ModifyDNRequest setDeleteOldRDN(boolean deleteOldRDN) throws java.lang.UnsupportedOperationException
ModifyDNRequest
setDeleteOldRDN
in interface ModifyDNRequest
deleteOldRDN
- true
if the old RDN attribute values are to be deleted from the entry, or false
if they are to be retained.java.lang.UnsupportedOperationException
- If this modify DN request does not permit the delete old RDN parameter to be set.public ModifyDNRequest setName(DN dn) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
ModifyDNRequest
setName
in interface ModifyDNRequest
dn
- The distinguished name of the entry to be renamed.java.lang.UnsupportedOperationException
- If this modify DN request does not permit the distinguished name to be set.java.lang.NullPointerException
- If dn
was null
.public ModifyDNRequest setName(java.lang.String dn) throws PluginException, java.lang.UnsupportedOperationException, java.lang.NullPointerException
ModifyDNRequest
setName
in interface ModifyDNRequest
dn
- The distinguished name of the entry to be renamed.PluginException
- If dn
could not be decoded.java.lang.UnsupportedOperationException
- If this modify DN request does not permit the distinguished name to be set.java.lang.NullPointerException
- If dn
was null
.public ModifyDNRequest setNewRDN(RDN rdn) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
ModifyDNRequest
setNewRDN
in interface ModifyDNRequest
rdn
- The new RDN of the entry to be renamed.java.lang.UnsupportedOperationException
- If this modify DN request does not permit the new RDN to be set.java.lang.NullPointerException
- If rdn
was null
.public ModifyDNRequest setNewRDN(java.lang.String rdn) throws PluginException, java.lang.UnsupportedOperationException, java.lang.NullPointerException
ModifyDNRequest
setNewRDN
in interface ModifyDNRequest
rdn
- The new RDN of the entry to be renamed.PluginException
- If rdn
could not be decoded.java.lang.UnsupportedOperationException
- If this modify DN request does not permit the new RDN to be set.java.lang.NullPointerException
- If rdn
was null
.public ModifyDNRequest setNewSuperior(DN dn) throws java.lang.UnsupportedOperationException
ModifyDNRequest
setNewSuperior
in interface ModifyDNRequest
dn
- The distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed, may be null
.java.lang.UnsupportedOperationException
- If this modify DN request does not permit the new superior to be set.public ModifyDNRequest setNewSuperior(java.lang.String dn) throws PluginException, java.lang.UnsupportedOperationException
ModifyDNRequest
setNewSuperior
in interface ModifyDNRequest
dn
- The distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed, may be null
.PluginException
- If dn
could not be decoded.java.lang.UnsupportedOperationException
- If this modify DN request does not permit the new superior to be set.public <C extends Control> C getControl(ControlDecoder<C> decoder) throws java.lang.NullPointerException, PluginException
Request
getControl
in interface Request
C
- The type of control to be decoded and returned.decoder
- The control decoder.null
if the control is not included with this request.java.lang.NullPointerException
- If decoder
was null
.PluginException
- 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).public java.util.List<Control> getControls()
Request
List
containing the controls included with this request. The returned List
is immutable.getControls
in interface Request
List
containing the controls.public Request removeControl(Control control) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
Request
removeControl
in interface Request
control
- The control to be removed from this request.java.lang.UnsupportedOperationException
- If this request does not permit controls to be removed.java.lang.NullPointerException
- If control
was null
.public java.lang.Object removeAttachment(java.lang.String name)
AttachmentHolder
removeAttachment
in interface AttachmentHolder
name
- The name for the attachment to remove. It will be treated in a case-sensitive manner.null
if it does not exist.public java.lang.Object setAttachment(java.lang.String name, java.lang.Object value)
AttachmentHolder
setAttachment
in interface AttachmentHolder
name
- The name to use for the attachment.value
- The value to use for the attachment.null
if there was previously no such attachment.public java.lang.Object getAttachment(java.lang.String name)
AttachmentHolder
getAttachment
in interface AttachmentHolder
name
- The name for the attachment to retrieve. It will be treated in a case-sensitive manner.null
if it does not exist.public java.util.Set<java.lang.String> getAttachmentNames()
AttachmentHolder
getAttachmentNames
in interface AttachmentHolder
public boolean isInternal()
Request
true
if this request is flagged as internal; false
otherwise.
When a request is flagged internal, various components of the server may behave in a manner that is less restrictive. For example, attributes defined as NO-USER-MODIFICATION are allowed to be added, private backends are accessible, ...
isInternal
in interface Request
true
if this request is flagged as internal; false
otherwise.
|
Oracle® Fusion Middleware Java API Reference for Oracle Unified Directory 11g Release 2 (11.1.2.2.0) E38583-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |