S - The type of result.public interface ExtendedRequest<S extends ExtendedResult> extends Request
StartTLSExtendedRequest).
To determine whether a directory server supports a given extension, read the list of supported extensions from the root DSE to get a collection of extension OIDs, and then check for a match. For example:
Connection connection = ...;
Collection<String> supported =
RootDSE.readRootDSE(connection).getSupportedExtendedOperations();
ExtendedRequest extension = ...;
String OID = extension.getOID();
if (supported != null && !supported.isEmpty() && supported.contains(OID)) {
// The extension is supported. Use it here...
}
| Modifier and Type | Method and Description |
|---|---|
ExtendedRequest<S> |
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<S> |
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. |
containsControlExtendedRequest<S> addControl(Control control)
RequestaddControl 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 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 RequestList containing the controls.String getOID()
ExtendedResultDecoder<S> getResultDecoder()
ByteString getValue()
null
if there is no value.boolean hasValue()
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.true if this extended request has a value, or
false if there is no value.Copyright © 2011-2015 ForgeRock AS. All Rights Reserved.