Package org.forgerock.opendj.ldap.messages

Interface Request

All Superinterfaces:

ProtocolOp

All Known Subinterfaces:

ChangeRecord, ExtendedRequest<S>

All Known Implementing Classes:

AbandonRequest, AddRequest, BindRequest, CancelExtendedRequest, CompareRequest, DeleteRequest, GenericExtendedRequest, InvalidRequest, ModifyDnRequest, ModifyRequest, PasswordModifyExtendedRequest, SearchRequest, StartTlsExtendedRequest, UnbindRequest, UnknownRequest, WhoAmIExtendedRequest

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	Description
static enum	Request.RequestType	The type of this request.

Method Summary

Modifier and Type	Method	Description
<R, P, E extends Exception> R	accept(RequestVisitor<R,P,E> v, P p)	Applies a RequestVisitor to this Request.
Request.RequestType	getType()	Returns the type of this request to avoid expensive instanceof checks.

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

addControl, addControls, containsControl, controls, getControl, getControl, removeControls

Method Details

accept

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

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.

getType

Request.RequestType getType()

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

Returns:

the type of this request