org.forgerock.opendj.ldap.messages

Interface CompareResult

All Superinterfaces:

ProtocolOp, Response, Result

public interface CompareResult
extends Result

An Compare result indicates the final status of an Compare operation.

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.
 }
 

Method Summary

Modifier and Type	Method and Description
CompareResult	addControl(Control control) Adds the provided control to this protocol-op.
CompareResult	addControls(Iterable<? extends Control> controls) Adds the provided controls to this protocol-op.
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> C	getControl(ControlDecoder<C> decoder, DecodeOptions options) Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder.
List<Control>	getControls() Returns a List containing the controls included with this protocol-op.
LocalizableMessage	getDiagnosticMessage() Returns the diagnostic message associated with this result.
String	getDiagnosticMessageAsString() Returns the diagnostic message associated with this result as a string.
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 a referral needs to be chased in order to complete the operation.
boolean	isSuccess() Indicates whether the request succeeded or not.
boolean	matched() Indicates whether 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(CharSequence message) Sets the diagnostic message associated with this result.
CompareResult	setMatchedDn(Dn dn) Sets the matched DN 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.

Methods inherited from interface org.forgerock.opendj.ldap.messages.Result

copyFrom

Methods inherited from interface org.forgerock.opendj.ldap.messages.ProtocolOp

containsControl, getControl

Method Detail

addControl

CompareResult addControl(Control control)

Description copied from interface: ProtocolOp

Adds the provided control to this protocol-op.

Specified by:

addControl in interface ProtocolOp

Specified by:

addControl in interface Response

Specified by:

addControl in interface Result

Parameters:

control - The control to be added to this protocol-op.

Returns:

This protocol-op.

addControls

CompareResult addControls(Iterable<? extends Control> controls)

Description copied from interface: ProtocolOp

Adds the provided controls to this protocol-op.

Specified by:

addControls in interface ProtocolOp

Specified by:

addControls in interface Response

Specified by:

addControls in interface Result

Parameters:

controls - The controls to be added to this protocol-op.

Returns:

This protocol-op.

addReferralUri

CompareResult addReferralUri(String uri)

Description copied from interface: Result

Adds the provided referral URI to this result.

Specified by:

addReferralUri in interface Result

Parameters:

uri - The referral URI to be added.

Returns:

This result.

getCause

Throwable getCause()

Description copied from interface: Result

Returns the throwable cause associated with this result if available. A cause may be provided in cases where a result indicates a failure due to a client-side error.

Specified by:

getCause in interface Result

Returns:

The throwable cause, or null if none was provided.

getControl

<C extends Control> C getControl(ControlDecoder<C> decoder,
                                 DecodeOptions options)
                          throws DecodeException

Description copied from interface: ProtocolOp

Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder.

Specified by:

getControl in interface ProtocolOp

Specified by:

getControl in interface Result

Type Parameters:

C - The type of control to be decoded and returned.

Parameters:

decoder - The control decoder.

options - The set of decode options which should be used when decoding the control.

Returns:

The decoded control, or null if the control is not included with this protocol-op.

Throws:

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).

getControls

List<Control> getControls()

Description copied from interface: ProtocolOp

Returns a List containing the controls included with this protocol-op. The returned List may be modified if permitted by this protocol-op.

Specified by:

getControls in interface ProtocolOp

Specified by:

getControls in interface Result

Returns:

A List containing the controls.

getDiagnosticMessage

LocalizableMessage getDiagnosticMessage()

Description copied from interface: Result

Returns the diagnostic message associated with this result.

Specified by:

getDiagnosticMessage in interface Result

Returns:

The diagnostic message, which may be empty if none was provided (never null).

getDiagnosticMessageAsString

String getDiagnosticMessageAsString()

Description copied from interface: Result

Returns the diagnostic message associated with this result as a string.

Specified by:

getDiagnosticMessageAsString in interface Result

Returns:

The diagnostic message, which may be empty if none was provided (never null).

getMatchedDn

String getMatchedDn()

Description copied from interface: Result

Returns the matched DN associated with this result.

Specified by:

getMatchedDn in interface Result

Returns:

The matched DN, which may be empty if none was provided (never null).

getReferralUris

List<String> getReferralUris()

Description copied from interface: Result

Returns a List containing the referral URIs included with this result. The returned List may be modified if permitted by this result.

Specified by:

getReferralUris in interface Result

Returns:

A List containing the referral URIs.

getResultCode

ResultCode getResultCode()

Description copied from interface: Result

Returns the result code associated with this result.

Specified by:

getResultCode in interface Result

Returns:

The result code.

isReferral

boolean isReferral()

Description copied from interface: Result

Indicates whether a referral needs to be chased in order to complete the operation.

Specifically, this method returns true if the result code is equal to ResultCode.REFERRAL.

Specified by:

isReferral in interface Result

Returns:

true if a referral needs to be chased, otherwise false.

isSuccess

boolean isSuccess()

Description copied from interface: Result

Indicates whether the request succeeded or not. This method will return {code true} for all non-error responses.

Specified by:

isSuccess in interface Result

Returns:

true if the request succeeded, otherwise false.

matched

boolean matched()

Indicates whether 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.

Specifically, this method returns true if the result code is equal to ResultCode.COMPARE_TRUE.

Returns:

true if the attribute value assertion matched, otherwise false.

setCause

CompareResult setCause(Throwable cause)

Description copied from interface: Result

Sets the throwable cause associated with this result if available. A cause may be provided in cases where a result indicates a failure due to a client-side error.

Specified by:

setCause in interface Result

Parameters:

cause - The throwable cause, which may be null indicating that none was provided.

Returns:

This result.

setDiagnosticMessage

CompareResult setDiagnosticMessage(CharSequence message)

Description copied from interface: Result

Sets the diagnostic message associated with this result.

Specified by:

setDiagnosticMessage in interface Result

Parameters:

message - The diagnostic message, which may be empty or null indicating that none was provided.

Returns:

This result.

setMatchedDn

CompareResult setMatchedDn(String dn)

Description copied from interface: Result

Sets the matched DN associated with this result.

Specified by:

setMatchedDn in interface Result

Parameters:

dn - The matched DN associated, which may be empty or null indicating that none was provided.

Returns:

This result.

setMatchedDn

CompareResult setMatchedDn(Dn dn)

Description copied from interface: Result

Sets the matched DN associated with this result.

Specified by:

setMatchedDn in interface Result

Parameters:

dn - The matched DN associated, which may be empty or null indicating that none was provided.

Returns:

This result.

setResultCode

CompareResult setResultCode(ResultCode resultCode)

Description copied from interface: Result

Sets the result code associated with this result.

Specified by:

setResultCode in interface Result

Parameters:

resultCode - The result code.

Returns:

This result.