com.jimmoores.quandl.util

Interface RESTDataProvider

All Known Implementing Classes:

DefaultRESTDataProvider

public interface RESTDataProvider

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.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SERVICE_UNAVAILABLE HTTP Response code returned when the service is unavailable - it is an indication of a probably temporary error or load problem on the server
static int	TOO_MANY_REQUESTS HTTP Response code returned when the client has made too many request - it is an indication of rate limiting on the server-side.
static int	UNPROCESSABLE_ENTITY HTTP Response code returned in some cases, usually when a request is nonsensical, e.g.

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	getJSONResponse(javax.ws.rs.client.WebTarget target) Invoke a GET call on the web target and return the result as a parsed JSON object.
TabularResult	getTabularResponse(javax.ws.rs.client.WebTarget target) Invoke a GET call on the web target and return the result as a TabularResult (parsed CSV).

Field Detail

UNPROCESSABLE_ENTITY

static final int UNPROCESSABLE_ENTITY

HTTP Response code returned in some cases, usually when a request is nonsensical, e.g. requesting a non-existent column.

See Also:

Constant Field Values

TOO_MANY_REQUESTS

static final int TOO_MANY_REQUESTS

HTTP Response code returned when the client has made too many request - it is an indication of rate limiting on the server-side.

See Also:

Constant Field Values

SERVICE_UNAVAILABLE

static final int SERVICE_UNAVAILABLE

HTTP Response code returned when the service is unavailable - it is an indication of a probably temporary error or load problem on the server

See Also:

Constant Field Values

Method Detail

getJSONResponse

org.json.JSONObject getJSONResponse(javax.ws.rs.client.WebTarget target)

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

Parameters:

target - the WebTarget describing the call to make, not null

Returns:

the parsed JSON object

getTabularResponse

TabularResult getTabularResponse(javax.ws.rs.client.WebTarget 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

Parameters:

target - the WebTarget describing the call to make, not null

Returns:

the parsed TabularResult