public interface GenericExtendedRequest extends ExtendedRequest<GenericExtendedResult>
supportedExtension
attribute in the root DSE. Where the name is not
recognized, the server returns
ResultCode.PROTOCOL_ERROR
(the server may
return this error in other cases).Request.RequestType
Modifier and Type | Field and Description |
---|---|
static ExtendedRequestDecoder<GenericExtendedRequest,GenericExtendedResult> |
DECODER
A decoder which can be used to decode generic extended operation
requests.
|
Modifier and Type | Method and Description |
---|---|
GenericExtendedRequest |
addControl(Control control)
Adds the provided control to this protocol-op.
|
GenericExtendedRequest |
addControls(Iterable<? extends Control> controls)
Adds the provided controls to this protocol-op.
|
<C extends Control> |
getControl(ControlDecoder<C> decoder,
DecodeOptions options)
Decodes and returns the first control in this protocol-op having an OID
corresponding to the provided control decoder.
|
List<Control> |
getControls()
Returns a
List containing the controls included with this
protocol-op. |
String |
getOid()
Returns the numeric OID associated with this extended request.
|
ExtendedResultDecoder<GenericExtendedResult> |
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. |
GenericExtendedRequest |
setOid(String oid)
Sets the numeric OID associated with this extended request.
|
GenericExtendedRequest |
setValue(Object value)
Sets the value, if any, associated with this extended request.
|
containsControl, getControl
static final ExtendedRequestDecoder<GenericExtendedRequest,GenericExtendedResult> DECODER
GenericExtendedRequest addControl(Control control)
ProtocolOp
addControl
in interface ExtendedRequest<GenericExtendedResult>
addControl
in interface ProtocolOp
addControl
in interface Request
control
- The control to be added to this protocol-op.GenericExtendedRequest addControls(Iterable<? extends Control> controls)
ProtocolOp
addControls
in interface ExtendedRequest<GenericExtendedResult>
addControls
in interface ProtocolOp
addControls
in interface Request
controls
- The controls to be added to this protocol-op.<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
ProtocolOp
getControl
in interface ExtendedRequest<GenericExtendedResult>
getControl
in interface ProtocolOp
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 protocol-op.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()
ProtocolOp
List
containing the controls included with this
protocol-op. The returned List
may be modified if permitted by this
protocol-op.getControls
in interface ExtendedRequest<GenericExtendedResult>
getControls
in interface ProtocolOp
List
containing the controls.String getOid()
ExtendedRequest
getOid
in interface ExtendedRequest<GenericExtendedResult>
ExtendedResultDecoder<GenericExtendedResult> getResultDecoder()
ExtendedRequest
getResultDecoder
in interface ExtendedRequest<GenericExtendedResult>
ByteString getValue()
ExtendedRequest
getValue
in interface ExtendedRequest<GenericExtendedResult>
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<GenericExtendedResult>
true
if this extended request has a value, or
false
if there is no value.GenericExtendedRequest setOid(String oid)
oid
- The numeric OID associated with this extended request.UnsupportedOperationException
- If this generic extended request does not permit the request
name to be set.NullPointerException
- If oid
was null
.GenericExtendedRequest setValue(Object value)
If value
is not an instance of ByteString
then it will be
converted using the ByteString.valueOfObject(Object)
method.
value
- TThe value associated with this extended request, or
null
if there is no value. Its format is defined by
the specification of this control.UnsupportedOperationException
- If this generic extended request does not permit the request
value to be set.Copyright 2010-2022 ForgeRock AS.