javastrava.api.v3.service.impl

Class StreamServiceImpl

java.lang.Object

javastrava.api.v3.service.impl.StravaServiceImpl

javastrava.api.v3.service.impl.StreamServiceImpl

All Implemented Interfaces:

StravaService, StreamService

public class StreamServiceImpl
extends StravaServiceImpl
implements StreamService

Implementation of StreamService

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
List<StravaStream>	getActivityStreams(Integer activityId) Streams represent the raw data of the uploaded file.
List<StravaStream>	getActivityStreams(Integer activityId, StravaStreamResolutionType resolution, StravaStreamSeriesDownsamplingType seriesType, StravaStreamType... types) Streams represent the raw data of the uploaded file.
CompletableFuture<List<StravaStream>>	getActivityStreamsAsync(Integer activityId) Streams represent the raw data of the uploaded file.
CompletableFuture<List<StravaStream>>	getActivityStreamsAsync(Integer activityId, StravaStreamResolutionType resolution, StravaStreamSeriesDownsamplingType seriesType, StravaStreamType... types) Streams represent the raw data of the uploaded file.
List<StravaStream>	getEffortStreams(Long effortId) A segment effort represents an attempt on a segment.
List<StravaStream>	getEffortStreams(Long effortId, StravaStreamResolutionType resolution, StravaStreamSeriesDownsamplingType seriesType, StravaStreamType... types) A segment effort represents an attempt on a segment.
CompletableFuture<List<StravaStream>>	getEffortStreamsAsync(Long effortId) A segment effort represents an attempt on a segment.
CompletableFuture<List<StravaStream>>	getEffortStreamsAsync(Long effortId, StravaStreamResolutionType resolution, StravaStreamSeriesDownsamplingType seriesType, StravaStreamType... types) A segment effort represents an attempt on a segment.
List<StravaStream>	getSegmentStreams(Integer segmentId) Retrieve detailed geographical information streams about a specific StravaSegment.
List<StravaStream>	getSegmentStreams(Integer segmentId, StravaStreamResolutionType resolution, StravaStreamSeriesDownsamplingType seriesType, StravaStreamType... types) Retrieve detailed geographical information streams about a specific StravaSegment.
CompletableFuture<List<StravaStream>>	getSegmentStreamsAsync(Integer segmentId) Retrieve detailed geographical information streams about a specific StravaSegment.
CompletableFuture<List<StravaStream>>	getSegmentStreamsAsync(Integer segmentId, StravaStreamResolutionType resolution, StravaStreamSeriesDownsamplingType seriesType, StravaStreamType... types) Retrieve detailed geographical information streams about a specific StravaSegment.
static StreamService	instance(Token token) Returns an instance of segment effort 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 StreamService instance(Token token)

Returns an instance of segment effort 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 stream services

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()

getActivityStreams

public List<StravaStream> getActivityStreams(Integer activityId)

Description copied from interface: StreamService

Streams represent the raw data of the uploaded file. External applications may only access this information for activities owned by the authenticated athlete.

While there are a large number of stream types, they may not exist for all activities. If a stream type does not exist for the activity, it will be ignored.

All streams for a given activity will be the same length and the values at a given index correspond to the same time. For example, the time from the time stream can be correlated to the lat/lng or watts streams.

Privacy Zones

StravaStream requests made using a public access_token will be cropped with the user's privacy zones, regardless if the requesting athlete owns the requested activity. To fetch the complete stream data use an access_token with view_private permissions.

URL GET https://www.strava.com/api/v3/activities/:id/streams/:types

Specified by:

getActivityStreams in interface StreamService

Parameters:

activityId - The id of the activity for which streams are to be retrieved

Returns:

Returns an array of unordered stream objects, or null if the activity doesn't exist

See Also:

StreamService.getActivityStreams(java.lang.Integer)

getActivityStreams

public List<StravaStream> getActivityStreams(Integer activityId,
                                             StravaStreamResolutionType resolution,
                                             StravaStreamSeriesDownsamplingType seriesType,
                                             StravaStreamType... types)

