R
- The type of extended request.S
- The type of result.public abstract class AbstractExtendedRequest<R extends ExtendedRequest<S>,S extends ExtendedResult> extends Object implements ExtendedRequest<S>
Modifier | Constructor and Description |
---|---|
protected |
AbstractExtendedRequest()
Creates a new abstract extended request.
|
protected |
AbstractExtendedRequest(ExtendedRequest<S> extendedRequest)
Creates a new extended request that is an exact copy of the provided
request.
|
Modifier and Type | Method and Description |
---|---|
R |
addControl(Control control)
Adds the provided control to this request.
|
boolean |
containsControl(String oid)
Returns
true if this request contains the specified request
control. |
<C extends Control> |
getControl(ControlDecoder<C> decoder,
DecodeOptions options)
Decodes and returns the first control in this request having an OID
corresponding to the provided control decoder.
|
List<Control> |
getControls()
Returns a
List containing the controls included with this
request. |
abstract String |
getOID()
Returns the numeric OID associated with this extended request.
|
abstract ExtendedResultDecoder<S> |
getResultDecoder()
Returns a decoder which can be used to decoded responses to this extended
request.
|
abstract ByteString |
getValue()
Returns the value, if any, associated with this extended request.
|
abstract boolean |
hasValue()
Returns
true if this extended request has a value. |
String |
toString() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addControl, getControl, getControls
containsControl
protected AbstractExtendedRequest()
protected AbstractExtendedRequest(ExtendedRequest<S> extendedRequest)
extendedRequest
- The extended request to be copied.NullPointerException
- If extendedRequest
was null
.public abstract String getOID()
ExtendedRequest
getOID
in interface ExtendedRequest<S extends ExtendedResult>
public abstract ExtendedResultDecoder<S> getResultDecoder()
ExtendedRequest
getResultDecoder
in interface ExtendedRequest<S extends ExtendedResult>
public abstract ByteString getValue()
ExtendedRequest
getValue
in interface ExtendedRequest<S extends ExtendedResult>
null
if there is no value.public abstract boolean hasValue()
ExtendedRequest
true
if this extended request has a value. In some
circumstances it may be useful to determine if a extended request has a
value, without actually calculating the value and incurring any
performance costs.hasValue
in interface ExtendedRequest<S extends ExtendedResult>
true
if this extended request has a value, or
false
if there is no value.public final R addControl(Control control)
Request
addControl
in interface Request
control
- The control to be added to this request.public boolean containsControl(String oid)
Request
true
if this request contains the specified request
control.containsControl
in interface Request
oid
- The numeric OID of the request control.true
if this request contains the specified request
control.public final <C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
Request
getControl
in interface Request
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 request.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()
Request
List
containing the controls included with this
request. The returned List
may be modified if permitted by this
request.getControls
in interface Request
List
containing the controls.Copyright 2010-2017 ForgeRock AS.