oracle.oud.requests

Interface Request

All Superinterfaces:

AttachmentHolder

All Known Subinterfaces:

AddRequest, BindRequest, CompareRequest, DeleteRequest, ExtendedRequest<R>, ModifyDNRequest, ModifyRequest, SearchRequest

All Known Implementing Classes:

AddRequestWrapper, BindRequestWrapper, CompareRequestWrapper, DeleteRequestWrapper, ExtendedRequestWrapper, ModifyDNRequestWrapper, ModifyRequestWrapper, SearchRequestWrapper

public interface Request
extends AttachmentHolder

The base class of all Requests provides methods for querying and manipulating the set of Controls included with a Request.

Method Summary

Modifier and Type	Method and Description
Request	addControl(Control control) Adds the provided control to this request.
<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.
boolean	isInternal() Returns true if this request is flagged as internal; false otherwise.
Request	removeControl(Control control) Removes the provided control from this request.

Methods inherited from interface oracle.oud.plugin.AttachmentHolder

getAttachment, getAttachmentNames, removeAttachment, setAttachment

Method Detail

addControl

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

Adds the provided control to this 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.

getControl

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

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

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:

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

java.lang.NullPointerException - If decoder was null.

getControls

java.util.List<Control> getControls()

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

Returns:

A List containing the controls.

removeControl

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

Removes the provided control from this 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.

isInternal

boolean isInternal()

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

Returns:

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