com.jimmoores.quandl.util.RESTDataProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quandl-jersey1 Show documentation

Quandl REST API wrapper for Java

The newest version!

package com.jimmoores.quandl.util;

import org.json.JSONObject;

import com.jimmoores.quandl.TabularResult;
import com.sun.jersey.api.client.WebResource;

/**
 * An interface for abstracting the detail of getting a result object from the back-end, primarily to ease testing
 * but also to remove code duplication.
 */
public interface RESTDataProvider {
  /**
   * HTTP Response code returned in some cases, usually when a request is nonsensical, e.g. requesting a non-existent column.
   */
  int UNPROCESSABLE_ENTITY = 422;
  /**
   * HTTP Response code returned when the client has made too many request - it is an indication of rate limiting on the 
   * server-side.
   */
  int TOO_MANY_REQUESTS = 422; // response code returned in some cases

  /**
   * Invoke a GET call on the web target and return the result as a parsed JSON object.
   * Throws a QuandlRuntimeException if there was a CSV parsing problem or response code was not OK
   * @param target the WebTarget describing the call to make, not null
   * @return the parsed JSON object
   */
  JSONObject getJSONResponse(final WebResource target);

  /**
   * Invoke a GET call on the web target and return the result as a TabularResult (parsed CSV).
   * Throws a QuandlRuntimeException if there was a JSON parsing problem, network issue or response code was not OK
   * @param target the WebTarget describing the call to make, not null
   * @return the parsed TabularResult
   */
  TabularResult getTabularResponse(final WebResource target);
}