public interface IntermediateResponse extends Response
An Intermediate response may convey an optional response name and value.
These can be retrieved using the getOid()
and getValue()
methods respectively.
Modifier and Type | Method and Description |
---|---|
IntermediateResponse |
addControl(Control control)
Adds the provided control to this protocol-op.
|
IntermediateResponse |
addControls(Iterable<? extends Control> controls)
Adds the provided controls to this protocol-op.
|
<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. |
String |
getOid()
Returns the numeric OID, if any, associated with this intermediate
response.
|
ByteString |
getValue()
Returns the value, if any, associated with this intermediate response.
|
boolean |
hasValue()
Returns
true if this intermediate response has a value. |
containsControl, getControl
IntermediateResponse addControl(Control control)
ProtocolOp
addControl
in interface ProtocolOp
addControl
in interface Response
control
- The control to be added to this protocol-op.IntermediateResponse addControls(Iterable<? extends Control> controls)
ProtocolOp
addControls
in interface ProtocolOp
addControls
in interface Response
controls
- The controls to be added to this protocol-op.<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
ProtocolOp
getControl
in interface ProtocolOp
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
List
containing the controls.String getOid()
null
if there is no OID.ByteString getValue()
null
if there is no value.boolean hasValue()
true
if this intermediate response has a value. In some
circumstances it may be useful to determine if an intermediate response
has a value, without actually calculating the value and incurring any
performance costs.true
if this intermediate response has a value, or
false
if there is no value.Copyright 2010-2022 ForgeRock AS.