com.nimbusds.oauth2.sdk

Class ResourceOwnerPasswordCredentialsGrant

java.lang.Object

com.nimbusds.oauth2.sdk.AuthorizationGrant

com.nimbusds.oauth2.sdk.ResourceOwnerPasswordCredentialsGrant

@Immutable
public class ResourceOwnerPasswordCredentialsGrant
extends AuthorizationGrant

Resource owner password credentials grant. Used in access token requests with the resource owner's username and password. This class is immutable.

Related specifications:

• OAuth 2.0 (RFC 6749), section 4.3.2.

Author:

Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field and Description
static GrantType	GRANT_TYPE The associated grant type.

Constructor Summary

Constructors

Constructor and Description
ResourceOwnerPasswordCredentialsGrant(String username, Secret password, Scope scope) Creates a new resource owner password credentials grant.

Method Summary

Methods

Modifier and Type	Method and Description
Secret	getPassword() Gets the resource owner's password.
Scope	getScope() Gets the requested scope.
String	getUsername() Gets the resource owner's username.
static ResourceOwnerPasswordCredentialsGrant	parse(Map<String,String> params) Parses a resource owner password credentials grant from the specified parameters.
Map<String,String>	toParameters() Return the parameters for the authorisation grant.

Methods inherited from class com.nimbusds.oauth2.sdk.AuthorizationGrant

getType

Methods inherited from class java.lang.Object

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

Field Detail

GRANT_TYPE

public static final GrantType GRANT_TYPE

The associated grant type.

Constructor Detail

ResourceOwnerPasswordCredentialsGrant

public ResourceOwnerPasswordCredentialsGrant(String username,
                                     Secret password,
                                     Scope scope)

Creates a new resource owner password credentials grant.

Parameters:

username - The resource owner's username. Must not be null.

password - The resource owner's password. Must not be null.

scope - The requested scope, null if not specified.

Method Detail

getUsername

public String getUsername()

Gets the resource owner's username.

Returns:

The username.

getPassword

public Secret getPassword()

Gets the resource owner's password.

Returns:

The password.

getScope

public Scope getScope()

Gets the requested scope.

Returns:

The requested scope.

toParameters

public Map<String,String> toParameters()

Description copied from class: AuthorizationGrant

Return the parameters for the authorisation grant.

Specified by:

toParameters in class AuthorizationGrant

Returns:

The parameters.

parse

public static ResourceOwnerPasswordCredentialsGrant parse(Map<String,String> params)
                                                   throws ParseException

Parses a resource owner password credentials grant from the specified parameters.

Example:

 grant_type=password
 username=johndoe
 password=A3ddj3w
 

Parameters:

params - The parameters.

Returns:

The resource owner password credentials grant.

Throws:

ParseException - If parsing failed.