public interface ExtendedResult extends Result
getOid()
and getValue()
methods respectively.Modifier and Type | Method and Description |
---|---|
ExtendedResult |
addControl(Control control)
Adds the provided control to this protocol-op.
|
ExtendedResult |
addControls(Iterable<? extends Control> controls)
Adds the provided controls to this protocol-op.
|
ExtendedResult |
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 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.
|
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 a referral needs to be chased in order to
complete the operation.
|
boolean |
isSuccess()
Indicates whether the request succeeded or not.
|
ExtendedResult |
setCause(Throwable cause)
Sets the throwable cause associated with this result if available.
|
ExtendedResult |
setDiagnosticMessage(CharSequence message)
Sets the diagnostic message associated with this result.
|
ExtendedResult |
setMatchedDn(Dn dn)
Sets the matched DN associated with this result.
|
ExtendedResult |
setMatchedDn(String dn)
Sets the matched DN associated with this result.
|
ExtendedResult |
setResultCode(ResultCode resultCode)
Sets the result code associated with this result.
|
containsControl, getControl
ExtendedResult addControl(Control control)
ProtocolOp
addControl
in interface ProtocolOp
addControl
in interface Response
addControl
in interface Result
control
- The control to be added to this protocol-op.ExtendedResult addControls(Iterable<? extends Control> controls)
ProtocolOp
addControls
in interface ProtocolOp
addControls
in interface Response
addControls
in interface Result
controls
- The controls to be added to this protocol-op.ExtendedResult addReferralUri(String uri)
Result
addReferralUri
in interface Result
uri
- The referral URI to be added.Throwable getCause()
Result
<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
ProtocolOp
getControl
in interface ProtocolOp
getControl
in interface Result
C
- 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 protocol-op.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()
ProtocolOp
List
containing the controls included with this
protocol-op. The returned List
may be modified if permitted by this
protocol-op.getControls
in interface ProtocolOp
getControls
in interface Result
List
containing the controls.LocalizableMessage getDiagnosticMessage()
Result
getDiagnosticMessage
in interface Result
null
).String getDiagnosticMessageAsString()
Result
getDiagnosticMessageAsString
in interface Result
null
).String getMatchedDn()
Result
getMatchedDn
in interface Result
null
).String getOid()
null
if there is no OID.List<String> getReferralUris()
Result
List
containing the referral URIs included with this
result. The returned List
may be modified if permitted by this
result.getReferralUris
in interface Result
List
containing the referral URIs.ResultCode getResultCode()
Result
getResultCode
in interface Result
ByteString getValue()
null
if there is no value.boolean hasValue()
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.true
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 Result
true
if a referral needs to be chased, otherwise
false
.boolean isSuccess()
Result
ExtendedResult setCause(Throwable cause)
Result
ExtendedResult setDiagnosticMessage(CharSequence message)
Result
setDiagnosticMessage
in interface Result
message
- The diagnostic message, which may be empty or null
indicating that none was provided.ExtendedResult setMatchedDn(String dn)
Result
setMatchedDn
in interface Result
dn
- The matched DN associated, which may be empty or null
indicating that none was provided.ExtendedResult setMatchedDn(Dn dn)
Result
setMatchedDn
in interface Result
dn
- The matched DN associated, which may be empty or null
indicating that none was provided.ExtendedResult setResultCode(ResultCode resultCode)
Result
setResultCode
in interface Result
resultCode
- The result code.Copyright 2010-2022 ForgeRock AS.