public interface CancelExtendedRequest extends ExtendedRequest<ExtendedResult>
Modifier and Type | Field and Description |
---|---|
static ExtendedRequestDecoder<CancelExtendedRequest,ExtendedResult> |
DECODER
A decoder which can be used to decode cancel extended operation requests.
|
static String |
OID
The OID for the cancel extended operation request.
|
Modifier and Type | Method and Description |
---|---|
CancelExtendedRequest |
addControl(Control control)
Adds the provided control to this request.
|
<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. |
String |
getOID()
Returns the numeric OID associated with this extended request.
|
int |
getRequestID()
Returns the request ID of the request to be abandoned.
|
ExtendedResultDecoder<ExtendedResult> |
getResultDecoder()
Returns a decoder which can be used to decoded responses to this extended
request.
|
ByteString |
getValue()
Returns the value, if any, associated with this extended request.
|
boolean |
hasValue()
Returns
true if this extended request has a value. |
CancelExtendedRequest |
setRequestID(int id)
Sets the request ID of the request to be abandoned.
|
containsControl
static final ExtendedRequestDecoder<CancelExtendedRequest,ExtendedResult> DECODER
static final String OID
CancelExtendedRequest addControl(Control control)
Request
addControl
in interface ExtendedRequest<ExtendedResult>
addControl
in interface Request
control
- The control to be added to this request.<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
Request
getControl
in interface ExtendedRequest<ExtendedResult>
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).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 ExtendedRequest<ExtendedResult>
getControls
in interface Request
List
containing the controls.String getOID()
ExtendedRequest
getOID
in interface ExtendedRequest<ExtendedResult>
int getRequestID()
ExtendedResultDecoder<ExtendedResult> getResultDecoder()
ExtendedRequest
getResultDecoder
in interface ExtendedRequest<ExtendedResult>
ByteString getValue()
ExtendedRequest
getValue
in interface ExtendedRequest<ExtendedResult>
null
if there is no value.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<ExtendedResult>
true
if this extended request has a value, or
false
if there is no value.CancelExtendedRequest setRequestID(int id)
id
- The request ID of the request to be abandoned.UnsupportedOperationException
- If this abandon request does not permit the request ID to be
set.Copyright 2010-2017 ForgeRock AS.