javastrava.api.v3.service.impl

Class ClubServiceImpl

java.lang.Object

javastrava.api.v3.service.impl.StravaServiceImpl<ClubAPI>

javastrava.api.v3.service.impl.ClubServiceImpl

All Implemented Interfaces:

ClubService, StravaService

public class ClubServiceImpl
extends StravaServiceImpl<ClubAPI>
implements ClubService

Implementation of ClubService

Author:

Dan Shannon

Field Summary

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

requestRate, requestRateDaily, restService

Method Summary

Modifier and Type	Method and Description
StravaClub	getClub(Integer id) Retrieve details about a specific club.
static ClubService	instance(Token token) Returns an instance of club services
StravaClubMembershipResponse	joinClub(Integer id) Join a club on behalf of the authenticated user.
StravaClubMembershipResponse	leaveClub(Integer id) Leave a club on behalf of the authenticated user.
List<StravaAthlete>	listAllClubMembers(Integer clubId) Convenience method for returning ALL of the members of a club
List<StravaActivity>	listAllRecentClubActivities(Integer clubId) Retrieve ALL the recent activities performed by member athletes of a specific club.
List<StravaClub>	listAuthenticatedAthleteClubs() Fetch an array of clubs that the currently authenticated athlete is a member of.
List<StravaAthlete>	listClubMembers(Integer id) Retrieve summary information about member athletes of a specific club.
List<StravaAthlete>	listClubMembers(Integer id, Paging pagingInstruction) Retrieve summary information about member athletes of a specific club.
List<StravaActivity>	listRecentClubActivities(Integer id) Retrieve the recent activities performed by member athletes of a specific club.
List<StravaActivity>	listRecentClubActivities(Integer id, Paging pagingInstruction) Retrieve the recent activities performed by member athletes of a specific club.

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

accessTokenIsValid, 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 ClubService instance(Token token)

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

getClub

public StravaClub getClub(Integer id)

Description copied from interface: ClubService

Retrieve details about a specific club. The club must be public or the current athlete must be a member.

Returns null if club with the given id does not exist

Returns an empty club (with only the id set) if the club is private and the authenticated athlete is not a member

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

Specified by:

getClub in interface ClubService

Parameters:

id - The id of the StravaClub to be retrieved

Returns:

Returns a detailed club representation.

See Also:

ClubService.getClub(java.lang.Integer)

listAuthenticatedAthleteClubs

public List<StravaClub> listAuthenticatedAthleteClubs()

Description copied from interface: ClubService

Fetch an array of clubs that the currently authenticated athlete is a member of.

Pagination is not supported. Returns all clubs of which the athlete is a member.

URL GET https://www.strava.com/api/v3/athlete/clubs

Specified by:

listAuthenticatedAthleteClubs in interface ClubService

Returns:

Returns a list of club summary representations.

See Also:

ClubService.listAuthenticatedAthleteClubs()

listClubMembers

public List<StravaAthlete> listClubMembers(Integer id,
                                           Paging pagingInstruction)

Description copied from interface: ClubService

Retrieve summary information about member athletes of a specific club.

Pagination is supported.

Returns null if club with the given id does not exist

Returns an empty list if the club is private

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

Specified by:

listClubMembers in interface ClubService

Parameters:

id - The id of the StravaClub whose member athletes should be returned

pagingInstruction - (Optional) The page to be returned

Returns:

Returns an array of athlete summary representations.

See Also:

ClubService.listClubMembers(Integer, Paging)

listRecentClubActivities

public List<StravaActivity> listRecentClubActivities(Integer id,
                                                     Paging pagingInstruction)

Description copied from interface: ClubService

Retrieve the recent activities performed by member athletes of a specific club.

The authenticated athlete must be a member of the club.

Returns null if club with the given id does not exist

Returns an empty list if the authorised athlete is not a member of the club

Pagination is supported. However, the results are limited to the last 200 total activities by club members.

Specified by:

listRecentClubActivities in interface ClubService

Parameters:

id - The id of the StravaClub for which recent activities are to be returned.

pagingInstruction - (Optional) The page to be returned

Returns:

Returns an array of activity summary representations.

See Also:

ClubService.listRecentClubActivities(Integer, Paging)

joinClub

public StravaClubMembershipResponse joinClub(Integer id)

Description copied from interface: ClubService

Join a club on behalf of the authenticated user. An access token with write permissions is required.

Specified by:

joinClub in interface ClubService

Parameters:

id - ID of the StravaClub to join

Returns:

Response detailing whether request was successful and whether the member is active

See Also:

ClubService.joinClub(java.lang.Integer)

leaveClub

public StravaClubMembershipResponse leaveClub(Integer id)

Description copied from interface: ClubService

Leave a club on behalf of the authenticated user. An access token with write permissions is required.

Specified by:

leaveClub in interface ClubService

Parameters:

id - ID of the club to join

Returns:

Response detailing whether request was successful and whether the member is active

See Also:

ClubService.leaveClub(java.lang.Integer)

listClubMembers

public List<StravaAthlete> listClubMembers(Integer id)

Description copied from interface: ClubService

Retrieve summary information about member athletes of a specific club.

Pagination is not supported. Returns only the first page of members.

Returns null if club with the given id does not exist

Returns an empty list if the club is private

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

Specified by:

listClubMembers in interface ClubService

Parameters:

id - The id of the StravaClub whose member athletes should be returned

Returns:

Returns an array of athlete summary representations.

See Also:

ClubService.listClubMembers(java.lang.Integer)

listRecentClubActivities

public List<StravaActivity> listRecentClubActivities(Integer id)

Description copied from interface: ClubService

Retrieve the recent activities performed by member athletes of a specific club.

The authenticated athlete must be a member of the club.

Pagination is NOT supported. Returns only the first page of activities.

Returns null if club with the given id does not exist

Returns an empty list if the authorised athlete is not a member of the club

Specified by:

listRecentClubActivities in interface ClubService

Parameters:

id - The id of the StravaClub for which recent activities are to be returned.

Returns:

Returns an array of activity summary representations.

See Also:

ClubService.listRecentClubActivities(java.lang.Integer)

listAllClubMembers

public List<StravaAthlete> listAllClubMembers(Integer clubId)

Description copied from interface: ClubService

Convenience method for returning ALL of the members of a club

Returns ALL the members, regardless of how many there are

Pagination is NOT supported.

USE WITH CAUTION - CLUBS WITH MANY MEMBERS WILL REQUIRE MANY CALLS TO THE STRAVA API

Returns null if club with the given id does not exist

Returns an empty list if the club is private

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

Specified by:

listAllClubMembers in interface ClubService

Parameters:

clubId - The id of the StravaClub whose member athletes should be returned

Returns:

Returns an array of athlete summary representations.

See Also:

ClubService.listAllClubMembers(java.lang.Integer)

listAllRecentClubActivities

public List<StravaActivity> listAllRecentClubActivities(Integer clubId)

Description copied from interface: ClubService

Retrieve ALL the recent activities performed by member athletes of a specific club.

The authenticated athlete must be a member of the club.

Returns null if club with the given id does not exist

Returns an empty list if the authorised athlete is not a member of the club

Pagination is supported. However, the results are limited to the last 200 total activities by club members.

Specified by:

listAllRecentClubActivities in interface ClubService

Parameters:

clubId - The id of the StravaClub for which recent activities are to be returned.

Returns:

Returns an array of activity summary representations.

See Also:

ClubService.listAllRecentClubActivities(java.lang.Integer)