Uses of Interface org.forgerock.opendj.ldap.messages.Request (OpenDJ Public API Javadoc 7.3.5-20240506155118-fba46f79e3510f00d8e7e5228e53672e49833f71 Documentation)

Packages that use Request
Package	Description
org.forgerock.opendj.ldap	Classes and interfaces for core types including connections, entries, and attributes.
org.forgerock.opendj.ldap.messages	Classes and interfaces for core LDAP requests/responses.
org.forgerock.opendj.ldif	Classes and interfaces for reading and writing LDIF.
org.forgerock.opendj.server.core	Classes implementing core server APIs.
org.opends.server.api	Contains a number of API declarations for use throughout the Directory Server.
org.opends.server.authorization.policy	Contains the policy based access control handler implementation.
org.opends.server.backends	Contains various Directory Server backend implementations.
org.opends.server.loggers	Contains implementations of Directory Server access, error, and debug loggers.
org.opends.server.protocols	Contains various Directory Server connection handler implementations which will be used to accept connections from and perform communication with clients over various protocols.
org.opends.server.protocols.jmx	Contains the implementation for the Directory Server connection handler that is responsible for interacting with clients using JMX.
org.opends.server.protocols.ldap	Contains the implementation for the Directory Server connection handler that is responsible for interacting with clients using LDAPv3.

Uses of Request in org.forgerock.opendj.ldap

Methods in org.forgerock.opendj.ldap with parameters of type Request
Modifier and Type	Method	Description
`Flowable<Response>`	MemoryBackend.`handleRequest(int msgId, Request request)`	Returns a `Flowable` which, when subscribed, will apply the provided `request` to this memory backend.
`Flowable<Response>`	MemoryBackend.`handleRequest(Request request)`	Returns a `Flowable` which, when subscribed, will apply the provided `request` to this memory backend.
`default Flowable<Response>`	LdapClientSocket.`send(Request request)`	Sends a request to the Directory Server.
`Flowable<Response>`	LdapClientSocket.`send(Request request, RequestHandle handle)`	Sends a request to the Directory Server.

Method parameters in org.forgerock.opendj.ldap with type arguments of type Request
Modifier and Type	Method	Description
`static Connection`	Connections.`newInternalConnection(BiFunction<Integer,Request,Flowable<Response>> requestHandler)`	Creates a new `Connection` which will route requests to the provided `requestHandler`.
`static ConnectionFactory`	Connections.`newInternalConnectionFactory(BiFunction<Integer,Request,Flowable<Response>> requestHandler)`	Creates a new `ConnectionFactory` which will route requests to the provided `requestHandler`.
`static LdapClient`	LdapClients.`newInternalLdapClient(BiFunction<Integer,Request,Flowable<Response>> requestHandler)`	Creates a new `LdapClient` which will route requests to the provided `requestHandler`.
`static LdapClientSocket`	LdapClients.`newInternalLdapClientSocket(BiFunction<Integer,Request,Flowable<Response>> requestHandler)`	Creates a new `LdapClientSocket` which will route requests to the provided `requestHandler`.

Constructor parameters in org.forgerock.opendj.ldap with type arguments of type Request
Constructor	Description
`LdapServer(int port, Function<LdapSession,BiFunction<Integer,Request,Flowable<Response>>> factory)`	Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
`LdapServer(int port, Function<LdapSession,BiFunction<Integer,Request,Flowable<Response>>> factory, Options options)`	Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
`LdapServer(String host, int port, Function<LdapSession,BiFunction<Integer,Request,Flowable<Response>>> factory)`	Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
`LdapServer(String host, int port, Function<LdapSession,BiFunction<Integer,Request,Flowable<Response>>> factory, Options options)`	Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
`LdapServer(Set<InetSocketAddress> addresses, Function<LdapSession,BiFunction<Integer,Request,Flowable<Response>>> factory)`	Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
`LdapServer(Set<InetSocketAddress> addresses, Function<LdapSession,BiFunction<Integer,Request,Flowable<Response>>> factory, Options options)`	Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.

Uses of Request in org.forgerock.opendj.ldap.messages

