Skip navigation links

oracle.oud.requests
Interface ModifyRequest

All Superinterfaces:

AttachmentHolder, Request

All Known Implementing Classes:

ModifyRequestWrapper

public interface ModifyRequest

extends Request

The Modify operation allows a client to request that a modification of an entry be performed on its behalf by a server.

Creation of Modify requests is provided by newModifyRequest(DN) and newModifyRequest(String)

Method Summary

ModifyRequest	addControl(Control control) Adds the provided control to this request.
ModifyRequest	addModification(Modification modification) Appends the provided modification to the list of modifications included with this modify request.
ModifyRequest	addModification(ModificationType type, java.lang.String attributeDescription, java.lang.Object... values) Appends the provided modification to the list of modifications included with this modify request.
java.util.List<Modification>	getModifications() Returns a List containing the modifications included with this modify request.
DN	getName() Returns the distinguished name of the entry to be modified.
ModifyRequest	setName(DN dn) Sets the distinguished name of the entry to be modified.
ModifyRequest	setName(java.lang.String dn) Sets the distinguished name of the entry to be modified.

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

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

addModification

ModifyRequest addModification(Modification modification)
                              throws java.lang.UnsupportedOperationException,
                                     java.lang.NullPointerException

Appends the provided modification to the list of modifications included with this modify request.

Parameters:

modification - The modification to be performed.

Returns:

This modify request.

Throws:

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

java.lang.NullPointerException - If modification was null.

addModification

ModifyRequest addModification(ModificationType type,
                              java.lang.String attributeDescription,
                              java.lang.Object... values)
                              throws PluginException,
                                     java.lang.UnsupportedOperationException,
                                     java.lang.NullPointerException

Appends the provided modification to the list of modifications included with this modify request.

If the attribute value is not an instance of ByteString then it will be converted using the ByteString.valueOf(Object) method.

Parameters:

type - The type of modification to be performed.

attributeDescription - The name of the attribute to be modified.

values - The attribute values to be modified.

Returns:

This modify request.

Throws:

PluginException - If attributeDescription could not be decoded.

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

java.lang.NullPointerException - If type, attributeDescription, or value was null.

getModifications

java.util.List<Modification> getModifications()

Returns a List containing the modifications included with this modify request. The returned List may be modified if permitted by this modify request.

Returns:

A List containing the modifications.

getName

DN getName()

Returns the distinguished name of the entry to be modified.

Returns:

The distinguished name of the entry to be modified.

setName

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

Sets the distinguished name of the entry to be modified.

Parameters:

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

Returns:

This modify request.

Throws:

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

java.lang.NullPointerException - If dn was null.

setName

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

Sets the distinguished name of the entry to be modified.

Parameters:

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

Returns:

This modify request.

Throws:

PluginException - If dn could not be decoded.

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

java.lang.NullPointerException - If dn was null.

Skip navigation links