public interface Request
Modifier and Type | Method and Description |
---|---|
Request |
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. |
Request addControl(Control control)
control
- The control to be added to this request.UnsupportedOperationException
- If this request does not permit controls to be added.NullPointerException
- If control
was null
.boolean containsControl(String oid)
true
if this request contains the specified request
control.oid
- The numeric OID of the request control.true
if this request contains the specified request
control.<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
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).NullPointerException
- If decoder
or options
was null
.List<Control> getControls()
List
containing the controls included with this
request. The returned List
may be modified if permitted by this
request.List
containing the controls.Copyright 2010-2017 ForgeRock AS.