oracle.oud.requests

Class CompareRequestWrapper

java.lang.Object

oracle.oud.requests.CompareRequestWrapper

All Implemented Interfaces:

AttachmentHolder, CompareRequest, Request

public class CompareRequestWrapper
extends java.lang.Object
implements CompareRequest

This class wraps a Compare request.

Constructor Summary

Constructors

Constructor and Description
CompareRequestWrapper(CompareRequest request) Creates a new CompareRequestWrapper that wraps the specified compare request.

Method Summary

Methods

Modifier and Type	Method and Description
CompareRequest	addControl(Control control) Adds the provided control to this request.
ByteString	getAssertionValue() Returns the assertion value to be compared.
java.lang.String	getAssertionValueAsString() Returns the assertion value to be compared decoded as a UTF-8 string.
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.
AttributeDescription	getAttributeDescription() Returns the name of the attribute to be compared.
<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.
DN	getName() Returns the distinguished name of the entry to be compared.
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.
CompareRequest	setAssertionValue(ByteString value) Sets the assertion value to be compared.
CompareRequest	setAssertionValue(java.lang.Object value) Sets the assertion value to be compared.
java.lang.Object	setAttachment(java.lang.String name, java.lang.Object value) Sets the value of the specified attachment.
CompareRequest	setAttributeDescription(AttributeDescription attributeDescription) Sets the name of the attribute to be compared.
CompareRequest	setAttributeDescription(java.lang.String attributeDescription) Sets the name of the attribute to be compared.
CompareRequest	setName(DN dn) Sets the distinguished name of the entry to be compared.
CompareRequest	setName(java.lang.String dn) Sets the distinguished name of the entry to be compared.

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

CompareRequestWrapper

public CompareRequestWrapper(CompareRequest request)

Creates a new CompareRequestWrapper that wraps the specified compare request.

Parameters:

request - the request to wrap.

Method Detail

addControl

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

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.

getAssertionValue

public ByteString getAssertionValue()

Description copied from interface: CompareRequest

Returns the assertion value to be compared.

Specified by:

getAssertionValue in interface CompareRequest

Returns:

The assertion value.

getAssertionValueAsString

public java.lang.String getAssertionValueAsString()

Description copied from interface: CompareRequest

Returns the assertion value to be compared decoded as a UTF-8 string.

Specified by:

getAssertionValueAsString in interface CompareRequest

Returns:

The assertion value decoded as a UTF-8 string.

getAttributeDescription

public AttributeDescription getAttributeDescription()

Description copied from interface: CompareRequest

Returns the name of the attribute to be compared.

Specified by:

getAttributeDescription in interface CompareRequest

Returns:

The name of the attribute.

getName

public DN getName()

Description copied from interface: CompareRequest

Returns the distinguished name of the entry to be compared. The server shall not dereference any aliases in locating the entry to be compared.

Specified by:

getName in interface CompareRequest

Returns:

The distinguished name of the entry.

setAssertionValue

public CompareRequest setAssertionValue(ByteString value)
                                 throws java.lang.UnsupportedOperationException,
                                        java.lang.NullPointerException

Description copied from interface: CompareRequest

Sets the assertion value to be compared.

Specified by:

setAssertionValue in interface CompareRequest

Parameters:

value - The assertion value to be compared.

Returns:

This compare request.

Throws:

java.lang.UnsupportedOperationException - If this compare request does not permit the assertion value to be set.

java.lang.NullPointerException - If value was null.

setAssertionValue

public CompareRequest setAssertionValue(java.lang.Object value)
                                 throws java.lang.UnsupportedOperationException,
                                        java.lang.NullPointerException

Description copied from interface: CompareRequest

Sets the assertion value to be compared.

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

Specified by:

setAssertionValue in interface CompareRequest

Parameters:

value - The assertion value to be compared.

Returns:

This compare request.

Throws:

java.lang.UnsupportedOperationException - If this compare request does not permit the assertion value to be set.

java.lang.NullPointerException - If value was null.

setAttributeDescription

public CompareRequest setAttributeDescription(AttributeDescription attributeDescription)
                                       throws java.lang.UnsupportedOperationException,
                                              java.lang.NullPointerException

Description copied from interface: CompareRequest

Sets the name of the attribute to be compared.

Specified by:

setAttributeDescription in interface CompareRequest

Parameters:

attributeDescription - The name of the attribute to be compared.

Returns:

This compare request.

Throws:

java.lang.UnsupportedOperationException - If this compare request does not permit the attribute description to be set.

java.lang.NullPointerException - If attributeDescription was null.

setAttributeDescription

public CompareRequest setAttributeDescription(java.lang.String attributeDescription)
                                       throws PluginException,
                                              java.lang.UnsupportedOperationException,
                                              java.lang.NullPointerException

Description copied from interface: CompareRequest

Sets the name of the attribute to be compared.

Specified by:

setAttributeDescription in interface CompareRequest

Parameters:

attributeDescription - The name of the attribute to be compared.

Returns:

This compare request.

Throws:

PluginException - If attributeDescription could not be decoded.

java.lang.UnsupportedOperationException - If this compare request does not permit the attribute description to be set.

java.lang.NullPointerException - If attributeDescription was null.

setName

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

Description copied from interface: CompareRequest

Sets the distinguished name of the entry to be compared. The server shall not dereference any aliases in locating the entry to be compared.

Specified by:

setName in interface CompareRequest

Parameters:

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

Returns:

This compare request.

Throws:

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

java.lang.NullPointerException - If dn was null.

setName

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

Description copied from interface: CompareRequest

Sets the distinguished name of the entry to be compared. The server shall not dereference any aliases in locating the entry to be compared.

Specified by:

setName in interface CompareRequest

Parameters:

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

Returns:

This compare request.

Throws:

PluginException - If dn could not be decoded.

java.lang.UnsupportedOperationException - If this compare 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.