Package com.forgerock.opendj.ldap.extensions

Class PasswordPolicyStateExtendedResult

java.lang.Object

org.forgerock.opendj.ldap.responses.AbstractExtendedResult<PasswordPolicyStateExtendedResult>

com.forgerock.opendj.ldap.extensions.PasswordPolicyStateExtendedResult

All Implemented Interfaces:

ExtendedResult, Response, Result

public final class PasswordPolicyStateExtendedResult
extends AbstractExtendedResult<PasswordPolicyStateExtendedResult>

The password policy state extended result.

Constructor Summary

Constructors

Constructor	Description
PasswordPolicyStateExtendedResult(ResultCode resultCode)	Creates a new password policy state extended result with the provided result code.

Method Summary

Modifier and Type	Method	Description
S	addControl(Control control)	Adds the provided control to this response.
void	addOperation(PasswordPolicyStateOperation operation)
S	addReferralURI(String uri)	Adds the provided referral URI to this result.
boolean	containsControl(String oid)	Returns true if this response contains the specified response control.
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 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.
String	getOID()	Returns the numeric OID, if any, associated with this extended result.
Iterable<PasswordPolicyStateOperation>	getOperations()
List<String>	getReferralURIs()	Returns a List containing the referral URIs included with this result.
ResultCode	getResultCode()	Returns the result code associated with this result.
String	getTargetUser()
ByteString	getValue()	Returns the value, if any, associated with this extended result.
boolean	hasValue()	Returns true if this extended result has a value.
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.
S	setCause(Throwable cause)	Sets the throwable cause associated with this result if available.
S	setDiagnosticMessage(String message)	Sets the diagnostic message associated with this result.
S	setMatchedDN(String dn)	Sets the matched DN associated with this result.
S	setResultCode(ResultCode resultCode)	Sets the result code associated with this result.
void	setTargetUser(String targetUser)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.forgerock.opendj.ldap.responses.ExtendedResult

addControl, addReferralURI, getCause, getControl, getControls, getDiagnosticMessage, getMatchedDN, getReferralURIs, getResultCode, isReferral, isSuccess, setCause, setDiagnosticMessage, setMatchedDN, setResultCode

Methods inherited from interface org.forgerock.opendj.ldap.responses.Response

containsControl

Constructor Detail

PasswordPolicyStateExtendedResult

public PasswordPolicyStateExtendedResult(ResultCode resultCode)

Creates a new password policy state extended result with the provided result code.

Parameters:

resultCode - The result code.

Method Detail

addOperation

public void addOperation(PasswordPolicyStateOperation operation)

getOID

public String getOID()

Description copied from interface: ExtendedResult

Returns the numeric OID, if any, associated with this extended result.

Specified by:

getOID in interface ExtendedResult

Specified by:

getOID in class AbstractExtendedResult<PasswordPolicyStateExtendedResult>

Returns:

The numeric OID associated with this extended result, or null if there is no OID.

getOperations

public Iterable<PasswordPolicyStateOperation> getOperations()

getTargetUser

public String getTargetUser()

getValue

public ByteString getValue()

Description copied from interface: ExtendedResult

Returns the value, if any, associated with this extended result. Its format is defined by the specification of this extended result.

Specified by:

getValue in interface ExtendedResult

Specified by:

getValue in class AbstractExtendedResult<PasswordPolicyStateExtendedResult>

Returns:

The value associated with this extended result, or null if there is no value.

hasValue

public boolean hasValue()

Description copied from interface: ExtendedResult

Returns true if this extended result has a value. In some circumstances it may be useful to determine if a extended result has a value, without actually calculating the value and incurring any performance costs.

Specified by:

hasValue in interface ExtendedResult

Specified by:

hasValue in class AbstractExtendedResult<PasswordPolicyStateExtendedResult>

Returns:

true if this extended result has a value, or false if there is no value.

setTargetUser

public void setTargetUser(String targetUser)

toString

public String toString()

Overrides:

toString in class AbstractExtendedResult<PasswordPolicyStateExtendedResult>

addReferralURI

public final S 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

public final 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.

getDiagnosticMessage

public final String 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).

getMatchedDN

public final 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

public final 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

public final 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

public final 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

public final 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.

setCause

public final S 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

public final S setDiagnosticMessage(String 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

public final S 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.

setResultCode

public final S 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.

addControl

public final S addControl(Control control)

Description copied from interface: Response

Adds the provided control to this response.

Specified by:

addControl in interface Response

Parameters:

control - The control to be added.

Returns:

This response.

containsControl

public boolean containsControl(String oid)

Description copied from interface: Response

Returns true if this response contains the specified response control.

Specified by:

containsControl in interface Response

Parameters:

oid - The numeric OID of the response control.

Returns:

true if this response contains the specified response control.

getControl

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

Description copied from interface: Response

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

Specified by:

getControl in interface Response

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

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

public final List<Control> getControls()

Description copied from interface: Response

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

Specified by:

getControls in interface Response

Returns:

A List containing the controls.