javastrava.api.util.RetrofitErrorHandler Maven / Gradle / Ivy

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
The newest version!
package javastrava.api.util;

import java.io.IOException;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import javastrava.config.Messages;
import javastrava.json.JsonUtil;
import javastrava.json.exception.JsonSerialisationException;
import javastrava.json.impl.JsonUtilImpl;
import javastrava.model.StravaAPIError;
import javastrava.model.StravaResponse;
import javastrava.service.exception.BadRequestException;
import javastrava.service.exception.InvalidTokenException;
import javastrava.service.exception.NotFoundException;
import javastrava.service.exception.StravaAPINetworkException;
import javastrava.service.exception.StravaAPIRateLimitException;
import javastrava.service.exception.StravaInternalServerErrorException;
import javastrava.service.exception.StravaServiceUnavailableException;
import javastrava.service.exception.StravaUnknownAPIException;
import javastrava.service.exception.UnauthorizedException;
import retrofit.ErrorHandler;
import retrofit.RetrofitError;
import retrofit.RetrofitError.Kind;
import retrofit.client.Response;

/**
 * 
 * Interceptor to handle errors thrown by the Strava API.
 * 
 *
 * 
 * HTTP error status codes are converted to checked (if recoverable) or unchecked (if not) exceptions and thrown
 * 
 *
 * 
 * With each error, Strava also returns a set of error messages which are encapsulated in {@link StravaResponse}
 * 
 *
 * @author Dan Shannon
 *
 */
public class RetrofitErrorHandler implements ErrorHandler {
	/**
	 * Logger
	 */
	private static final Logger log = LogManager.getLogger();

	/**
	 * 
	 * Determines whether a token is invalid or not
	 * 
	 *
	 * @param response
	 *            response received from the Strava API call
	 * @return true if the token is invalid, false otherwise
	 */
	private static boolean tokenInvalid(final StravaResponse response) {
		if ((response == null) || (response.getErrors() == null) || response.getErrors().isEmpty()) {
			return false;
		}
		for (final StravaAPIError error : response.getErrors()) {
			if (error.getResource().equals("Application") && error.getCode().equals("invalid")) { //$NON-NLS-1$ //$NON-NLS-2$
				return true;
			}
		}
		return false;
	}

	/**
	 * JSON utilities for serialisation and deserialisation
	 */
	JsonUtil json = new JsonUtilImpl();

	/**
	 * @see retrofit.ErrorHandler#handleError(retrofit.RetrofitError)
	 */
	@Override
	public Throwable handleError(final RetrofitError cause) {
		final Response r = cause.getResponse();
		StravaResponse response = null;
		final String status = (r == null ? Messages.string("RetrofitErrorHandler.unknownError") //$NON-NLS-1$
				: r.getStatus() + " " + r.getReason()); //$NON-NLS-1$

		// Handle network errors
		if (cause.getKind() == Kind.NETWORK) {
			return new StravaAPINetworkException(null, response, cause);
		}

		if (r == null) {
			return new StravaUnknownAPIException(status, response, cause);
		}

		try {
			if (r.getBody() == null) {
				response = new StravaResponse();
				response.setMessage(cause.getMessage());
			} else {
				response = this.json.deserialise(r.getBody().in(), StravaResponse.class);
			}
		} catch (final JsonSerialisationException e) {
			response = new StravaResponse();
			response.setMessage(r.getBody().toString());
		} catch (final IOException e) {
			response = new StravaResponse();
			response.setMessage(r.getBody().toString());
		} catch (final Exception e) {
			response = new StravaResponse();
			response.setMessage(cause.toString());
		}

		// Handle 400 Bad request error
		if (r.getStatus() == 400) {
			log.warn(status + " : " + response); //$NON-NLS-1$
			return new BadRequestException(status, response, cause);
		}

		// Handle 401 Unauthorized error
		if (r.getStatus() == 401) {
			if (tokenInvalid(response)) {
				log.info(status + " : " + response); //$NON-NLS-1$
				return new InvalidTokenException(status, response, cause);
			}

			log.warn(status + " : " + response); //$NON-NLS-1$
			return new UnauthorizedException(status, response, cause);
		}

		// Handle 403 forbidden error
		if (r.getStatus() == 403) {
			log.info(status + " : " + response); //$NON-NLS-1$
			if (response.getMessage().equals(Messages.string("RetrofitErrorHandler.rateLimitExceeded"))) { //$NON-NLS-1$
				return new StravaAPIRateLimitException(status, response, cause);
			}
			return new UnauthorizedException(status, response, cause);
		}

		// Handle 404 Not Found error
		if (r.getStatus() == 404) {
			log.info(status + " : " + response); //$NON-NLS-1$
			return new NotFoundException(response, cause);
		}

		// Handle 429 Too many requests error
		if (r.getStatus() == 429) {
			log.warn(status + " : " + response); //$NON-NLS-1$
			return new StravaAPIRateLimitException(status, response, cause);
		}

		// Handle 500 Internal Server error
		if (r.getStatus() == 500) {
			log.error(status + " : " + response); //$NON-NLS-1$
			return new StravaInternalServerErrorException(status, response, cause);
		}

		// Handle 503 Service Unavailable error
		if (r.getStatus() == 503) {
			log.error(status + " : " + response); //$NON-NLS-1$
			return new StravaServiceUnavailableException(status, response, cause);
		}

		log.error(response);
		return new StravaUnknownAPIException(status, response, cause);
	}

}