Package org.opends.server.api
Class TypedRequestFilter
- java.lang.Object
-
- org.opends.server.api.TypedRequestFilter
-
- All Implemented Interfaces:
RequestFilter
public class TypedRequestFilter extends Object implements RequestFilter
Base class for implementingRequestFilter
s whose behavior depends on the type ofRequest
.It is possible to provides specific behavior for different request types by selectively overriding the filter*() methods. Common behaviour can be added for the remaining request types by overriding the
filterAny(Context, Request, RequestHandler)
method.- See Also:
TypedProtocolOpFilter
,RequestFilter
-
-
Constructor Summary
Constructors Constructor Description TypedRequestFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Flowable<Response>
filter(org.forgerock.services.context.Context context, Request request, RequestHandler next)
Filters the request and/or response of an exchange.protected Flowable<Response>
filterAbandon(org.forgerock.services.context.Context context, AbandonRequest request, RequestHandler next)
Filters abandon requests and their responses.protected Flowable<Response>
filterAdd(org.forgerock.services.context.Context context, AddRequest request, RequestHandler next)
Filters add requests and their responses.protected Flowable<Response>
filterAny(org.forgerock.services.context.Context context, Request request, RequestHandler next)
Filters requests and their responses.protected Flowable<Response>
filterBind(org.forgerock.services.context.Context context, BindRequest request, RequestHandler next)
Filters bind requests and their responses.protected Flowable<Response>
filterCompare(org.forgerock.services.context.Context context, CompareRequest request, RequestHandler next)
Filters compare requests and their responses.protected Flowable<Response>
filterDelete(org.forgerock.services.context.Context context, DeleteRequest request, RequestHandler next)
Filters delete requests and their responses.protected Flowable<Response>
filterExtended(org.forgerock.services.context.Context context, ExtendedRequest<?> request, RequestHandler next)
Filters extended requests and their responses.protected Flowable<Response>
filterInvalid(org.forgerock.services.context.Context context, InvalidRequest request, RequestHandler next)
Filters invalid requests and their responses.protected Flowable<Response>
filterModify(org.forgerock.services.context.Context context, ModifyRequest request, RequestHandler next)
Filters modify requests and their responses.protected Flowable<Response>
filterModifyDn(org.forgerock.services.context.Context context, ModifyDnRequest request, RequestHandler next)
Filters modify-dn requests and their responses.protected Flowable<Response>
filterSearch(org.forgerock.services.context.Context context, SearchRequest request, RequestHandler next)
Filters search requests and their responses.protected Flowable<Response>
filterUnbind(org.forgerock.services.context.Context context, UnbindRequest request, RequestHandler next)
Filters unbind requests and their responses.protected Flowable<Response>
filterUnknown(org.forgerock.services.context.Context context, UnknownRequest request, RequestHandler next)
Filters unknown requests and their responses.
-
-
-
Method Detail
-
filter
public final Flowable<Response> filter(org.forgerock.services.context.Context context, Request request, RequestHandler next) throws Exception
Description copied from interface:RequestFilter
Filters the request and/or response of an exchange. To pass the request to the next filter or handler in the chain, the filter callsnext.handle(context, request)
.This method may elect not to pass the request to the next filter or handler, and instead handle the request itself. It can achieve this by merely avoiding a call to
next.handle(context, request)
and creating its own response object. The filter is also at liberty to replace a response with another of its own by intercepting the response returned by the next handler.- Specified by:
filter
in interfaceRequestFilter
- Parameters:
context
- The request context.request
- The request.next
- The next filter or handler in the chain to handle the request.- Returns:
- A
Flowable
representing the response to be returned to the client. - Throws:
Exception
- If an error occurred during the processing of the request.
-
filterAny
protected Flowable<Response> filterAny(org.forgerock.services.context.Context context, Request request, RequestHandler next) throws Exception
Filters requests and their responses. The default behavior is to invokeRequestHandler.handle(Context, Request)
.
-
filterAbandon
protected Flowable<Response> filterAbandon(org.forgerock.services.context.Context context, AbandonRequest request, RequestHandler next) throws Exception
Filters abandon requests and their responses. The default behavior is to invokefilterAny(Context, Request, RequestHandler)
.
-
filterAdd
protected Flowable<Response> filterAdd(org.forgerock.services.context.Context context, AddRequest request, RequestHandler next) throws Exception
Filters add requests and their responses. The default behavior is to invokefilterAny(Context, Request, RequestHandler)
.
-
filterBind
protected Flowable<Response> filterBind(org.forgerock.services.context.Context context, BindRequest request, RequestHandler next) throws Exception
Filters bind requests and their responses. The default behavior is to invokefilterAny(Context, Request, RequestHandler)
.
-
filterCompare
protected Flowable<Response> filterCompare(org.forgerock.services.context.Context context, CompareRequest request, RequestHandler next) throws Exception
Filters compare requests and their responses. The default behavior is to invokefilterAny(Context, Request, RequestHandler)
.
-
filterDelete
protected Flowable<Response> filterDelete(org.forgerock.services.context.Context context, DeleteRequest request, RequestHandler next) throws Exception
Filters delete requests and their responses. The default behavior is to invokefilterAny(Context, Request, RequestHandler)
.
-
filterExtended
protected Flowable<Response> filterExtended(org.forgerock.services.context.Context context, ExtendedRequest<?> request, RequestHandler next) throws Exception
Filters extended requests and their responses. The default behavior is to invokefilterAny(Context, Request, RequestHandler)
.
-
filterInvalid
protected Flowable<Response> filterInvalid(org.forgerock.services.context.Context context, InvalidRequest request, RequestHandler next) throws Exception
Filters invalid requests and their responses. The default behavior is to invokefilterAny(Context, Request, RequestHandler)
.
-
filterSearch
protected Flowable<Response> filterSearch(org.forgerock.services.context.Context context, SearchRequest request, RequestHandler next) throws Exception
Filters search requests and their responses. The default behavior is to invokefilterAny(Context, Request, RequestHandler)
.
-
filterModify
protected Flowable<Response> filterModify(org.forgerock.services.context.Context context, ModifyRequest request, RequestHandler next) throws Exception
Filters modify requests and their responses. The default behavior is to invokefilterAny(Context, Request, RequestHandler)
.
-
filterModifyDn
protected Flowable<Response> filterModifyDn(org.forgerock.services.context.Context context, ModifyDnRequest request, RequestHandler next) throws Exception
Filters modify-dn requests and their responses. The default behavior is to invokefilterAny(Context, Request, RequestHandler)
.
-
filterUnbind
protected Flowable<Response> filterUnbind(org.forgerock.services.context.Context context, UnbindRequest request, RequestHandler next) throws Exception
Filters unbind requests and their responses. The default behavior is to invokefilterAny(Context, Request, RequestHandler)
.
-
filterUnknown
protected Flowable<Response> filterUnknown(org.forgerock.services.context.Context context, UnknownRequest request, RequestHandler next) throws Exception
Filters unknown requests and their responses. The default behavior is to invokefilterAny(Context, Request, RequestHandler)
.
-
-