oracle.oud.requests

Class ModifyDNRequestWrapper

java.lang.Object

oracle.oud.requests.ModifyDNRequestWrapper

All Implemented Interfaces:

AttachmentHolder, ModifyDNRequest, Request

public class ModifyDNRequestWrapper
extends java.lang.Object
implements ModifyDNRequest

This class wraps a Modify DN request.

Constructor Summary

Constructors

Constructor and Description
ModifyDNRequestWrapper(ModifyDNRequest request) Creates a new ModifyDNRequestWrapper that wraps the specified modify Dn request.

Method Summary

Methods

Modifier and Type	Method and Description
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.
<C extends Control> C	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

ModifyDNRequestWrapper

public ModifyDNRequestWrapper(ModifyDNRequest request)

Creates a new ModifyDNRequestWrapper that wraps the specified modify Dn request.

Parameters:

request - the request to wrap.

Method Detail

addControl

public ModifyDNRequest addControl(Control control)
                           throws java.lang.UnsupportedOperationException,
                                  java.lang.NullPointerException

Description copied from interface: Request

Adds the provided control to this request.

Specified by:

addControl in interface ModifyDNRequest

Specified by:

addControl in interface Request

Parameters:

control - The control to be added to this request.

Returns:

This request.

Throws:

java.lang.UnsupportedOperationException - If this request does not permit controls to be added.

java.lang.NullPointerException - If control was null.

getName

public DN getName()

Description copied from interface: ModifyDNRequest

Returns the distinguished name of the entry to be renamed. This entry may or may not have subordinate entries. The server shall not dereference any aliases in locating the entry to be renamed.

Specified by:

getName in interface ModifyDNRequest

Returns:

The distinguished name of the entry.

getNewRDN

public RDN getNewRDN()

Description copied from interface: ModifyDNRequest

Returns the new RDN of the entry to be renamed. The value of the old RDN is supplied when moving the entry to a new superior without changing its RDN. Attribute values of the new RDN not matching any attribute value of the entry are added to the entry, and an appropriate error is returned if this fails.

Specified by:

getNewRDN in interface ModifyDNRequest

Returns:

The new RDN of the entry.

getNewSuperior

public DN getNewSuperior()

Description copied from interface: ModifyDNRequest

Returns the distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed. The server shall not dereference any aliases in locating the new superior entry.

Specified by:

getNewSuperior in interface ModifyDNRequest

Returns:

The distinguished name of the new superior entry, or null if the entry is to remain under the same parent entry.

isDeleteOldRDN

public boolean isDeleteOldRDN()

Description copied from interface: ModifyDNRequest

Indicates whether the old RDN attribute values are to be retained as attributes of the entry or deleted from the entry.

Specified by:

isDeleteOldRDN in interface ModifyDNRequest

Returns:

true if the old RDN attribute values are to be deleted from the entry, or false if they are to be retained.

setDeleteOldRDN

public ModifyDNRequest setDeleteOldRDN(boolean deleteOldRDN)
                                throws java.lang.UnsupportedOperationException

Description copied from interface: ModifyDNRequest

Specifies whether the old RDN attribute values are to be retained as attributes of the entry or deleted from the entry.

Specified by:

setDeleteOldRDN in interface ModifyDNRequest

Parameters:

deleteOldRDN - true if the old RDN attribute values are to be deleted from the entry, or false if they are to be retained.

Returns:

This modify DN request.

Throws:

java.lang.UnsupportedOperationException - If this modify DN request does not permit the delete old RDN parameter to be set.

setName

public ModifyDNRequest setName(DN dn)
                        throws java.lang.UnsupportedOperationException,
                               java.lang.NullPointerException

Description copied from interface: ModifyDNRequest

Sets the distinguished name of the entry to be renamed. This entry may or may not have subordinate entries.

Specified by:

setName in interface ModifyDNRequest

Parameters:

dn - The distinguished name of the entry to be renamed.

Returns:

This modify DN request.

Throws:

java.lang.UnsupportedOperationException - If this modify DN request does not permit the distinguished name to be set.

java.lang.NullPointerException - If dn was null.

setName

public ModifyDNRequest setName(java.lang.String dn)
                        throws PluginException,
                               java.lang.UnsupportedOperationException,
                               java.lang.NullPointerException

Description copied from interface: ModifyDNRequest

Sets the distinguished name of the entry to be renamed. This entry may or may not have subordinate entries.

Specified by:

setName in interface ModifyDNRequest

Parameters:

dn - The distinguished name of the entry to be renamed.

Returns:

This modify DN request.

Throws:

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.

setNewRDN

public ModifyDNRequest setNewRDN(RDN rdn)
                          throws java.lang.UnsupportedOperationException,
                                 java.lang.NullPointerException

Description copied from interface: ModifyDNRequest

Sets the new RDN of the entry to be renamed. The value of the old RDN is supplied when moving the entry to a new superior without changing its RDN. Attribute values of the new RDN not matching any attribute value of the entry are added to the entry, and an appropriate error is returned if this fails.

