javastrava.api.v3.service.impl

Class GearServiceImpl

java.lang.Object

javastrava.api.v3.service.impl.StravaServiceImpl

javastrava.api.v3.service.impl.GearServiceImpl

All Implemented Interfaces:

GearService, StravaService

public class GearServiceImpl
extends StravaServiceImpl
implements GearService

Implementation of ClubService

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
StravaGear	getGear(String gearId) Retrieve details about a specific item of StravaGear.
CompletableFuture<StravaGear>	getGearAsync(String gearId) Retrieve details about a specific item of StravaGear.
static GearService	instance(Token token) Returns an instance of gear 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 GearService instance(Token token)

Returns an instance of gear 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 club 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()

getGear

public StravaGear getGear(String gearId)

Description copied from interface: GearService

Retrieve details about a specific item of StravaGear. The requesting StravaAthlete must own the StravaGear. At this time it is not possible to view just anyone's gear type and usage.

Returns null if club with the given id does not exist

URL GET https://www.strava.com/api/v3/gear/:id

Specified by:

getGear in interface GearService

Parameters:

gearId - The id of the StravaGear to be retrieved.

Returns:

Returns a detailed StravaGear representation.

See Also:

GearService.getGear(java.lang.String)

getGearAsync

public CompletableFuture<StravaGear> getGearAsync(String gearId)

Description copied from interface: GearService

Retrieve details about a specific item of StravaGear. The requesting StravaAthlete must own the StravaGear. At this time it is not possible to view just anyone's gear type and usage.

Returns null if club with the given id does not exist

URL GET https://www.strava.com/api/v3/gear/:id

Specified by:

getGearAsync in interface GearService

Parameters:

gearId - The id of the StravaGear to be retrieved.

Returns:

Returns a detailed StravaGear representation.

See Also:

GearService.getGearAsync(java.lang.String)