net.oauth2

Class AccessToken

java.lang.Object

net.oauth2.AccessToken

All Implemented Interfaces:

ParametersMap

public class AccessToken
extends Object
implements ParametersMap

A Java object model binding for the standard OAuth 2 access token format. https://tools.ietf.org/html/rfc6749#section-4.1.4

Constructor Summary

Constructors

Constructor and Description
AccessToken(Map<String,Object> map) Initialize from map of properties such as "access_token" and "expires_in".
AccessToken(String accessToken, String tokenType, long expiresIn, String refreshToken, Collection<String> scopes) Initializes an oauth token object from standard properties.

Method Summary

Modifier and Type	Method and Description
String	getAccessToken() Returns the "access_token" string in this oauth token.
long	getExpiresIn() Returns the "expires_in" number in this access token.
protected static Map<String,String>	getPropertyMap() Maps Bean introspection property descriptors name to OAuth2 valid payload property names.
String	getRefreshToken() Returns the "refresh_token" string in this oauth token.
Collection<String>	getScopes() Returns the "scope" in this oauth token, modeled as collection of scope strings.
String	getTokenType() Returns the "token_type" string in this oauth token.
boolean	hasScope(String scope) Checks if scope is one of the configured scopes for this access token.
Map<String,Object>	map() Returns the properties of this token object as map.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessToken

public AccessToken(String accessToken,
                   String tokenType,
                   long expiresIn,
                   String refreshToken,
                   Collection<String> scopes)

Initializes an oauth token object from standard properties.

Parameters:

accessToken - the "access_token" string.

tokenType - the "token_type" string. Defaults to "Bearer".

expiresIn - the "expires_in" integer number for seconds until expire.

refreshToken - the "refresh_token" string.

scopes - the token "scope" as a collection of scope strings

AccessToken

public AccessToken(Map<String,Object> map)

Initialize from map of properties such as "access_token" and "expires_in".

Parameters:

map -

Method Detail

getTokenType

public final String getTokenType()

Returns the "token_type" string in this oauth token.

getRefreshToken

public final String getRefreshToken()

Returns the "refresh_token" string in this oauth token.

getScopes

public final Collection<String> getScopes()

Returns the "scope" in this oauth token, modeled as collection of scope strings.

getAccessToken

public final String getAccessToken()

Returns the "access_token" string in this oauth token.

getExpiresIn

public final long getExpiresIn()

Returns the "expires_in" number in this access token. This models the duration of time the access token is granted for, if the access token expires.

hasScope

public boolean hasScope(String scope)

Checks if scope is one of the configured scopes for this access token.

Parameters:

scope -

Returns:

true if the scope is assigned to this token, false otherwise

toString

public String toString()

Overrides:

toString in class Object

getPropertyMap

protected static Map<String,String> getPropertyMap()

Maps Bean introspection property descriptors name to OAuth2 valid payload property names.

Returns:

map

public Map<String,Object> map()
                       throws Exception

Returns the properties of this token object as map.

Specified by:

map in interface ParametersMap

Throws:

Exception