public class ResourceApiVersionRoutingFilter extends Object 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.Constructor and Description |
---|
ResourceApiVersionRoutingFilter(ResourceApiVersionBehaviourManager behaviourManager)
Constructs a new
ResourceApiVersionRoutingFilter instance. |
Modifier and Type | Method and 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.
|
public ResourceApiVersionRoutingFilter(ResourceApiVersionBehaviourManager behaviourManager)
ResourceApiVersionRoutingFilter
instance.behaviourManager
- The ResourceApiVersionBehaviourManager
instance
that manages the API Version routing settings.public Promise<Response,NeverThrowsException> filter(Context context, Request request, Handler next)
Filter
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.
protected ApiVersionRouterContext createApiVersionRouterContext(Context context)
ApiVersionRouterContext
using the default version
behaviour and whether to issue warnings from the
behaviourManager instance.context
- The parent context.ApiVersionRouterContext
.Copyright © 2010-2018, ForgeRock All Rights Reserved.