Description copied from interface: StreamService

Streams represent the raw data of the uploaded file. External applications may only access this information for activities owned by the authenticated athlete.

While there are a large number of stream types, they may not exist for all activities. If a stream type does not exist for the activity, it will be ignored.

All streams for a given activity will be the same length and the values at a given index correspond to the same time. For example, the time from the time stream can be correlated to the lat/lng or watts streams.

Privacy Zones

StravaStream requests made using a public access_token will be cropped with the user's privacy zones, regardless if the requesting athlete owns the requested activity. To fetch the complete stream data use an access_token with view_private permissions.

URL GET https://www.strava.com/api/v3/activities/:id/streams/:types

Specified by:

getActivityStreams in interface StreamService

Parameters:

activityId - The id of the activity for which streams are to be retrieved

resolution - (Optional) low (100), medium (1000) or high (10000), default is all, indicates desired number of data points, streams will only be down sampled

seriesType - (Optional) relevant only if using resolution. Either "time" or "distance", default is "distance", used to index the streams if the stream is being reduced

types - List of types, if the activity does not have that stream it will not be included in the response

Returns:

Returns an array of unordered stream objects, or null if the activity doesn't exist

See Also:

StreamService.getActivityStreams(Integer, StravaStreamResolutionType, StravaStreamSeriesDownsamplingType, StravaStreamType...)

getActivityStreamsAsync

public CompletableFuture<List<StravaStream>> getActivityStreamsAsync(Integer activityId)

Description copied from interface: StreamService

Streams represent the raw data of the uploaded file. External applications may only access this information for activities owned by the authenticated athlete.

While there are a large number of stream types, they may not exist for all activities. If a stream type does not exist for the activity, it will be ignored.

All streams for a given activity will be the same length and the values at a given index correspond to the same time. For example, the time from the time stream can be correlated to the lat/lng or watts streams.

Privacy Zones

StravaStream requests made using a public access_token will be cropped with the user's privacy zones, regardless if the requesting athlete owns the requested activity. To fetch the complete stream data use an access_token with view_private permissions.

URL GET https://www.strava.com/api/v3/activities/:id/streams/:types

Specified by:

getActivityStreamsAsync in interface StreamService

Parameters:

activityId - The id of the activity for which streams are to be retrieved

Returns:

Returns an array of unordered stream objects, or null if the activity doesn't exist

See Also:

StreamService.getActivityStreamsAsync(java.lang.Integer)

getActivityStreamsAsync

public CompletableFuture<List<StravaStream>> getActivityStreamsAsync(Integer activityId,
                                                                     StravaStreamResolutionType resolution,
                                                                     StravaStreamSeriesDownsamplingType seriesType,
                                                                     StravaStreamType... types)

Description copied from interface: StreamService

Streams represent the raw data of the uploaded file. External applications may only access this information for activities owned by the authenticated athlete.

While there are a large number of stream types, they may not exist for all activities. If a stream type does not exist for the activity, it will be ignored.

All streams for a given activity will be the same length and the values at a given index correspond to the same time. For example, the time from the time stream can be correlated to the lat/lng or watts streams.

Privacy Zones

StravaStream requests made using a public access_token will be cropped with the user's privacy zones, regardless if the requesting athlete owns the requested activity. To fetch the complete stream data use an access_token with view_private permissions.

URL GET https://www.strava.com/api/v3/activities/:id/streams/:types

Specified by:

getActivityStreamsAsync in interface StreamService

Parameters:

activityId - The id of the activity for which streams are to be retrieved

resolution - (Optional) low (100), medium (1000) or high (10000), default is all, indicates desired number of data points, streams will only be down sampled

seriesType - (Optional) relevant only if using resolution. Either "time" or "distance", default is "distance", used to index the streams if the stream is being reduced

types - List of types, if the activity does not have that stream it will not be included in the response

Returns:

Returns an array of unordered stream objects, or null if the activity doesn't exist

