Package org.forgerock.secrets.oauth2

Class ResourceOwnerPasswordGrantTypeHandler

java.lang.Object

org.forgerock.secrets.oauth2.GrantTypeHandler

org.forgerock.secrets.oauth2.ResourceOwnerPasswordGrantTypeHandler

public class ResourceOwnerPasswordGrantTypeHandler
extends GrantTypeHandler

A grant type handler that can obtain an access token using the Resource Owner Password Credentials (ROPC) grant. While this grant type should generally not be used for users, it can be quite useful for use with service accounts.

Constructor Summary

Constructors

Constructor	Description
ResourceOwnerPasswordGrantTypeHandler(String clientId, String username, SecretReference<GenericSecret> password)	Initialises the grant type handler with the given credentials and the default scope for this client.
ResourceOwnerPasswordGrantTypeHandler(String clientId, String username, SecretReference<GenericSecret> password, Collection<String> scope)	Initialises the grant type handler with the given credentials.

Method Summary

Modifier and Type	Method	Description
protected Promise<Form,NoSuchSecretException>	handle(Request tokenEndpointRequest, Form form)	Handles the request by adding appropriate parameters to the OAuth 2.0 token endpoint request.

Methods inherited from class org.forgerock.secrets.oauth2.GrantTypeHandler

getClientId, getGrantType, getScope, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceOwnerPasswordGrantTypeHandler

public ResourceOwnerPasswordGrantTypeHandler(String clientId,
                                             String username,
                                             SecretReference<GenericSecret> password,
                                             Collection<String> scope)

Initialises the grant type handler with the given credentials.

Parameters:

clientId - the client id of the client requesting an access token.

username - the username of the resource owner.

password - a SecretReference to retrieve the password for the resource owner.

scope - the scope of the request. May be null to request default scopes for this client.

ResourceOwnerPasswordGrantTypeHandler

public ResourceOwnerPasswordGrantTypeHandler(String clientId,
                                             String username,
                                             SecretReference<GenericSecret> password)

Initialises the grant type handler with the given credentials and the default scope for this client.

Parameters:

clientId - the client id of the client requesting an access token.

username - the username of the resource owner.

password - a SecretReference to retrieve the password for the resource owner.

Method Detail

handle

protected Promise<Form,NoSuchSecretException> handle(Request tokenEndpointRequest,
                                                           Form form)

Description copied from class: GrantTypeHandler

Handles the request by adding appropriate parameters to the OAuth 2.0 token endpoint request.

Overrides:

handle in class GrantTypeHandler

Parameters:

tokenEndpointRequest - the original token endpoint request.

form - the POST body to add parameters to.

Returns:

a promise for the token endpoint request with parameters appropriate for this grant type.