com.nimbusds.oauth2.sdk

Class RefreshTokenGrant

java.lang.Object

com.nimbusds.oauth2.sdk.AuthorizationGrant

com.nimbusds.oauth2.sdk.RefreshTokenGrant

@Immutable
public final class RefreshTokenGrant
extends AuthorizationGrant

Refresh token grant. Used in refresh token requests. This class is immutable.

Note that the optional scope parameter is not supported.

Related specifications:

• OAuth 2.0 (RFC 6749), section 6.

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
RefreshTokenGrant(RefreshToken refreshToken) Creates a new refresh token grant.

Method Summary

Methods

Modifier and Type	Method and Description
RefreshToken	getRefreshToken() Gets the refresh token.
static RefreshTokenGrant	parse(Map<String,String> params) Parses a refresh token 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

RefreshTokenGrant

public RefreshTokenGrant(RefreshToken refreshToken)

Creates a new refresh token grant.

Parameters:

refreshToken - The refresh token. Must not be null.

Method Detail

getRefreshToken

public RefreshToken getRefreshToken()

Gets the refresh token.

Returns:

The refresh token.

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 RefreshTokenGrant parse(Map<String,String> params)
                               throws ParseException

Parses a refresh token grant from the specified parameters.

Example:

 grant_type=refresh_token
 refresh_token=tGzv3JOkF0XG5Qx2TlKWIA
 

Parameters:

params - The parameters.

Returns:

The refresh token grant.

Throws:

ParseException - If parsing failed.