oracle.oud.requests

Interface ModifyDNRequest

All Superinterfaces:

AttachmentHolder, Request

All Known Implementing Classes:

ModifyDNRequestWrapper

public interface ModifyDNRequest
extends Request

The Modify DN operation allows a client to change the Relative Distinguished Name (RDN) of an entry in the Directory and/or to move a subtree of entries to a new location in the Directory.

Creation of Modify DN requests is provided by newModifyDNRequest(DN, RDN) and newModifyDNRequest(String, String)

Method Summary

Modifier and Type	Method and Description
ModifyDNRequest	addControl(Control control) Adds the provided control to 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(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 interface oracle.oud.requests.Request

getControl, getControls, isInternal, removeControl

Methods inherited from interface oracle.oud.plugin.AttachmentHolder

getAttachment, getAttachmentNames, removeAttachment, setAttachment

Method Detail

addControl

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

Adds the provided control to this request.

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

DN getName()

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.

Returns:

The distinguished name of the entry.

getNewRDN

RDN getNewRDN()

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.

Returns:

The new RDN of the entry.

getNewSuperior

DN getNewSuperior()

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.

Returns:

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

isDeleteOldRDN

boolean isDeleteOldRDN()

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

Returns:

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

setDeleteOldRDN

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

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

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

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

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

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

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

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

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

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

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.

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

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

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.

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

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

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

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

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

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

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.