Package org.forgerock.http.oauth2

Class ClientSecretPostAuthenticationFilter

java.lang.Object

org.forgerock.http.oauth2.ClientSecretPostAuthenticationFilter

All Implemented Interfaces:

Filter

public class ClientSecretPostAuthenticationFilter
extends Object
implements Filter

A Filter implementation to add the credentials to request body for authenticating as per the OAuth 2.0 Authorization Framework specification.

Constructor Summary

Constructors

Constructor	Description
ClientSecretPostAuthenticationFilter(String clientId, SecretReference<GenericSecret> secretReference)	Deprecated, for removal: This API element is subject to removal in a future version. Use ClientSecretPostAuthenticationFilter(CredentialPair) instead.
ClientSecretPostAuthenticationFilter(CredentialPair<GenericSecret> credentials)	Creates a filter that will add the client credentials to the request body.

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

ClientSecretPostAuthenticationFilter

@Deprecated(since="26.6.0",
            forRemoval=true)
public ClientSecretPostAuthenticationFilter(String clientId,
 SecretReference<GenericSecret> secretReference)

Deprecated, for removal: This API element is subject to removal in a future version.

Use ClientSecretPostAuthenticationFilter(CredentialPair) instead.

Creates an instance of this class.

Parameters:

clientId - The client id to use for the credentials.

secretReference - Reference to the client secret to use for the credentials.

ClientSecretPostAuthenticationFilter

public ClientSecretPostAuthenticationFilter(CredentialPair<GenericSecret> credentials)

Creates a filter that will add the client credentials to the request body.

Parameters:

credentials - The client credentials.

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.