Specified by:

setNewRDN in interface ModifyDNRequest

Parameters:

rdn - The new RDN of the entry to be renamed.

Returns:

This modify DN request.

Throws:

java.lang.UnsupportedOperationException - If this modify DN request does not permit the new RDN to be set.

java.lang.NullPointerException - If rdn was null.

setNewRDN

public ModifyDNRequest setNewRDN(java.lang.String rdn)
                          throws PluginException,
                                 java.lang.UnsupportedOperationException,
                                 java.lang.NullPointerException

Description copied from interface: ModifyDNRequest

Sets the new RDN of the entry to be renamed. The value of the old RDN is supplied when moving the entry to a new superior without changing its RDN. Attribute values of the new RDN not matching any attribute value of the entry are added to the entry, and an appropriate error is returned if this fails.

Specified by:

setNewRDN in interface ModifyDNRequest

Parameters:

rdn - The new RDN of the entry to be renamed.

Returns:

This modify DN request.

Throws:

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.

setNewSuperior

public ModifyDNRequest setNewSuperior(DN dn)
                               throws java.lang.UnsupportedOperationException

Description copied from interface: ModifyDNRequest

Sets the distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed.

Specified by:

setNewSuperior in interface ModifyDNRequest

Parameters:

dn - The distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed, may be null.

Returns:

This modify DN request.

Throws:

java.lang.UnsupportedOperationException - If this modify DN request does not permit the new superior to be set.

setNewSuperior

public ModifyDNRequest setNewSuperior(java.lang.String dn)
                               throws PluginException,
                                      java.lang.UnsupportedOperationException

Description copied from interface: ModifyDNRequest

Sets the distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed.

Specified by:

setNewSuperior in interface ModifyDNRequest

Parameters:

dn - The distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed, may be null.

Returns:

This modify DN request.

Throws:

PluginException - If dn could not be decoded.

java.lang.UnsupportedOperationException - If this modify DN request does not permit the new superior to be set.

getControl

public <C extends Control> C getControl(ControlDecoder<C> decoder)
                             throws java.lang.NullPointerException,
                                    PluginException

Description copied from interface: Request

Decodes and returns the first control in this request having an OID corresponding to the provided control decoder.

Specified by:

getControl in interface Request

Type Parameters:

C - The type of control to be decoded and returned.

Parameters:

decoder - The control decoder.

Returns:

The decoded control, or null if the control is not included with this request.

Throws:

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).

getControls

public java.util.List<Control> getControls()

Description copied from interface: Request

Returns a List containing the controls included with this request. The returned List is immutable.

Specified by:

getControls in interface Request

Returns:

A List containing the controls.

removeControl

public Request removeControl(Control control)
                      throws java.lang.UnsupportedOperationException,
                             java.lang.NullPointerException

Description copied from interface: Request

Removes the provided control from this request.

Specified by:

removeControl in interface Request

Parameters:

control - The control to be removed from this request.

Returns:

This request.

Throws:

java.lang.UnsupportedOperationException - If this request does not permit controls to be removed.

java.lang.NullPointerException - If control was null.

removeAttachment

public java.lang.Object removeAttachment(java.lang.String name)

Description copied from interface: AttachmentHolder

Removes the attachment with the specified name.

Specified by:

removeAttachment in interface AttachmentHolder

Parameters:

name - The name for the attachment to remove. It will be treated in a case-sensitive manner.

Returns:

The attachment that was removed, or null if it does not exist.

setAttachment

public java.lang.Object setAttachment(java.lang.String name,
                             java.lang.Object value)

Description copied from interface: AttachmentHolder

Sets the value of the specified attachment. If an attachment already exists with the same name, it will be replaced. Otherwise, a new attachment will be added.

Specified by:

setAttachment in interface AttachmentHolder

Parameters:

name - The name to use for the attachment.

value - The value to use for the attachment.

Returns:

The former value held by the attachment with the given name, or null if there was previously no such attachment.

getAttachment

public java.lang.Object getAttachment(java.lang.String name)

Description copied from interface: AttachmentHolder

Retrieves the attachment with the specified name.

Specified by:

getAttachment in interface AttachmentHolder

Parameters:

name - The name for the attachment to retrieve. It will be treated in a case-sensitive manner.

Returns:

The requested attachment object, or null if it does not exist.

getAttachmentNames

public java.util.Set<java.lang.String> getAttachmentNames()

Description copied from interface: AttachmentHolder

Retrieves the set of attachment names defined for this holder, as a mapping between the attachment name and the associated object.

Specified by:

getAttachmentNames in interface AttachmentHolder

Returns:

The set of attachments defined for this request.

isInternal

public boolean isInternal()

Description copied from interface: Request

Returns 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, ...

Specified by:

isInternal in interface Request

Returns:

true if this request is flagged as internal; false otherwise.