oracle.oud.requests

Class ModifyRequestWrapper

java.lang.Object

oracle.oud.requests.ModifyRequestWrapper

All Implemented Interfaces:

AttachmentHolder, ModifyRequest, Request

public class ModifyRequestWrapper
extends java.lang.Object
implements ModifyRequest

This class wraps a Modify request.

Constructor Summary

Constructors

Constructor and Description
ModifyRequestWrapper(ModifyRequest request) Creates a new ModifyRequestWrapper that wraps the specified modify request.

Method Summary

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

ModifyRequestWrapper

public ModifyRequestWrapper(ModifyRequest request)

Creates a new ModifyRequestWrapper that wraps the specified modify request.

Parameters:

request - the request to wrap.

Method Detail

addControl

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

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

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

Description copied from interface: ModifyRequest

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

Specified by:

addModification in interface ModifyRequest

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

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

Description copied from interface: ModifyRequest

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.

Specified by:

addModification in interface ModifyRequest

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

public java.util.List<Modification> getModifications()

Description copied from interface: ModifyRequest

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

Specified by:

getModifications in interface ModifyRequest

Returns:

A List containing the modifications.

getName

public DN getName()

Description copied from interface: ModifyRequest

Returns the distinguished name of the entry to be modified.

Specified by:

getName in interface ModifyRequest

Returns:

The distinguished name of the entry to be modified.

setName

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

Description copied from interface: ModifyRequest

Sets the distinguished name of the entry to be modified.

Specified by:

setName in interface ModifyRequest

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

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

Description copied from interface: ModifyRequest

Sets the distinguished name of the entry to be modified.

Specified by:

setName in interface ModifyRequest

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.

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.