See Also:

StreamService.getActivityStreamsAsync(java.lang.Integer, javastrava.api.v3.model.reference.StravaStreamResolutionType, javastrava.api.v3.model.reference.StravaStreamSeriesDownsamplingType, javastrava.api.v3.model.reference.StravaStreamType[])

getEffortStreams

public List<StravaStream> getEffortStreams(Long effortId)

Description copied from interface: StreamService

A segment effort represents an attempt on a segment. This resource returns a subset of the activity streams that correspond to that effort.

All streams for a given segment effort will be the same length and the values at a given index correspond to the same time.

This resource is available for all public efforts.

URL GET https://www.strava.com/api/v3/segment_efforts/:id/streams/:types

Specified by:

getEffortStreams in interface StreamService

Parameters:

effortId - The id of the segment effort for which streams are to be retrieved

Returns:

Returns an array of unordered stream objects.

See Also:

StreamService.getEffortStreams(java.lang.Long)

getEffortStreams

public List<StravaStream> getEffortStreams(Long effortId,
                                           StravaStreamResolutionType resolution,
                                           StravaStreamSeriesDownsamplingType seriesType,
                                           StravaStreamType... types)

Description copied from interface: StreamService

A segment effort represents an attempt on a segment. This resource returns a subset of the activity streams that correspond to that effort.

All streams for a given segment effort will be the same length and the values at a given index correspond to the same time.

This resource is available for all public efforts.

URL GET https://www.strava.com/api/v3/segment_efforts/:id/streams/:types

Specified by:

getEffortStreams in interface StreamService

Parameters:

effortId - The id of the segment effort for which streams are to be retrieved

resolution - (Optional) low (100), medium (1000) or high (10000), default is all, indicates desired number of data points, streams will only be down sampled

seriesType - (Optional) relevant only if using resolution. Either "time" or "distance", default is "distance", used to index the streams if the stream is being reduced

types - List of types, if the effort does not have that stream it will not be included in the response

Returns:

Returns an array of unordered stream objects.

See Also:

StreamService.getEffortStreams(Long, StravaStreamResolutionType, StravaStreamSeriesDownsamplingType, StravaStreamType...)

getEffortStreamsAsync

public CompletableFuture<List<StravaStream>> getEffortStreamsAsync(Long effortId)

Description copied from interface: StreamService

A segment effort represents an attempt on a segment. This resource returns a subset of the activity streams that correspond to that effort.

All streams for a given segment effort will be the same length and the values at a given index correspond to the same time.

This resource is available for all public efforts.

URL GET https://www.strava.com/api/v3/segment_efforts/:id/streams/:types

Specified by:

getEffortStreamsAsync in interface StreamService

Parameters:

effortId - The id of the segment effort for which streams are to be retrieved

Returns:

Returns an array of unordered stream objects.

See Also:

StreamService.getEffortStreamsAsync(java.lang.Long)

getEffortStreamsAsync

public CompletableFuture<List<StravaStream>> getEffortStreamsAsync(Long effortId,
                                                                   StravaStreamResolutionType resolution,
                                                                   StravaStreamSeriesDownsamplingType seriesType,
                                                                   StravaStreamType... types)

Description copied from interface: StreamService

A segment effort represents an attempt on a segment. This resource returns a subset of the activity streams that correspond to that effort.

All streams for a given segment effort will be the same length and the values at a given index correspond to the same time.

This resource is available for all public efforts.

URL GET https://www.strava.com/api/v3/segment_efforts/:id/streams/:types

Specified by:

getEffortStreamsAsync in interface StreamService

Parameters:

effortId - The id of the segment effort for which streams are to be retrieved

resolution - (Optional) low (100), medium (1000) or high (10000), default is all, indicates desired number of data points, streams will only be down sampled

seriesType - (Optional) relevant only if using resolution. Either "time" or "distance", default is "distance", used to index the streams if the stream is being reduced

types - List of types, if the effort does not have that stream it will not be included in the response