Subinterfaces of Request in org.forgerock.opendj.ldap.messages
Modifier and Type	Interface	Description
`interface`	`AbandonRequest`	The Abandon operation allows a client to request that the server abandon an uncompleted operation.
`interface`	`AddRequest`	The Add operation allows a client to request the addition of an entry into the Directory.
`interface`	`BindRequest`	The Bind operation allows authentication information to be exchanged between the client and server.
`interface`	`CancelExtendedRequest`	The cancel extended request as defined in RFC 3909.
`interface`	`CompareRequest`	The Compare operation allows a client to compare an assertion value with the values of a particular attribute in a particular entry in the Directory.
`interface`	`DeleteRequest`	The Delete operation allows a client to request the removal of an entry from the Directory.
`interface`	`ExtendedRequest<S extends ExtendedResult>`	The Extended operation allows additional operations to be defined for services not already available in the protocol; for example, to implement an operation which installs transport layer security (see `StartTlsExtendedRequest`).
`interface`	`GenericExtendedRequest`	A generic Extended request which should be used for unsupported extended operations.
`interface`	`ModifyDnRequest`	The Modify DN operation allows a client to change the Relative Distinguished Name (RDN) of an entry in the Directory and/or to move a subtree of entries to a new location in the Directory.
`interface`	`ModifyRequest`	The Modify operation allows a client to request that a modification of an entry be performed on its behalf by a server.
`interface`	`PasswordModifyExtendedRequest`	The password modify extended request as defined in RFC 3062.
`interface`	`SearchRequest`	The Search operation is used to request a server to return, subject to access controls and other restrictions, a set of entries matching a complex search criterion.
`interface`	`StartTlsExtendedRequest`	The start TLS extended request as defined in RFC 4511.
`interface`	`UnbindRequest`	The Unbind operation allows a client to terminate an LDAP session.
`interface`	`WhoAmIExtendedRequest`	The who am I extended request as defined in RFC 4532.

Classes in org.forgerock.opendj.ldap.messages that implement Request
Modifier and Type	Class	Description
`class`	`AbstractExtendedRequest<ER extends ExtendedRequest<S>,S extends ExtendedResult>`	An abstract Extended request which can be used as the basis for implementing new Extended operations.
`class`	`InvalidRequest`	Represents a request which has been received and decoded but but is invalid according to the LDAP standard because of an invalid DN syntax or an invalid attribute syntax.
`class`	`UnknownRequest`	Wraps a message that the `LdapServer` was unable to decode because it did not recognize it.

Methods in org.forgerock.opendj.ldap.messages with type parameters of type Request
Modifier and Type	Method	Description
`static <R extends Request> R`	Requests.`shallowCopyOfRequest(R request, String... excludeControlOids)`	Creates a new request that is a shallow copy of the provided request, except for controls list which is a new list containing the original controls (and not the original list of controls) possibly filtered by the provided exclusion parameter.
`static <R extends Request> R`	Requests.`shallowCopyOfRequest(R request, Collection<String> excludeControlOids)`	Creates a new request that is a shallow copy of the provided request, except for controls list which is a new list containing the original controls (and not the original list of controls) possibly filtered by the provided exclusion parameter.

Methods in org.forgerock.opendj.ldap.messages that return Request
Modifier and Type	Method	Description
`Request`	Request.`addControl(Control control)`
`Request`	Request.`addControls(Iterable<? extends Control> controls)`

Methods in org.forgerock.opendj.ldap.messages with parameters of type Request
Modifier and Type	Method	Description
`static Dn`	Requests.`dnOfRequest(Request request)`	Returns the DN of the entry targeted by the provided request, or `null` if the target entry cannot be determined.
`static boolean`	Requests.`isCancel(Request request)`	Checks whether the provided request is a Cancel extended request.
`static boolean`	Requests.`isPersistentSearch(Request request)`	Returns whether the provided request is a persistent search request.
`static LdapMessage`	LdapMessage.`newRequestMessage(int messageId, Request request)`	Builds and returns an `LdapMessage` containing a `Request`.
`static LdapMessage`	LdapMessage.`newResponseMessage(int messageId, Request forRequest, Response response)`	Builds and returns an `LdapMessage` containing a `Response`.
`protected R`	AbstractRequestVisitor.`visitAnyRequest(P p, Request request)`	Catch-all method visiting any request for which the visit method has not been overridden.

Uses of Request in org.forgerock.opendj.ldif

Subinterfaces of Request in org.forgerock.opendj.ldif
Modifier and Type Interface Description

interface ChangeRecord
A request to modify the content of the Directory in some way.

Uses of Request in org.forgerock.opendj.server.core

Methods in org.forgerock.opendj.server.core with parameters of type Request
Modifier and Type	Method	Description
`Flowable<Response>`	AddBinaryOptionReactiveFilter.`filter(org.forgerock.services.context.Context context, Request request, RequestHandler next)`
`Flowable<Response>`	Router.`handle(org.forgerock.services.context.Context context, Request request)`

