oracle.oud.requests

Interface ExtendedRequest<R extends ExtendedResult>

Type Parameters:

R - The type of result.

All Superinterfaces:

AttachmentHolder, Request

All Known Implementing Classes:

ExtendedRequestWrapper

public interface ExtendedRequest<R extends ExtendedResult>
extends Request

The Extended operation allows additional operations to be defined for services not already available in the protocol.

Method Summary

Modifier and Type	Method and Description
ExtendedRequest<R>	addControl(Control control) Adds the provided control to this request.
java.lang.String	getOID() Returns the numeric OID associated with this extended request.
ExtendedResultDecoder<R>	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.

Methods inherited from interface oracle.oud.requests.Request

getControl, getControls, isInternal, removeControl

Methods inherited from interface oracle.oud.plugin.AttachmentHolder

getAttachment, getAttachmentNames, removeAttachment, setAttachment

Method Detail

addControl

ExtendedRequest<R> addControl(Control control)
                       throws java.lang.UnsupportedOperationException,
                              java.lang.NullPointerException

Adds the provided control to this request.

Specified by:

addControl in interface Request

Parameters:

control - The control to be added to this request.

Returns:

This request.

Throws:

java.lang.UnsupportedOperationException - If this request does not permit controls to be added.

java.lang.NullPointerException - If control was null.

getOID

java.lang.String getOID()

Returns the numeric OID associated with this extended request.

Returns:

The numeric OID associated with this extended request.

getResultDecoder

ExtendedResultDecoder<R> getResultDecoder()

Returns a decoder which can be used to decoded responses to this extended request.

Returns:

A decoder which can be used to decoded responses to this extended request.

getValue

ByteString getValue()

Returns the value, if any, associated with this extended request. Its format is defined by the specification of this extended request.

Returns:

The value associated with this extended request, or null if there is no value.

hasValue

boolean hasValue()

Returns 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.

Returns:

true if this extended request has a value, or false if there is no value.