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).| 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 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.
|
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.
|
containsControlstatic final ExtendedRequestDecoder<GenericExtendedRequest,GenericExtendedResult> DECODER
GenericExtendedRequest addControl(Control control)
RequestaddControl in interface ExtendedRequest<GenericExtendedResult>addControl in interface Requestcontrol - The control to be added to this request.<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
RequestgetControl in interface ExtendedRequest<GenericExtendedResult>getControl in interface RequestC - 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()
RequestList containing the controls included with this
request. The returned List may be modified if permitted by this
request.getControls in interface ExtendedRequest<GenericExtendedResult>getControls in interface RequestList containing the controls.String getOID()
ExtendedRequestgetOID in interface ExtendedRequest<GenericExtendedResult>ExtendedResultDecoder<GenericExtendedResult> getResultDecoder()
ExtendedRequestgetResultDecoder in interface ExtendedRequest<GenericExtendedResult>ByteString getValue()
ExtendedRequestgetValue in interface ExtendedRequest<GenericExtendedResult>null
if there is no value.boolean hasValue()
ExtendedRequesttrue 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.valueOf(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 © 2011-2015 ForgeRock AS. All Rights Reserved.