public class ResourceApiVersionRoutingFilter extends org.forgerock.http.routing.ResourceApiVersionRoutingFilter implements Filter
ApiVersionRouterContext
which contains the default routing behaviour when the
Accept-API-Version header is set on the request. In addition also
sets the Warning and Content-API-Version headers on
the response.Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
filterAction(org.forgerock.services.context.Context context,
ActionRequest request,
RequestHandler next)
Filters an action request.
|
Promise<ResourceResponse,ResourceException> |
filterCreate(org.forgerock.services.context.Context context,
CreateRequest request,
RequestHandler next)
Filters a create request.
|
Promise<ResourceResponse,ResourceException> |
filterDelete(org.forgerock.services.context.Context context,
DeleteRequest request,
RequestHandler next)
Filters a delete request.
|
Promise<ResourceResponse,ResourceException> |
filterPatch(org.forgerock.services.context.Context context,
PatchRequest request,
RequestHandler next)
Filters a patch request.
|
Promise<QueryResponse,ResourceException> |
filterQuery(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler,
RequestHandler next)
Filters a query request.
|
Promise<ResourceResponse,ResourceException> |
filterRead(org.forgerock.services.context.Context context,
ReadRequest request,
RequestHandler next)
Filters a read request.
|
Promise<ResourceResponse,ResourceException> |
filterUpdate(org.forgerock.services.context.Context context,
UpdateRequest request,
RequestHandler next)
Filters an update request.
|
public Promise<ActionResponse,ResourceException> filterAction(org.forgerock.services.context.Context context, ActionRequest request, RequestHandler next)
Filter
context
- The filter chain context.request
- The action request.next
- A request handler representing the remainder of the filter
chain.Promise
containing the result of the operation.public Promise<ResourceResponse,ResourceException> filterCreate(org.forgerock.services.context.Context context, CreateRequest request, RequestHandler next)
Filter
context
- The filter chain context.request
- The create request.next
- A request handler representing the remainder of the filter
chain.Promise
containing the result of the operation.public Promise<ResourceResponse,ResourceException> filterDelete(org.forgerock.services.context.Context context, DeleteRequest request, RequestHandler next)
Filter
context
- The filter chain context.request
- The delete request.next
- A request handler representing the remainder of the filter
chain.Promise
containing the result of the operation.public Promise<ResourceResponse,ResourceException> filterPatch(org.forgerock.services.context.Context context, PatchRequest request, RequestHandler next)
Filter
context
- The filter chain context.request
- The patch request.next
- A request handler representing the remainder of the filter
chain.Promise
containing the result of the operation.public Promise<QueryResponse,ResourceException> filterQuery(org.forgerock.services.context.Context context, QueryRequest request, QueryResourceHandler handler, RequestHandler next)
Filter
Implementations which return results directly rather than forwarding the
request should invoke QueryResourceHandler.handleResource(ResourceResponse)
for each resource which matches the query criteria. Once all matching
resources have been returned implementations are required to return
either a QueryResponse
if the query has completed successfully, or
ResourceException
if the query did not complete successfully
(even if some matching resources were returned).
context
- The filter chain context.request
- The query request.handler
- The resource handler.next
- A request handler representing the remainder of the filter
chain.Promise
containing the result of the operation.public Promise<ResourceResponse,ResourceException> filterRead(org.forgerock.services.context.Context context, ReadRequest request, RequestHandler next)
Filter
context
- The filter chain context.request
- The read request.next
- A request handler representing the remainder of the filter
chain.Promise
containing the result of the operation.public Promise<ResourceResponse,ResourceException> filterUpdate(org.forgerock.services.context.Context context, UpdateRequest request, RequestHandler next)
Filter
context
- The filter chain context.request
- The update request.next
- A request handler representing the remainder of the filter
chain.Promise
containing the result of the operation.Copyright 2010-2018 ForgeRock AS.