S
- The type of Intermediate response.public abstract class AbstractIntermediateResponse<S extends IntermediateResponse> extends Object implements IntermediateResponse
Modifier | Constructor and Description |
---|---|
protected |
AbstractIntermediateResponse()
Creates a new intermediate response.
|
protected |
AbstractIntermediateResponse(IntermediateResponse intermediateResponse)
Creates a new intermediate response that is an exact copy of the provided
response.
|
Modifier and Type | Method and Description |
---|---|
S |
addControl(Control control)
Adds the provided control to this response.
|
boolean |
containsControl(String oid)
Returns
true if this response contains the specified response
control. |
<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. |
abstract String |
getOID()
Returns the numeric OID, if any, associated with this intermediate
response.
|
abstract ByteString |
getValue()
Returns the value, if any, associated with this intermediate response.
|
abstract boolean |
hasValue()
Returns
true if this intermediate response has a value. |
String |
toString() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addControl, getControl, getControls
containsControl
protected AbstractIntermediateResponse()
protected AbstractIntermediateResponse(IntermediateResponse intermediateResponse)
intermediateResponse
- The intermediate response to be copied.NullPointerException
- If intermediateResponse
was null
.public abstract String getOID()
IntermediateResponse
getOID
in interface IntermediateResponse
null
if there is no OID.public abstract ByteString getValue()
IntermediateResponse
getValue
in interface IntermediateResponse
null
if there is no value.public abstract boolean hasValue()
IntermediateResponse
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.hasValue
in interface IntermediateResponse
true
if this intermediate response has a value, or
false
if there is no value.public final S addControl(Control control)
Response
addControl
in interface Response
control
- The control to be added.public boolean containsControl(String oid)
Response
true
if this response contains the specified response
control.containsControl
in interface Response
oid
- 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
Response
getControl
in interface Response
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 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()
Response
List
containing the controls included with this
response. The returned List
may be modified if permitted by this
response.getControls
in interface Response
List
containing the controls.Copyright 2010-2017 ForgeRock AS.