javastrava.api.v3.auth

Class TokenManager

java.lang.Object

javastrava.api.v3.auth.TokenManager

public class TokenManager
extends Object

Manages the caching of tokens

Author:

Dan Shannon

Method Summary

Modifier and Type	Method and Description
void	clearTokenCache() Removes all tokens from the cache
static TokenManager	instance()
Token	retrieveTokenWithExactScope(String username, AuthorisationScope... requiredScopes) Retrieve a cached token which has exactly the given set of scopes
Token	retrieveTokenWithExactScope(String username, List<AuthorisationScope> scopes) Retrieve a cached token which has exactly the given set of scopes
Token	retrieveTokenWithScope(String username, AuthorisationScope... scopes) Retrieve a token which has at least the given set of scopes.
Token	retrieveTokenWithScope(String username, List<AuthorisationScope> scopes) Retrieve a token which has at least the given set of scopes.
void	revokeToken(Token token) Revoke an access token - that is, remove it from the cache of tokens.
void	storeToken(Token token) Place a token in the cache

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static TokenManager instance()

Returns:

Singleton instance of the TokenManager

clearTokenCache

public void clearTokenCache()

Removes all tokens from the cache

retrieveTokenWithExactScope

public Token retrieveTokenWithExactScope(String username,
                                         AuthorisationScope... requiredScopes)

Retrieve a cached token which has exactly the given set of scopes

Parameters:

username - The username

requiredScopes - This list of scopes which must match the scopes of the token

Returns:

The token with the matching list of scopes, or null if there is no such token

retrieveTokenWithExactScope

public Token retrieveTokenWithExactScope(String username,
                                         List<AuthorisationScope> scopes)

Retrieve a cached token which has exactly the given set of scopes

Parameters:

username - The user to look up for a cached token

scopes - The set of scopes the token must have

Returns:

The matching token from the cache, or null if there is no matching token

retrieveTokenWithScope

public Token retrieveTokenWithScope(String username,
                                    AuthorisationScope... scopes)

Retrieve a token which has at least the given set of scopes.

Parameters:

username - The username

scopes - The list of scopes which are required to be in the token

Returns:

The token, or null if there is no cached token, or the cached token doesn't have all the required scopes

retrieveTokenWithScope

public Token retrieveTokenWithScope(String username,
                                    List<AuthorisationScope> scopes)

Retrieve a token which has at least the given set of scopes.

Parameters:

username - The username

scopes - The list of scopes which are required to be in the token

Returns:

The token, or null if there is no cached token, or the cached token doesn't have all the required scopes

revokeToken

public void revokeToken(Token token)

Revoke an access token - that is, remove it from the cache of tokens.

Parameters:

token - The token to be removed from the cache

storeToken

public void storeToken(Token token)

Place a token in the cache

Parameters:

token - The token to be stored in the cache.

Throws:

IllegalArgumentException - If the token is null, or the athlete contained in it is null or has a null email, or there are no authorisation scopes, then