javastrava.api.v3.auth.model

Class Token

java.lang.Object

javastrava.api.v3.auth.model.Token

public class Token
extends Object

The token acts as the bearer of authentication within each request to the Strava API.

A token is used to acquire an implementation of each of the service objects that sub-class StravaServiceImpl

Tokens are acquired through the OAuth process; this implementation of the API does not provide a purely programmatic way to acquire a token as that would kind of destroy the point(!) - although once a user has given their permission to the application via the OAuth process, you can use AuthorisationService.tokenExchange(Integer, String, String, AuthorisationScope...) to acquire a token at that point in the process.

The application will now be able to make requests on the user’s behalf using the access_token query string parameter (GET) or POST/PUT body, or the Authorization header. This is done auto-magically by javastrava.

Applications should check for a 401 Unauthorized response. Access for those tokens has been revoked by the user.

Author:

Dan Shannon

See Also:

http://strava.github.io/api/v3/oauth/

Constructor Summary

Constructors

Constructor and Description
Token() No-args constructor
Token(TokenResponse tokenResponse, AuthorisationScope... scopes) Default constructor is based on the TokenResponse structure received from AuthorisationService.tokenExchange(Integer, String, String, AuthorisationScope...)

Method Summary

Modifier and Type	Method and Description
void	addService(Class<? extends StravaService> class1, StravaService service) Adds a service implementation into the Token's store
boolean	equals(Object obj)
StravaAthlete	getAthlete()
List<AuthorisationScope>	getScopes()
<T extends StravaService> T	getService(Class<T> class1) Gets the service implementation of the required class from the token
HashMap<Class<? extends StravaService>,StravaService>	getServices()
String	getToken()
String	getTokenType()
int	hashCode()
boolean	hasViewPrivate() Validates that the toke has view private access (according to the scopes that it was granted on creation at least; it is quite possible that permissions have subsequently been revoked by the user)
boolean	hasWriteAccess() Validates that the token has write access (according to the scopes that it was granted on creation at least; it is quite possible that permissions have subsequently been revoked by the user)
void	removeService(Class<? extends StravaService> class1) Removes the service from the Token's store
void	setAthlete(StravaAthlete athlete)
void	setScopes(List<AuthorisationScope> scopes)
void	setServices(HashMap<Class<? extends StravaService>,StravaService> services)
void	setToken(String token)
void	setTokenType(String tokenType)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Token

public Token()

No-args constructor

Token

public Token(TokenResponse tokenResponse,
             AuthorisationScope... scopes)

Default constructor is based on the TokenResponse structure received from AuthorisationService.tokenExchange(Integer, String, String, AuthorisationScope...)

Parameters:

tokenResponse - The response as received from AuthorisationService.tokenExchange(Integer, String, String, AuthorisationScope...)

scopes - The list of authorisation scopes to be associated with the token

Method Detail

addService

public void addService(Class<? extends StravaService> class1,
                       StravaService service)

Adds a service implementation into the Token's store

Parameters:

class1 - The class of the service implementation

service - The service implementation

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

getAthlete

public StravaAthlete getAthlete()

Returns:

the athlete

getScopes

public List<AuthorisationScope> getScopes()

Returns:

the scopes

getService

public <T extends StravaService> T getService(Class<T> class1)

Gets the service implementation of the required class from the token

Type Parameters:

T - The class being returned

Parameters:

class1 - The class to return

Returns:

The implementation of the service required

getServices

public HashMap<Class<? extends StravaService>,StravaService> getServices()

Returns:

the services

getToken

public String getToken()

Returns:

the token

getTokenType

public String getTokenType()

Returns:

the tokenType

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

hasViewPrivate

public boolean hasViewPrivate()

Validates that the toke has view private access (according to the scopes that it was granted on creation at least; it is quite possible that permissions have subsequently been revoked by the user)

Returns:

true if the token contains the AuthorisationScope.VIEW_PRIVATE

hasWriteAccess

public boolean hasWriteAccess()

Validates that the token has write access (according to the scopes that it was granted on creation at least; it is quite possible that permissions have subsequently been revoked by the user)

Returns:

true if the token contains the AuthorisationScope.WRITE

removeService

public void removeService(Class<? extends StravaService> class1)

Removes the service from the Token's store

Parameters:

class1 - The class of token to be removed

setAthlete

public void setAthlete(StravaAthlete athlete)

Parameters:

athlete - the athlete to set

setScopes

public void setScopes(List<AuthorisationScope> scopes)

Parameters:

scopes - the scopes to set

setServices

public void setServices(HashMap<Class<? extends StravaService>,StravaService> services)

Parameters:

services - the services to set

setToken

public void setToken(String token)

Parameters:

token - the token to set

setTokenType

public void setTokenType(String tokenType)

Parameters:

tokenType - the tokenType to set

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()