public interface AbandonRequest extends Request
Abandon, Bind, Unbind, and StartTLS operations cannot be abandoned.
Modifier and Type | Method and Description |
---|---|
AbandonRequest |
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. |
int |
getRequestID()
Returns the request ID of the request to be abandoned.
|
AbandonRequest |
setRequestID(int id)
Sets the request ID of the request to be abandoned.
|
containsControl
AbandonRequest addControl(Control control)
Request
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 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 Request
List
containing the controls.int getRequestID()
AbandonRequest 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.