S - The type of Extended result.public abstract class AbstractExtendedResult<S extends ExtendedResult> extends Object implements ExtendedResult
| Modifier | Constructor and Description |
|---|---|
protected |
AbstractExtendedResult(ExtendedResult extendedResult)
Creates a new extended result that is an exact copy of the provided
result.
|
protected |
AbstractExtendedResult(ResultCode resultCode)
Creates a new extended result using the provided result code.
|
| Modifier and Type | Method and Description |
|---|---|
S |
addControl(Control control)
Adds the provided control to this response.
|
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> |
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.
|
abstract String |
getOID()
Returns the numeric OID, if any, associated with this extended 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.
|
abstract ByteString |
getValue()
Returns the value, if any, associated with this extended result.
|
abstract boolean |
hasValue()
Returns
true if this extended result has a value. |
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.
|
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.
|
String |
toString() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaddControl, addReferralURI, getCause, getControl, getControls, getDiagnosticMessage, getMatchedDN, getReferralURIs, getResultCode, isReferral, isSuccess, setCause, setDiagnosticMessage, setMatchedDN, setResultCodecontainsControlprotected AbstractExtendedResult(ExtendedResult extendedResult)
extendedResult - The extended result to be copied.NullPointerException - If extendedResult was null .protected AbstractExtendedResult(ResultCode resultCode)
resultCode - The result code.NullPointerException - If resultCode was null.public abstract String getOID()
ExtendedResultgetOID in interface ExtendedResultnull if there is no OID.public abstract ByteString getValue()
ExtendedResultgetValue in interface ExtendedResultnull
if there is no value.public abstract boolean hasValue()
ExtendedResulttrue 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.hasValue in interface ExtendedResulttrue if this extended result has a value, or
false if there is no value.public final S addReferralURI(String uri)
ResultaddReferralURI in interface Resulturi - The referral URI to be added.public final Throwable getCause()
Resultpublic final String getDiagnosticMessage()
ResultgetDiagnosticMessage in interface Resultnull).public final String getMatchedDN()
ResultgetMatchedDN in interface Resultnull).public final 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.public final ResultCode getResultCode()
ResultgetResultCode in interface Resultpublic final boolean 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.public final boolean isSuccess()
Resultpublic final S setCause(Throwable cause)
Resultpublic final S setDiagnosticMessage(String message)
ResultsetDiagnosticMessage in interface Resultmessage - The diagnostic message, which may be empty or null
indicating that none was provided.public final S setMatchedDN(String dn)
ResultsetMatchedDN in interface Resultdn - The matched DN associated, which may be empty or null
indicating that none was provided.public final S setResultCode(ResultCode resultCode)
ResultsetResultCode in interface ResultresultCode - The result code.public final S addControl(Control control)
ResponseaddControl in interface Responsecontrol - The control to be added.public boolean containsControl(String oid)
Responsetrue if this response contains the specified response
control.containsControl in interface Responseoid - The numeric OID of the response control.true if this response contains the specified response
control.public final <C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
ResponsegetControl in interface ResponseC - 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).public final 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 ResponseList containing the controls.Copyright © 2011-2015 ForgeRock AS. All Rights Reserved.