Package org.forgerock.http.routing

Class ResourceApiVersionRoutingFilter

java.lang.Object

org.forgerock.http.routing.ResourceApiVersionRoutingFilter

All Implemented Interfaces:

Filter

Direct Known Subclasses:

ResourceApiVersionRoutingFilter

public class ResourceApiVersionRoutingFilter
extends Object
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.

Constructor Summary

Constructors

Constructor	Description
ResourceApiVersionRoutingFilter(ResourceApiVersionBehaviourManager behaviourManager)	Constructs a new ResourceApiVersionRoutingFilter instance.

Method Summary

Modifier and Type	Method	Description
protected ApiVersionRouterContext	createApiVersionRouterContext(Context context)	Creates a ApiVersionRouterContext using the default version behaviour and whether to issue warnings from the behaviourManager instance.
Promise<Response,NeverThrowsException>	filter(Context context, Request request, Handler next)	Filters the request and/or response of an exchange.

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceApiVersionRoutingFilter

public ResourceApiVersionRoutingFilter(ResourceApiVersionBehaviourManager behaviourManager)

Constructs a new ResourceApiVersionRoutingFilter instance.

Parameters:

behaviourManager - The ResourceApiVersionBehaviourManager instance that manages the API Version routing settings.

Method Details

filter

public Promise<Response,NeverThrowsException> filter(Context context,
 Request request,
 Handler next)

Description copied from interface: Filter

Filters the request and/or response of an exchange. To pass the request to the next filter or handler in the chain, the filter calls next.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 interface Filter

Parameters:

context - The request context.

request - The request.

next - The next filter or handler in the chain to handle the request.

Returns:

A Promise representing the response to be returned to the client.

createApiVersionRouterContext

protected ApiVersionRouterContext createApiVersionRouterContext(Context context)

Creates a ApiVersionRouterContext using the default version behaviour and whether to issue warnings from the behaviourManager instance.

Parameters:

context - The parent context.

Returns:

A new ApiVersionRouterContext.