|
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 |
public interface CompareRequest
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 | |
---|---|
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 |
---|
CompareRequest addControl(Control control) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
addControl
in interface Request
control
- 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
.ByteString getAssertionValue()
java.lang.String getAssertionValueAsString()
AttributeDescription getAttributeDescription()
DN getName()
CompareRequest setAssertionValue(ByteString value) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
value
- The assertion value to be compared.java.lang.UnsupportedOperationException
- If this compare request does not permit the assertion value to be set.java.lang.NullPointerException
- If value
was null
.CompareRequest setAssertionValue(java.lang.Object value) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
If the assertion value is not an instance of ByteString
then it will be converted using the ByteString.valueOf(Object)
method.
value
- The assertion value to be compared.java.lang.UnsupportedOperationException
- If this compare request does not permit the assertion value to be set.java.lang.NullPointerException
- If value
was null
.CompareRequest setAttributeDescription(AttributeDescription attributeDescription) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
attributeDescription
- The name of the attribute to be compared.java.lang.UnsupportedOperationException
- If this compare request does not permit the attribute description to be set.java.lang.NullPointerException
- If attributeDescription
was null
.CompareRequest setAttributeDescription(java.lang.String attributeDescription) throws PluginException, java.lang.UnsupportedOperationException, java.lang.NullPointerException
attributeDescription
- The name of the attribute to be compared.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
.CompareRequest setName(DN dn) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
dn
- The distinguished name of the entry to be compared.java.lang.UnsupportedOperationException
- If this compare request does not permit the distinguished name to be set.java.lang.NullPointerException
- If dn
was null
.CompareRequest setName(java.lang.String dn) throws PluginException, java.lang.UnsupportedOperationException, java.lang.NullPointerException
dn
- The distinguished name of the entry to be compared.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
.
|
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 |