org.forgerock.opendj.ldap.messages

Interface Request

All Superinterfaces:

ProtocolOp

All Known Subinterfaces:

AbandonRequest, AddRequest, BindRequest, CancelExtendedRequest, ChangeRecord, CompareRequest, DeleteRequest, ExtendedRequest<S>, GenericExtendedRequest, ModifyDnRequest, ModifyRequest, PasswordModifyExtendedRequest, SearchRequest, StartTlsExtendedRequest, UnbindRequest, WhoAmIExtendedRequest

All Known Implementing Classes:

AbstractExtendedRequest, InvalidRequest, UnknownRequest

public interface Request
extends ProtocolOp

The base class of all Requests provides methods for querying and manipulating the set of Controls included with a Request.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Request.RequestType The type of this request.

Method Summary

Modifier and Type	Method and Description
<R,P,E extends Exception> R	accept(RequestVisitor<R,P,E> v, P p) Applies a RequestVisitor to this Request.
Request	addControl(Control control) Adds the provided control to this protocol-op.
Request	addControls(Iterable<? extends Control> controls) Adds the provided controls to this protocol-op.
Request.RequestType	getType() Returns the type of this request to avoid expensive instanceof checks.

Methods inherited from interface org.forgerock.opendj.ldap.messages.ProtocolOp

containsControl, getControl, getControl, getControls

Method Detail

accept

<R,P,E extends Exception> R accept(RequestVisitor<R,P,E> v,
                                   P p)
                            throws E extends Exception

Applies a RequestVisitor to this Request.

Type Parameters:

R - The return type of the visitor's methods.

P - The type of the additional parameters to the visitor's methods.

E - The type of the exception thrown by the visitor method if it fails, or NeverThrowsException if the visitor cannot fail.

Parameters:

v - The request visitor.

p - Optional additional visitor parameter.

Returns:

A result as specified by the visitor.

Throws:

E - If the visitor failed.

E extends Exception

getType

Request.RequestType getType()

Returns the type of this request to avoid expensive instanceof checks.

Returns:

the type of this request

addControl

Request addControl(Control control)

Description copied from interface: ProtocolOp

Adds the provided control to this protocol-op.

Specified by:

addControl in interface ProtocolOp

Parameters:

control - The control to be added to this protocol-op.

Returns:

This protocol-op.

addControls

Request addControls(Iterable<? extends Control> controls)

Description copied from interface: ProtocolOp

Adds the provided controls to this protocol-op.

Specified by:

addControls in interface ProtocolOp

Parameters:

controls - The controls to be added to this protocol-op.

Returns:

This protocol-op.