javastrava.api.v3.service.impl

Class UploadServiceImpl

java.lang.Object

javastrava.api.v3.service.impl.StravaServiceImpl

javastrava.api.v3.service.impl.UploadServiceImpl

All Implemented Interfaces:

StravaService, UploadService

public class UploadServiceImpl
extends StravaServiceImpl
implements UploadService

Implementation of UploadService

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
StravaUploadResponse	checkUploadStatus(Integer id) Upon upload, Strava will respond with an upload ID.
CompletableFuture<StravaUploadResponse>	checkUploadStatusAsync(Integer uploadId) Upon upload, Strava will respond with an upload ID.
void	clearCache() Clear any and all cached data entries
static UploadService	instance(Token token) Returns an instance of segment effort services
StravaUploadResponse	upload(StravaActivityType activityType, String name, String description, Boolean _private, Boolean trainer, Boolean commute, String dataType, String externalId, File file) Requires write permissions, as requested during the authorization process.
CompletableFuture<StravaUploadResponse>	uploadAsync(StravaActivityType activityType, String name, String description, Boolean _private, Boolean trainer, Boolean commute, String dataType, String externalId, File file) Requires write permissions, as requested during the authorization process.

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 UploadService 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 upload services

checkUploadStatus

public StravaUploadResponse checkUploadStatus(Integer id)

Description copied from interface: UploadService

Upon upload, Strava will respond with an upload ID. You may use this ID to poll the status of your upload. Strava recommends polling no more than once a second. Polling more frequently is unnecessary. The mean processing time is around 8 seconds.

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

Specified by:

checkUploadStatus in interface UploadService

Parameters:

id - Upload id originally returned when the upload was done

Returns:

Upload response indicating current status of the upload

See Also:

UploadService.checkUploadStatus(java.lang.Integer)

checkUploadStatusAsync

public CompletableFuture<StravaUploadResponse> checkUploadStatusAsync(Integer uploadId)
                                                               throws UnauthorizedException

Description copied from interface: UploadService

Upon upload, Strava will respond with an upload ID. You may use this ID to poll the status of your upload. Strava recommends polling no more than once a second. Polling more frequently is unnecessary. The mean processing time is around 8 seconds.

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

Specified by:

checkUploadStatusAsync in interface UploadService

Parameters:

uploadId - Upload id originally returned when the upload was done

Returns:

Upload response indicating current status of the upload

Throws:

UnauthorizedException - If the authenticated user does not have write access

See Also:

UploadService.checkUploadStatusAsync(java.lang.Integer)

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

upload

public StravaUploadResponse upload(StravaActivityType activityType,
                                   String name,
                                   String description,
                                   Boolean _private,
                                   Boolean trainer,
                                   Boolean commute,
                                   String dataType,
                                   String externalId,
                                   File file)

Description copied from interface: UploadService

Requires write permissions, as requested during the authorization process.

Posting a file for upload will enqueue it for processing. Initial checks will be done for malformed data and duplicates.

URL POST https://www.strava.com/api/v3/uploads

Specified by:

upload in interface UploadService

Parameters:

activityType - (Optional) Type of activity being uploaded

name - (Optional) if not provided, will be populated using start date and location, if available

description - (Optional)

_private - (Optional) set to 1 to mark the resulting activity as private, 'view_private' permissions will be necessary to view the activity

trainer - (Optional) activities without lat/lng info in the file are auto marked as stationary, set to 1 to force

commute - (Optional) set to 1 to mark as commute

dataType - possible values: fit, fit.gz, tcx, tcx.gz, gpx, gpx.gz

externalId - (Optional) data filename will be used by default but should be a unique identifier

file - the actual activity data, if gzipped the data_type must end with .gz

Returns:

Returns an Upload Status object. This object will include an English language status. If success, it will indicate the data is still processing. If there was an error, it will describe the error, potentially containing HTML. Upon a successful submission the request will return 201 Created. If there was an error the request will return 400 Bad Request.

See Also:

UploadService.upload(javastrava.api.v3.model.reference.StravaActivityType, java.lang.String, java.lang.String, java.lang.Boolean, java.lang.Boolean, java.lang.Boolean, java.lang.String, java.lang.String, java.io.File)

uploadAsync

public CompletableFuture<StravaUploadResponse> uploadAsync(StravaActivityType activityType,
                                                           String name,
                                                           String description,
                                                           Boolean _private,
                                                           Boolean trainer,
                                                           Boolean commute,
                                                           String dataType,
                                                           String externalId,
                                                           File file)

Description copied from interface: UploadService

Requires write permissions, as requested during the authorization process.

Posting a file for upload will enqueue it for processing. Initial checks will be done for malformed data and duplicates.

URL POST https://www.strava.com/api/v3/uploads

Specified by:

uploadAsync in interface UploadService

Parameters:

activityType - (Optional) Type of activity being uploaded

name - (Optional) if not provided, will be populated using start date and location, if available

description - (Optional)

_private - (Optional) set to 1 to mark the resulting activity as private, 'view_private' permissions will be necessary to view the activity

trainer - (Optional) activities without lat/lng info in the file are auto marked as stationary, set to 1 to force

commute - (Optional) set to 1 to mark as commute

dataType - possible values: fit, fit.gz, tcx, tcx.gz, gpx, gpx.gz

externalId - (Optional) data filename will be used by default but should be a unique identifier

file - the actual activity data, if gzipped the data_type must end with .gz

Returns:

Returns an Upload Status object. This object will include an English language status. If success, it will indicate the data is still processing. If there was an error, it will describe the error, potentially containing HTML. Upon a successful submission the request will return 201 Created. If there was an error the request will return 400 Bad Request.

See Also:

UploadService.uploadAsync(javastrava.api.v3.model.reference.StravaActivityType, java.lang.String, java.lang.String, java.lang.Boolean, java.lang.Boolean, java.lang.Boolean, java.lang.String, java.lang.String, java.io.File)