|
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.ModifyRequestWrapper
public class ModifyRequestWrapper
This class wraps a Modify request.
| Constructor Summary | |
|---|---|
ModifyRequestWrapper(ModifyRequest request)Creates a new ModifyRequestWrapper that wraps the specified modify request. |
|
| 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.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. |
|
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 |
|---|
public ModifyRequestWrapper(ModifyRequest request)
request - the request to wrap.| Method Detail |
|---|
public ModifyRequest addControl(Control control)
throws java.lang.UnsupportedOperationException,
java.lang.NullPointerException
RequestaddControl in interface ModifyRequestaddControl in interface Requestcontrol - 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 ModifyRequest addModification(Modification modification)
throws java.lang.UnsupportedOperationException,
java.lang.NullPointerException
ModifyRequestaddModification in interface ModifyRequestmodification - The modification to be performed.java.lang.UnsupportedOperationException - If this modify request does not permit modifications to be added.java.lang.NullPointerException - If modification was null.
public ModifyRequest addModification(ModificationType type,
java.lang.String attributeDescription,
java.lang.Object... values)
throws PluginException,
java.lang.UnsupportedOperationException,
java.lang.NullPointerException
ModifyRequestIf the attribute value is not an instance of ByteString then it will be converted using the ByteString.valueOf(Object) method.
addModification in interface ModifyRequesttype - The type of modification to be performed.attributeDescription - The name of the attribute to be modified.values - The attribute values to be modified.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.public java.util.List<Modification> getModifications()
ModifyRequestList containing the modifications included with this modify request. The returned List may be modified if permitted by this modify request.getModifications in interface ModifyRequestList containing the modifications.public DN getName()
ModifyRequestgetName in interface ModifyRequest
public ModifyRequest setName(DN dn)
throws java.lang.UnsupportedOperationException,
java.lang.NullPointerException
ModifyRequestsetName in interface ModifyRequestdn - The the distinguished name of the entry to be modified.java.lang.UnsupportedOperationException - If this modify request does not permit the distinguished name to be set.java.lang.NullPointerException - If dn was null.
public ModifyRequest setName(java.lang.String dn)
throws PluginException,
java.lang.UnsupportedOperationException,
java.lang.NullPointerException
ModifyRequestsetName in interface ModifyRequestdn - The the distinguished name of the entry to be modified.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.
public <C extends Control> C getControl(ControlDecoder<C> decoder)
throws java.lang.NullPointerException,
PluginException
RequestgetControl in interface RequestC - 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()
RequestList containing the controls included with this request. The returned List is immutable.getControls in interface RequestList containing the controls.
public Request removeControl(Control control)
throws java.lang.UnsupportedOperationException,
java.lang.NullPointerException
RequestremoveControl in interface Requestcontrol - 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)
AttachmentHolderremoveAttachment in interface AttachmentHoldername - 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)
AttachmentHoldersetAttachment in interface AttachmentHoldername - 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)
AttachmentHoldergetAttachment in interface AttachmentHoldername - 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()
AttachmentHoldergetAttachmentNames in interface AttachmentHolderpublic boolean isInternal()
Requesttrue 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 Requesttrue 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 | ||||||||