javastrava.api.v3.auth.impl.retrofit

Class TokenServiceImpl

java.lang.Object

javastrava.api.v3.service.impl.StravaServiceImpl

javastrava.api.v3.auth.impl.retrofit.TokenServiceImpl

All Implemented Interfaces:

TokenService, StravaService

public class TokenServiceImpl
extends StravaServiceImpl
implements TokenService

Author:

Dan Shannon

Field Summary

Fields inherited from class javastrava.api.v3.service.impl.StravaServiceImpl

api, requestRate, requestRateDaily

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clear any and all cached data entries
TokenResponse	deauthorise(Token token) Allows an application to revoke its access to an athlete's data.
static TokenService	instance(Token token) Returns an instance of token services

Methods inherited from class javastrava.api.v3.service.impl.StravaServiceImpl

accessTokenIsValid, future, getToken, requestRateDailyPercentage, requestRatePercentage

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static TokenService instance(Token token)
                             throws UnauthorizedException

Returns an instance of token services

Instances are cached so that if 2 requests are made for the same token, the same instance is returned

Parameters:

token - The Strava access token to be used in requests to the Strava API

Returns:

An instance of the token services

Throws:

UnauthorizedException - If the token used to create the service is invalid

clearCache

public void clearCache()

Description copied from interface: StravaService

Clear any and all cached data entries

Primarily used when revoking/deauthorising a token so that there are no entries remaining that are associated with the token that could mistakenly get returned

Specified by:

clearCache in interface StravaService

See Also:

StravaService.clearCache()

deauthorise

public TokenResponse deauthorise(Token token)
                          throws UnauthorizedException

Description copied from interface: TokenService

Allows an application to revoke its access to an athlete's data.

This will invalidate all access tokens associated with the athlete, application pair used to create the token. The application will be removed from the StravaAthlete Settings page on Strava.

All requests made using invalidated tokens will receive a 401 Unauthorised response.

URL POST https://www.strava.com/oauth/deauthorize

Specified by:

deauthorise in interface TokenService

Parameters:

token - The access token for which the application is revoking its access.

Returns:

Responds with the access token submitted with the request.

Throws:

UnauthorizedException - if the token is not allowed to be deauthorised

See Also:

TokenService.deauthorise(Token)