Package org.forgerock.openig.tools

Class ApiVersionProtocolHeaderFilter

java.lang.Object

org.forgerock.openig.tools.ApiVersionProtocolHeaderFilter

All Implemented Interfaces:

Filter

public class ApiVersionProtocolHeaderFilter
extends Object
implements Filter

This filter overrides the protocol version in Accept-Api-Version header. The protocol versions supported in OPENAM-13 is 1.0 and CREST adapter forces to 2.0, throwing a 'Unsupported major version: 2.0' exception if not set.

Constructor Summary

Constructors

Constructor	Description
ApiVersionProtocolHeaderFilter(Version protocolVersion)	Creates a new ApiVersionProtocolHeaderFilter.

Method Summary

Modifier and Type	Method	Description
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

ApiVersionProtocolHeaderFilter

public ApiVersionProtocolHeaderFilter(Version protocolVersion)

Creates a new ApiVersionProtocolHeaderFilter.

Parameters:

protocolVersion - The protocol version, not null.

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.