org.springframework.security.oauth2.common
Interface OAuth2AccessToken

All Known Implementing Classes:
DefaultOAuth2AccessToken

public interface OAuth2AccessToken

Author:
Dave Syer

Field Summary
static String ACCESS_TOKEN
          The access token issued by the authorization server.
static String BEARER_TYPE
           
static String EXPIRES_IN
          The lifetime in seconds of the access token.
static String OAUTH2_TYPE
           
static String REFRESH_TOKEN
          The refresh token which can be used to obtain new access tokens using the same authorization grant as described in Section 6.
static String SCOPE
          The scope of the access token as described by Section 3.3
static String TOKEN_TYPE
          The type of the token issued as described in Section 7.1.
 
Method Summary
 Map<String,Object> getAdditionalInformation()
          The additionalInformation map is used by the token serializers to export any fields used by extensions of OAuth.
 Date getExpiration()
           
 int getExpiresIn()
           
 OAuth2RefreshToken getRefreshToken()
           
 Set<String> getScope()
           
 String getTokenType()
           
 String getValue()
           
 boolean isExpired()
           
 

Field Detail

BEARER_TYPE

static final String BEARER_TYPE
See Also:
Constant Field Values

OAUTH2_TYPE

static final String OAUTH2_TYPE
See Also:
Constant Field Values

ACCESS_TOKEN

static final String ACCESS_TOKEN
The access token issued by the authorization server. This value is REQUIRED.

See Also:
Constant Field Values

TOKEN_TYPE

static final String TOKEN_TYPE
The type of the token issued as described in Section 7.1. Value is case insensitive. This value is REQUIRED.

See Also:
Constant Field Values

EXPIRES_IN

static final String EXPIRES_IN
The lifetime in seconds of the access token. For example, the value "3600" denotes that the access token will expire in one hour from the time the response was generated. This value is OPTIONAL.

See Also:
Constant Field Values

REFRESH_TOKEN

static final String REFRESH_TOKEN
The refresh token which can be used to obtain new access tokens using the same authorization grant as described in Section 6. This value is OPTIONAL.

See Also:
Constant Field Values

SCOPE

static final String SCOPE
The scope of the access token as described by Section 3.3

See Also:
Constant Field Values
Method Detail

getAdditionalInformation

Map<String,Object> getAdditionalInformation()
The additionalInformation map is used by the token serializers to export any fields used by extensions of OAuth.

Returns:
a map from the field name in the serialized token to the value to be exported. The default serializers make use of Jackson's automatic JSON mapping for Java objects (for the Token Endpoint flows) or implicitly call .toString() on the "value" object (for the implicit flow) as part of the serialization process.

getScope

Set<String> getScope()

getRefreshToken

OAuth2RefreshToken getRefreshToken()

getTokenType

String getTokenType()

isExpired

boolean isExpired()

getExpiration

Date getExpiration()

getExpiresIn

int getExpiresIn()

getValue

String getValue()


Copyright © 2012. All Rights Reserved.