Uses of Request in org.opends.server.api

Methods in org.opends.server.api with parameters of type Request
Modifier and Type	Method	Description
`Flowable<Response>`	ClientSideResultCodeRequestFilter.`filter(org.forgerock.services.context.Context context, Request request, RequestHandler next)`
`Flowable<Response>`	RequestFilter.`filter(org.forgerock.services.context.Context context, Request request, RequestHandler next)`	Filters the request and/or response of an exchange.
`Flowable<Response>`	RequestFilterChain.`filter(org.forgerock.services.context.Context context, Request request, RequestHandler next)`
`Flowable<Response>`	TypedProtocolOpFilter.`filter(org.forgerock.services.context.Context context, Request request, RequestHandler next)`
`Flowable<Response>`	TypedRequestFilter.`filter(org.forgerock.services.context.Context context, Request request, RequestHandler next)`
`protected Flowable<Response>`	TypedProtocolOpFilter.`filterAny(org.forgerock.services.context.Context context, Request request, RequestHandler next)`	Forwards the request to the next handler in the chain.
`protected Flowable<Response>`	TypedRequestFilter.`filterAny(org.forgerock.services.context.Context context, Request request, RequestHandler next)`	Filters requests and their responses.
`protected void`	TypedProtocolOpFilter.`filterAnyResponse(org.forgerock.services.context.Context context, Request request, Response response)`	Implements the common behavior for all the responses for which no specific behavior has been specified by an overridden observe*Response() like method.
`Flowable<Response>`	LocalBackend.`handle(org.forgerock.services.context.Context context, Request request)`	Processes the provided request in a reactive way within this backend.
`Flowable<Response>`	RequestHandler.`handle(org.forgerock.services.context.Context context, Request request)`	Returns a `Flowable` representing the asynchronous `Response` of the given `request`.
`Flowable<Response>`	TypedRequestHandler.`handle(org.forgerock.services.context.Context context, Request request)`
`protected Flowable<Response>`	TypedRequestHandler.`handleAny(org.forgerock.services.context.Context context, Request request)`	Implements the common behavior for all the request types.

Uses of Request in org.opends.server.authorization.policy

Methods in org.opends.server.authorization.policy with parameters of type Request
Modifier and Type	Method	Description
`Flowable<Response>`	PolicyBasedAccessControlHandler.`filter(org.forgerock.services.context.Context context, Request request, RequestHandler next)`

Uses of Request in org.opends.server.backends

Methods in org.opends.server.backends with parameters of type Request
Modifier and Type	Method	Description
`Flowable<Response>`	ProxyBackend.`handle(org.forgerock.services.context.Context context, Request request)`

Uses of Request in org.opends.server.loggers

Methods in org.opends.server.loggers with parameters of type Request
Modifier and Type	Method	Description
`Flowable<Response>`	ReactiveFilterAccessLog.`filter(org.forgerock.services.context.Context context, Request request, RequestHandler next)`

Uses of Request in org.opends.server.protocols

Methods in org.opends.server.protocols with parameters of type Request
Modifier and Type	Method	Description
`static void`	ReactiveHandlersUtils.`addAttachmentsToOperation(Operation op, Request request, FlowableEmitter<Response> out)`	Add to operation the attachments needed for correct behavior of the reactive handlers.
`static InternalModificationsRequestControl`	ReactiveHandlersUtils.`getInternalModificationControl(Request request)`	Returns the internal modification control from the provided request.
`static ReplicatedRequestControl`	ReactiveHandlersUtils.`getReplicatedRequestControl(Request request)`	Returns the replicated request control from the provided request.
`static Operation`	ReactiveHandlersUtils.`requestToOperation(org.forgerock.services.context.Context context, Request request)`	Returns an operation from the provided request.

Uses of Request in org.opends.server.protocols.jmx

Methods in org.opends.server.protocols.jmx with parameters of type Request
Modifier and Type	Method	Description
`Flowable<Response>`	JmxClientConnection.`handle(org.forgerock.services.context.Context context, Request request)`	Processes the provided request in a reactive way, which should be either a `BindRequest` or a `SearchRequest`.

Uses of Request in org.opends.server.protocols.ldap

Methods in org.opends.server.protocols.ldap with parameters of type Request
Modifier and Type	Method	Description
`Flowable<Response>`	LdapStatisticsFilter.`filter(org.forgerock.services.context.Context context, Request request, RequestHandler next)`
`Flowable<Response>`	LdapClientConnection.`handle(org.forgerock.services.context.Context context, Request request)`	Processes the provided request in a reactive way.