Package org.forgerock.openig.fapi.resource.grantype

Class GrantTypeVerifierFilter

java.lang.Object

org.forgerock.openig.fapi.resource.grantype.GrantTypeVerifierFilter

All Implemented Interfaces:

Filter

public class GrantTypeVerifierFilter
extends Object
implements Filter

Verify grant_type of request on Request server is either authorization_code or refresh_token.

This type of grant_type is used within the OAuth 2.0 framework to obtain an access token, particularly in contexts where enhanced security is required, such as in financial services (FAPI).

This filters requires OAuth2Context to have been created by a prior filter, for example, from OAuth2ResourceServerFilter.

Constructor Summary

Constructors

Constructor	Description
GrantTypeVerifierFilter(String allowedGrandType)	Build a GrantTypeVerifierFilter with the provided allowed grant_type.

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

GrantTypeVerifierFilter

public GrantTypeVerifierFilter(String allowedGrandType)

Build a GrantTypeVerifierFilter with the provided allowed grant_type.

Parameters:

allowedGrandType - the grant_type to allow

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.