public interface CompareResult extends Result
If the attribute value assertion in the Compare request matched a value of
the attribute or sub-type according to the attribute's equality matching rule
then the result code is set to ResultCode.COMPARE_TRUE and can be
determined by invoking the matched() method.
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 |
|---|---|
CompareResult |
addControl(Control control)
Adds the provided control to this response.
|
CompareResult |
addReferralURI(String uri)
Adds the provided referral URI to this result.
|
Throwable |
getCause()
Returns the throwable cause associated with this result if available.
|
<C extends Control> |
getControl(ControlDecoder<C> decoder,
DecodeOptions options)
Decodes and returns the first control in this response having an OID
corresponding to the provided control decoder.
|
List<Control> |
getControls()
Returns a
List containing the controls included with this
response. |
String |
getDiagnosticMessage()
Returns the diagnostic message associated with this result.
|
String |
getMatchedDN()
Returns the matched DN associated with this result.
|
List<String> |
getReferralURIs()
Returns a
List containing the referral URIs included with this
result. |
ResultCode |
getResultCode()
Returns the result code associated with this result.
|
boolean |
isReferral()
Indicates whether or not a referral needs to be chased in order to
complete the operation.
|
boolean |
isSuccess()
Indicates whether or not the request succeeded or not.
|
boolean |
matched()
Indicates whether or not the attribute value assertion in the Compare
request matched a value of the attribute or sub-type according to the
attribute's equality matching rule.
|
CompareResult |
setCause(Throwable cause)
Sets the throwable cause associated with this result if available.
|
CompareResult |
setDiagnosticMessage(String message)
Sets the diagnostic message associated with this result.
|
CompareResult |
setMatchedDN(String dn)
Sets the matched DN associated with this result.
|
CompareResult |
setResultCode(ResultCode resultCode)
Sets the result code associated with this result.
|
containsControlCompareResult addControl(Control control)
ResponseaddControl in interface ResponseaddControl in interface Resultcontrol - The control to be added.CompareResult addReferralURI(String uri)
ResultaddReferralURI in interface Resulturi - The referral URI to be added.Throwable getCause()
Result<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
ResponsegetControl in interface ResponsegetControl in interface ResultC - 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 response.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()
ResponseList containing the controls included with this
response. The returned List may be modified if permitted by this
response.getControls in interface ResponsegetControls in interface ResultList containing the controls.String getDiagnosticMessage()
ResultgetDiagnosticMessage in interface Resultnull).String getMatchedDN()
ResultgetMatchedDN in interface Resultnull).List<String> getReferralURIs()
ResultList containing the referral URIs included with this
result. The returned List may be modified if permitted by this
result.getReferralURIs in interface ResultList containing the referral URIs.ResultCode getResultCode()
ResultgetResultCode in interface Resultboolean isReferral()
Result
Specifically, this method returns true if the result code is
equal to ResultCode.REFERRAL.
isReferral in interface Resulttrue if a referral needs to be chased, otherwise
false.boolean isSuccess()
Resultboolean matched()
Specifically, this method returns true if the result code is
equal to ResultCode.COMPARE_TRUE.
true if the attribute value assertion matched, otherwise
false.CompareResult setCause(Throwable cause)
ResultCompareResult setDiagnosticMessage(String message)
ResultsetDiagnosticMessage in interface Resultmessage - The diagnostic message, which may be empty or null
indicating that none was provided.CompareResult setMatchedDN(String dn)
ResultsetMatchedDN in interface Resultdn - The matched DN associated, which may be empty or null
indicating that none was provided.CompareResult setResultCode(ResultCode resultCode)
ResultsetResultCode in interface ResultresultCode - The result code.Copyright © 2011-2015 ForgeRock AS. All Rights Reserved.