Skip navigation links

oracle.oud.requests
Class ExtendedRequestWrapper<R extends ExtendedResult>

java.lang.Object
oracle.oud.requests.ExtendedRequestWrapper<R>

Type Parameters:

R - The type of result.

All Implemented Interfaces:

AttachmentHolder, ExtendedRequest<R>, Request

public class ExtendedRequestWrapper<R extends ExtendedResult>

extends java.lang.Object

implements ExtendedRequest<R>

This class wraps an Extended request.

Constructor Summary

ExtendedRequestWrapper(ExtendedRequest<R> request)
Creates a new ExtendedRequestWrapper that wraps the specified extended request.

Method Summary

ExtendedRequest<R>	addControl(Control control) Adds the provided control to this 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.lang.String	getOID() Returns the numeric OID associated with this extended request.
ExtendedResultDecoder<R>	getResultDecoder() Returns a decoder which can be used to decoded responses to this extended request.
ByteString	getValue() Returns the value, if any, associated with this extended request.
boolean	hasValue() Returns true if this extended request has a value.
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.

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

ExtendedRequestWrapper

public ExtendedRequestWrapper(ExtendedRequest<R> request)

Creates a new ExtendedRequestWrapper that wraps the specified extended request.

Parameters:

request - the request to wrap.

Method Detail

addControl

public ExtendedRequest<R> 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 ExtendedRequest<R extends ExtendedResult>

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.

getOID

public java.lang.String getOID()

Description copied from interface: ExtendedRequest

Returns the numeric OID associated with this extended request.

Specified by:

getOID in interface ExtendedRequest<R extends ExtendedResult>

Returns:

The numeric OID associated with this extended request.

getResultDecoder

public ExtendedResultDecoder<R> getResultDecoder()

Description copied from interface: ExtendedRequest

Returns a decoder which can be used to decoded responses to this extended request.

Specified by:

getResultDecoder in interface ExtendedRequest<R extends ExtendedResult>

Returns:

A decoder which can be used to decoded responses to this extended request.

getValue

public ByteString getValue()

Description copied from interface: ExtendedRequest

Returns the value, if any, associated with this extended request. Its format is defined by the specification of this extended request.

Specified by:

getValue in interface ExtendedRequest<R extends ExtendedResult>

Returns:

The value associated with this extended request, or null if there is no value.

hasValue

public boolean hasValue()

Description copied from interface: ExtendedRequest

Returns true if this extended request has a value. In some circumstances it may be useful to determine if a extended request has a value, without actually calculating the value and incurring any performance costs.

Specified by:

hasValue in interface ExtendedRequest<R extends ExtendedResult>

Returns:

true if this extended request has a value, or false if there is no value.

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.

Skip navigation links