com.nimbusds.oauth2.sdk

Class RefreshTokenRequest

java.lang.Object

com.nimbusds.oauth2.sdk.AbstractRequest

com.nimbusds.oauth2.sdk.TokenRequest

com.nimbusds.oauth2.sdk.RefreshTokenRequest

All Implemented Interfaces:

Message, Request

@Immutable
public final class RefreshTokenRequest
extends TokenRequest

Refresh token request to the Token endpoint. Used to refresh an access token. This class is immutable.

Note that the optional scope parameter is not supported.

Example refresh token request:

 POST /token HTTP/1.1
 Host: server.example.com
 Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW
 Content-Type: application/x-www-form-urlencoded;charset=UTF-8

 grant_type=refresh_token&refresh_token=tGzv3JOkF0XG5Qx2TlKWIA
 

Related specifications:

• OAuth 2.0 (RFC 6749), section 6.

Author:

Vladimir Dzhuvinov

Constructor Summary

Constructors

Constructor and Description
RefreshTokenRequest(URL uri, RefreshToken refreshToken) Creates a new unauthenticated refresh token request.
RefreshTokenRequest(URL uri, RefreshToken refreshToken, ClientAuthentication clientAuth) Creates a new authenticated refresh token request.

Method Summary

Methods

Modifier and Type	Method and Description
RefreshToken	getRefreshToken() Gets the refresh token.
static RefreshTokenRequest	parse(HTTPRequest httpRequest) Parses the specified HTTP request for a refresh token request.
HTTPRequest	toHTTPRequest() Returns the matching HTTP request.

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

getClientAuthentication, getGrantType

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

getURI

Methods inherited from class java.lang.Object

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

Constructor Detail

RefreshTokenRequest

public RefreshTokenRequest(URL uri,
                   RefreshToken refreshToken)

Creates a new unauthenticated refresh token request.

Parameters:

uri - The URI of the token endpoint. May be null if the toHTTPRequest() method will not be used.

refreshToken - The refresh token. Must not be null.

RefreshTokenRequest

public RefreshTokenRequest(URL uri,
                   RefreshToken refreshToken,
                   ClientAuthentication clientAuth)

Creates a new authenticated refresh token request.

Parameters:

uri - The URI of the token endpoint. May be null if the toHTTPRequest() method will not be used.

refreshToken - The refresh token. Must not be null.

clientAuth - The client authentication, null if none.

Method Detail

getRefreshToken

public RefreshToken getRefreshToken()

Gets the refresh token.

Returns:

The refresh token.

toHTTPRequest

public HTTPRequest toHTTPRequest()
                          throws SerializeException

Description copied from interface: Request

Returns the matching HTTP request.

Returns:

The HTTP request.

Throws:

SerializeException - If the request message couldn't be serialised to an HTTP request.

parse

public static RefreshTokenRequest parse(HTTPRequest httpRequest)
                                 throws ParseException

Parses the specified HTTP request for a refresh token request.

Parameters:

httpRequest - The HTTP request. Must not be null.

Returns:

The refresh token request.

Throws:

ParseException - If the HTTP request couldn't be parsed to a refresh token request.