public interface CompareRequest extends Request
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.
The following excerpt shows how to use the Compare operation to check whether a member belongs to a (possibly large) static group.
Connection connection = ...;
String groupDN = ...;
String memberDN = ...;
CompareRequest request =
Requests.newCompareRequest(groupDN, "member", memberDN);
CompareResult result = connection.compare(request);
if (result.matched()) {
// The member belongs to the group.
}
| 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.
|
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.
|
<C extends Control> |
getControl(ControlDecoder<C> decoder,
DecodeOptions options)
Decodes and returns the first control in this request having an OID
corresponding to the provided control decoder.
|
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.
|
CompareRequest |
setAssertionValue(Object value)
Sets the assertion value to be compared.
|
CompareRequest |
setAttributeDescription(AttributeDescription attributeDescription)
Sets the name of the attribute to be compared.
|
CompareRequest |
setAttributeDescription(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(String dn)
Sets the distinguished name of the entry to be compared.
|
containsControlCompareRequest addControl(Control control)
RequestaddControl in interface Requestcontrol - The control to be added to this request.ByteString getAssertionValue()
String getAssertionValueAsString()
AttributeDescription getAttributeDescription()
<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
RequestgetControl in interface RequestC - The type of control to be decoded and returned.decoder - The control decoder.options - The set of decode options which should be used when decoding
the control.null if the control is not
included with this request.DecodeException - 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).List<Control> getControls()
RequestList containing the controls included with this
request. The returned List may be modified if permitted by this
request.getControls in interface RequestList containing the controls.DN getName()
CompareRequest setAssertionValue(Object value)
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.UnsupportedOperationException - If this compare request does not permit the assertion value
to be set.NullPointerException - If value was null.CompareRequest setAttributeDescription(AttributeDescription attributeDescription)
attributeDescription - The name of the attribute to be compared.UnsupportedOperationException - If this compare request does not permit the attribute
description to be set.NullPointerException - If attributeDescription was null.CompareRequest setAttributeDescription(String attributeDescription)
attributeDescription - The name of the attribute to be compared.LocalizedIllegalArgumentException - If attributeDescription could not be decoded using
the default schema.UnsupportedOperationException - If this compare request does not permit the attribute
description to be set.NullPointerException - If attributeDescription was null.CompareRequest setName(DN dn)
dn - The distinguished name of the entry to be compared.UnsupportedOperationException - If this compare request does not permit the distinguished
name to be set.NullPointerException - If dn was null.CompareRequest setName(String dn)
dn - The distinguished name of the entry to be compared.LocalizedIllegalArgumentException - If dn could not be decoded using the default schema.UnsupportedOperationException - If this compare request does not permit the distinguished
name to be set.NullPointerException - If dn was null.Copyright © 2011-2015 ForgeRock AS. All Rights Reserved.