Returns:

Returns an array of unordered stream objects.

See Also:

StreamService.getEffortStreamsAsync(java.lang.Long, javastrava.api.v3.model.reference.StravaStreamResolutionType, javastrava.api.v3.model.reference.StravaStreamSeriesDownsamplingType, javastrava.api.v3.model.reference.StravaStreamType[])

getSegmentStreams

public List<StravaStream> getSegmentStreams(Integer segmentId)

Description copied from interface: StreamService

Retrieve detailed geographical information streams about a specific StravaSegment.

Only distance, altitude and latlng stream types are available.

URL GET https://www.strava.com/api/v3/segments/:id/streams/:types

Specified by:

getSegmentStreams in interface StreamService

Parameters:

segmentId - The id of the segment for which streams are to be retrieved

Returns:

Returns an array of unordered stream objects.

See Also:

StreamService.getSegmentStreams(java.lang.Integer)

getSegmentStreams

public List<StravaStream> getSegmentStreams(Integer segmentId,
                                            StravaStreamResolutionType resolution,
                                            StravaStreamSeriesDownsamplingType seriesType,
                                            StravaStreamType... types)

Description copied from interface: StreamService

Retrieve detailed geographical information streams about a specific StravaSegment.

Only distance, altitude and latlng stream types are available.

URL GET https://www.strava.com/api/v3/segments/:id/streams/:types

Specified by:

getSegmentStreams in interface StreamService

Parameters:

segmentId - The id of the segment for which streams are to be retrieved

resolution - (Optional) low (100), medium (1000) or high (10000), default is all, indicates desired number of data points, streams will only be down sampled

seriesType - (Optional) relevant only if using resolution. Either "time" or "distance", default is "distance", used to index the streams if the stream is being reduced

types - List of types, if the segment does not have that stream it will not be included in the response

Returns:

Returns an array of unordered stream objects.

See Also:

StreamService.getSegmentStreams(Integer, StravaStreamResolutionType, StravaStreamSeriesDownsamplingType, StravaStreamType...)

getSegmentStreamsAsync

public CompletableFuture<List<StravaStream>> getSegmentStreamsAsync(Integer segmentId)

Description copied from interface: StreamService

Retrieve detailed geographical information streams about a specific StravaSegment.

Only distance, altitude and latlng stream types are available.

URL GET https://www.strava.com/api/v3/segments/:id/streams/:types

Specified by:

getSegmentStreamsAsync in interface StreamService

Parameters:

segmentId - The id of the segment for which streams are to be retrieved

Returns:

Returns an array of unordered stream objects.

See Also:

StreamService.getSegmentStreamsAsync(java.lang.Integer)

getSegmentStreamsAsync

public CompletableFuture<List<StravaStream>> getSegmentStreamsAsync(Integer segmentId,
                                                                    StravaStreamResolutionType resolution,
                                                                    StravaStreamSeriesDownsamplingType seriesType,
                                                                    StravaStreamType... types)

Description copied from interface: StreamService

Retrieve detailed geographical information streams about a specific StravaSegment.

Only distance, altitude and latlng stream types are available.

URL GET https://www.strava.com/api/v3/segments/:id/streams/:types

Specified by:

getSegmentStreamsAsync in interface StreamService

Parameters:

segmentId - The id of the segment for which streams are to be retrieved

resolution - (Optional) low (100), medium (1000) or high (10000), default is all, indicates desired number of data points, streams will only be down sampled

seriesType - (Optional) relevant only if using resolution. Either "time" or "distance", default is "distance", used to index the streams if the stream is being reduced

types - List of types, if the segment does not have that stream it will not be included in the response

Returns:

Returns an array of unordered stream objects.

See Also:

StreamService.getSegmentStreamsAsync(java.lang.Integer, javastrava.api.v3.model.reference.StravaStreamResolutionType, javastrava.api.v3.model.reference.StravaStreamSeriesDownsamplingType, javastrava.api.v3.model.reference.StravaStreamType[])