com.socrata.api

Class Soda2Consumer

java.lang.Object

com.socrata.api.Soda2Base

com.socrata.api.Soda2Consumer

Direct Known Subclasses:

Soda2Producer

public class Soda2Consumer
extends Soda2Base

Class to issue SODA2 queries against a service. All the methods on this class are READ-ONLY, and are only for consumption. For updating data using SODA2, use the Soda2Producer class.

Field Summary

Fields

Modifier and Type	Field and Description
static com.sun.jersey.api.client.GenericType<List<Object>>	HASH_RETURN_TYPE

Fields inherited from class com.socrata.api.Soda2Base

SODA_BASE_PATH, SODA_QUERY

Constructor Summary

Constructors

Constructor and Description
Soda2Consumer(HttpLowLevel httpLowLevel) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	getById(String resourceId, String id, Class<T> cls) Retrieves an object on a resource based on it's ID.
static Soda2Consumer	newConsumer(String url) Creates a new Soda2Consumer that had no authentication associated with it.
static Soda2Consumer	newConsumer(String url, String userName, String password, String token) Creates a new Soda2Consumer with the passed in credentials associated with it.
<T> List<T>	query(String resourceId, SoqlQuery query, com.sun.jersey.api.client.GenericType<List<T>> genericType)
<T> List<T>	query(String resourceId, String query, com.sun.jersey.api.client.GenericType<List<T>> genericType)

Methods inherited from class com.socrata.api.Soda2Base

doAdd, doAddObjects, doAddStream, doDelete, doReplaceObjects, doReplaceStream, doTruncate, doUpdate, getById, getHttpLowLevel, query, query

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HASH_RETURN_TYPE

public static final com.sun.jersey.api.client.GenericType<List<Object>> HASH_RETURN_TYPE

Constructor Detail

Soda2Consumer

public Soda2Consumer(HttpLowLevel httpLowLevel)

Constructor

Parameters:

httpLowLevel - the lower level connection object for using for requests.

Method Detail

newConsumer

public static final Soda2Consumer newConsumer(String url)

Creates a new Soda2Consumer that had no authentication associated with it. All requests will be done as an anonymous user.

Parameters:

url - the URL to the base SODA2 domain.

Returns:

the new Soda2Consumer that has been fully configured.

newConsumer

public static final Soda2Consumer newConsumer(String url,
                        String userName,
                        String password,
                        String token)

Creates a new Soda2Consumer with the passed in credentials associated with it. All requests will contain these credentials.

Parameters:

url - the base URL for the SODA2 domain to access.

userName - user name to log in as

password - password to log in with

token - the App Token to use for authorization and usage tracking. If this is null, no value will be sent.

Returns:

the new Soda2Consumer that has been fully configured.

getById

public <T> T getById(String resourceId,
            String id,
            Class<T> cls)
          throws SodaError,
                 InterruptedException

Retrieves an object on a resource based on it's ID. If the object does not exist, a DoesNotExistException will be thrown.

Parameters:

resourceId - The id of the resource to query. This can either be the resource endpoint name set in the metadata, or the unique ID given to the resource.

id - Id based on a dataset specific unique column, or the system ID created for each row.

cls - The class object the resulting object should be deserialized as.

Returns:

the object retrieved.

Throws:

SodaError - thrown if there is an error. Investigate the structure for more information.

InterruptedException - throws is the thread is interrupted.

query

public <T> List<T> query(String resourceId,
                SoqlQuery query,
                com.sun.jersey.api.client.GenericType<List<T>> genericType)
              throws SodaError,
                     InterruptedException

Type Parameters:

T - the type of object that should be returned in the resulting list

Parameters:

resourceId - The id of the resource to query. This can either be the resource endpoint name set in the metadata, or the unique ID given to the resource.

query - The query to be executed against the resource.

genericType - the type of objects that should be returned as a result from this query

Returns:

results from the query.

Throws:

SodaError - thrown if there is an error. Investigate the structure for more information.

InterruptedException - throws is the thread is interrupted.

query

public <T> List<T> query(String resourceId,
                String query,
                com.sun.jersey.api.client.GenericType<List<T>> genericType)
              throws SodaError,
                     InterruptedException

Type Parameters:

T - the type of object that should be returned in the resulting list

Parameters:

resourceId - The id of the resource to query. This can either be the resource endpoint name set in the metadata, or the unique ID given to the resource.

query - The query string to be executed against the resource.

genericType - the type of objects that should be returned as a result from this query

Returns:

results from the query.

Throws:

SodaError - thrown if there is an error. Investigate the structure for more information.

InterruptedException - throws is the thread is interrupted.