oracle.oud.requests

Interface CompareRequest

All Superinterfaces:

AttachmentHolder, Request

All Known Implementing Classes:

CompareRequestWrapper

public interface CompareRequest
extends Request

The Compare operation allows a client to compare an assertion value with the values of a particular attribute in a particular entry in the Directory.

Note that some directory systems may establish access controls that permit the values of certain attributes (such as userPassword ) to be compared but not interrogated by other means.

Creation of Compare requests is provided by newCompareRequest(DN, AttributeDescription, ByteString) and newCompareRequest(String, String, Object)

Method Summary

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.
AttributeDescription	getAttributeDescription() Returns the name of the attribute to be compared.
DN	getName() Returns the distinguished name of the entry to be compared.
CompareRequest	setAssertionValue(ByteString value) Sets the assertion value to be compared.
CompareRequest	setAssertionValue(java.lang.Object value) Sets the assertion value to be compared.
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 interface oracle.oud.requests.Request

getControl, getControls, isInternal, removeControl

Methods inherited from interface oracle.oud.plugin.AttachmentHolder

getAttachment, getAttachmentNames, removeAttachment, setAttachment

Method Detail

addControl

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

Adds the provided control to this request.

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

ByteString getAssertionValue()

Returns the assertion value to be compared.

Returns:

The assertion value.

getAssertionValueAsString

java.lang.String getAssertionValueAsString()

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

Returns:

The assertion value decoded as a UTF-8 string.

getAttributeDescription

AttributeDescription getAttributeDescription()

Returns the name of the attribute to be compared.

Returns:

The name of the attribute.

getName

DN getName()

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

Returns:

The distinguished name of the entry.

setAssertionValue

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

Sets the assertion value to be compared.

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

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

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.

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

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

Sets the name of the attribute to be compared.

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

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

Sets the name of the attribute to be compared.

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

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

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

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

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

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

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.