public interface GenericExtendedResult extends ExtendedResult
| Modifier and Type | Method and Description |
|---|---|
GenericExtendedResult |
addControl(Control control)
Adds the provided control to this response.
|
GenericExtendedResult |
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.
|
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.
|
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 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.
|
GenericExtendedResult |
setCause(Throwable cause)
Sets the throwable cause associated with this result if available.
|
GenericExtendedResult |
setDiagnosticMessage(String message)
Sets the diagnostic message associated with this result.
|
GenericExtendedResult |
setMatchedDN(String dn)
Sets the matched DN associated with this result.
|
GenericExtendedResult |
setOID(String oid)
Sets the numeric OID, if any, associated with this extended result.
|
GenericExtendedResult |
setResultCode(ResultCode resultCode)
Sets the result code associated with this result.
|
GenericExtendedResult |
setValue(Object value)
Sets the value, if any, associated with this extended result.
|
containsControlGenericExtendedResult addControl(Control control)
ResponseaddControl in interface ExtendedResultaddControl in interface ResponseaddControl in interface Resultcontrol - The control to be added.GenericExtendedResult addReferralURI(String uri)
ResultaddReferralURI in interface ExtendedResultaddReferralURI in interface Resulturi - The referral URI to be added.Throwable getCause()
ResultgetCause in interface ExtendedResultgetCause in interface Resultnull if none was provided.<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
ResponsegetControl in interface ExtendedResultgetControl 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 ExtendedResultgetControls in interface ResponsegetControls in interface ResultList containing the controls.String getDiagnosticMessage()
ResultgetDiagnosticMessage in interface ExtendedResultgetDiagnosticMessage in interface Resultnull).String getMatchedDN()
ResultgetMatchedDN in interface ExtendedResultgetMatchedDN in interface Resultnull).String getOID()
ExtendedResultgetOID in interface ExtendedResultnull if there is no OID.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 ExtendedResultgetReferralURIs in interface ResultList containing the referral URIs.ResultCode getResultCode()
ResultgetResultCode in interface ExtendedResultgetResultCode in interface ResultByteString getValue()
ExtendedResultgetValue in interface ExtendedResultnull
if there is no value.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.boolean isReferral()
Result
Specifically, this method returns true if the result code is
equal to ResultCode.REFERRAL.
isReferral in interface ExtendedResultisReferral in interface Resulttrue if a referral needs to be chased, otherwise
false.boolean isSuccess()
ResultisSuccess in interface ExtendedResultisSuccess in interface Resulttrue if the request succeeded, otherwise false.GenericExtendedResult setCause(Throwable cause)
ResultsetCause in interface ExtendedResultsetCause in interface Resultcause - The throwable cause, which may be null indicating that
none was provided.GenericExtendedResult setDiagnosticMessage(String message)
ResultsetDiagnosticMessage in interface ExtendedResultsetDiagnosticMessage in interface Resultmessage - The diagnostic message, which may be empty or null
indicating that none was provided.GenericExtendedResult setMatchedDN(String dn)
ResultsetMatchedDN in interface ExtendedResultsetMatchedDN in interface Resultdn - The matched DN associated, which may be empty or null
indicating that none was provided.GenericExtendedResult setOID(String oid)
oid - The numeric OID associated with this extended result, or
null if there is no value.UnsupportedOperationException - If this generic extended result does not permit the result
name to be set.GenericExtendedResult setResultCode(ResultCode resultCode)
ResultsetResultCode in interface ExtendedResultsetResultCode in interface ResultresultCode - The result code.GenericExtendedResult setValue(Object value)
If value is not an instance of ByteString then it will be
converted using the ByteString.valueOf(Object) method.
value - The value associated with this extended result, or
null if there is no value.UnsupportedOperationException - If this generic extended result does not permit the result
value to be set.Copyright © 2011-2015 ForgeRock AS. All Rights Reserved.