org.forgerock.json.resource

Class ResourceApiVersionRoutingFilter

java.lang.Object

org.forgerock.http.routing.ResourceApiVersionRoutingFilter

org.forgerock.json.resource.ResourceApiVersionRoutingFilter

All Implemented Interfaces:

org.forgerock.http.Filter

public class ResourceApiVersionRoutingFilter
extends org.forgerock.http.routing.ResourceApiVersionRoutingFilter
implements Filter

API Version routing filter which creates a 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.

Method Summary

Modifier and Type	Method and Description
org.forgerock.util.promise.Promise<ActionResponse,ResourceException>	filterAction(org.forgerock.services.context.Context context, ActionRequest request, RequestHandler next) Filters an action request.
org.forgerock.util.promise.Promise<ResourceResponse,ResourceException>	filterCreate(org.forgerock.services.context.Context context, CreateRequest request, RequestHandler next) Filters a create request.
org.forgerock.util.promise.Promise<ResourceResponse,ResourceException>	filterDelete(org.forgerock.services.context.Context context, DeleteRequest request, RequestHandler next) Filters a delete request.
org.forgerock.util.promise.Promise<ResourceResponse,ResourceException>	filterPatch(org.forgerock.services.context.Context context, PatchRequest request, RequestHandler next) Filters a patch request.
org.forgerock.util.promise.Promise<QueryResponse,ResourceException>	filterQuery(org.forgerock.services.context.Context context, QueryRequest request, QueryResourceHandler handler, RequestHandler next) Filters a query request.
org.forgerock.util.promise.Promise<ResourceResponse,ResourceException>	filterRead(org.forgerock.services.context.Context context, ReadRequest request, RequestHandler next) Filters a read request.
org.forgerock.util.promise.Promise<ResourceResponse,ResourceException>	filterUpdate(org.forgerock.services.context.Context context, UpdateRequest request, RequestHandler next) Filters an update request.

Methods inherited from class org.forgerock.http.routing.ResourceApiVersionRoutingFilter

createApiVersionRouterContext, filter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

filterAction

public org.forgerock.util.promise.Promise<ActionResponse,ResourceException> filterAction(org.forgerock.services.context.Context context,
                                                                                         ActionRequest request,
                                                                                         RequestHandler next)

Description copied from interface: Filter

Filters an action request.

Parameters:

context - The filter chain context.

request - The action request.

next - A request handler representing the remainder of the filter chain.

Returns:

A Promise containing the result of the operation.

filterCreate

public org.forgerock.util.promise.Promise<ResourceResponse,ResourceException> filterCreate(org.forgerock.services.context.Context context,
                                                                                           CreateRequest request,
                                                                                           RequestHandler next)

Description copied from interface: Filter

Filters a create request.

Parameters:

context - The filter chain context.

request - The create request.

next - A request handler representing the remainder of the filter chain.

Returns:

A Promise containing the result of the operation.

filterDelete

public org.forgerock.util.promise.Promise<ResourceResponse,ResourceException> filterDelete(org.forgerock.services.context.Context context,
                                                                                           DeleteRequest request,
                                                                                           RequestHandler next)

Description copied from interface: Filter

Filters a delete request.

Parameters:

context - The filter chain context.

request - The delete request.

next - A request handler representing the remainder of the filter chain.

Returns:

A Promise containing the result of the operation.

filterPatch

public org.forgerock.util.promise.Promise<ResourceResponse,ResourceException> filterPatch(org.forgerock.services.context.Context context,
                                                                                          PatchRequest request,
                                                                                          RequestHandler next)

Description copied from interface: Filter

Filters a patch request.

Parameters:

context - The filter chain context.

request - The patch request.

next - A request handler representing the remainder of the filter chain.

Returns:

A Promise containing the result of the operation.

filterQuery

public org.forgerock.util.promise.Promise<QueryResponse,ResourceException> filterQuery(org.forgerock.services.context.Context context,
                                                                                       QueryRequest request,
                                                                                       QueryResourceHandler handler,
                                                                                       RequestHandler next)

Description copied from interface: Filter

Filters a query request.

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).

Parameters:

context - The filter chain context.

request - The query request.

handler - The resource handler.

next - A request handler representing the remainder of the filter chain.

Returns:

A Promise containing the result of the operation.

filterRead

public org.forgerock.util.promise.Promise<ResourceResponse,ResourceException> filterRead(org.forgerock.services.context.Context context,
                                                                                         ReadRequest request,
                                                                                         RequestHandler next)

Description copied from interface: Filter

Filters a read request.

Parameters:

context - The filter chain context.

request - The read request.

next - A request handler representing the remainder of the filter chain.

Returns:

A Promise containing the result of the operation.

filterUpdate

public org.forgerock.util.promise.Promise<ResourceResponse,ResourceException> filterUpdate(org.forgerock.services.context.Context context,
                                                                                           UpdateRequest request,
                                                                                           RequestHandler next)

Description copied from interface: Filter

Filters an update request.

Parameters:

context - The filter chain context.

request - The update request.

next - A request handler representing the remainder of the filter chain.

Returns:

A Promise containing the result of the operation.