javastrava.api.v3.service.impl.GearServiceImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javastrava-api Show documentation
Java implementation of the Strava API
There is a newer version: 1.0.3.6
package javastrava.api.v3.service.impl;

import java.util.concurrent.CompletableFuture;

import javastrava.api.v3.auth.model.Token;
import javastrava.api.v3.model.StravaGear;
import javastrava.api.v3.model.reference.StravaResourceState;
import javastrava.api.v3.service.ClubService;
import javastrava.api.v3.service.GearService;
import javastrava.api.v3.service.exception.NotFoundException;
import javastrava.api.v3.service.exception.UnauthorizedException;
import javastrava.cache.StravaCache;
import javastrava.cache.impl.StravaCacheImpl;
import javastrava.util.PrivacyUtils;

/**
 * 
 * Implementation of {@link ClubService}
 * 
 *
 * @author Dan Shannon
 *
 */
public class GearServiceImpl extends StravaServiceImpl implements GearService {
	/**
	 * 
	 * Returns an instance of {@link GearService gear services}
	 * 
	 *
	 * 
	 * Instances are cached so that if 2 requests are made for the same token,
	 * the same instance is returned
	 * 
	 *
	 * @param token
	 *            The Strava access token to be used in requests to the Strava
	 *            API
	 * @return An instance of the club services
	 * @throws UnauthorizedException
	 *             If the token used to create the service is invalid
	 */
	public static GearService instance(final Token token) {
		// Get the service from the token's cache
		GearService service = token.getService(GearService.class);

		// If it's not already there, create a new one and put it in the token
		if (service == null) {
			service = new GearServiceImpl(token);
			token.addService(GearService.class, service);
		}
		return service;
	}

	/**
	 * Cache of gear information
	 */
	private final StravaCache gearCache;

	/**
	 * 
	 * Private constructor ensures that the only way to get an instance is via
	 * the {@link #instance(Token)} method
	 * 
	 *
	 * @param token
	 *            The access token to be used to authenticate to the Strava API
	 */
	private GearServiceImpl(final Token token) {
		super(token);
		this.gearCache = new StravaCacheImpl(StravaGear.class, token);
	}

	/**
	 * @see javastrava.api.v3.service.StravaService#clearCache()
	 */
	@Override
	public void clearCache() {
		this.gearCache.removeAll();
	}

	/**
	 * @see javastrava.api.v3.service.GearService#getGear(java.lang.String)
	 */
	@Override
	public StravaGear getGear(final String gearId) {
		// Attempt to get the gear from cache
		StravaGear gear = this.gearCache.get(gearId);
		if ((gear != null) && (gear.getResourceState() != StravaResourceState.META)) {
			return gear;
		}

		// If it wasn't in cache, try to get it from the API
		try {
			gear = this.api.getGear(gearId);
		} catch (final NotFoundException e) {
			return null;
		} catch (final UnauthorizedException e) {
			gear = PrivacyUtils.privateGear(gearId);
		}

		// Put the gear in cache and return it
		this.gearCache.put(gear);
		return gear;
	}

	/**
	 * @see javastrava.api.v3.service.GearService#getGearAsync(java.lang.String)
	 */
	@Override
	public CompletableFuture getGearAsync(final String gearId) {
		return StravaServiceImpl.future(() -> {
			return getGear(gearId);
		});
	}

}