org.jboss.aerogear.android.pipe.rest

Class RestAdapter<T>

java.lang.Object

org.jboss.aerogear.android.pipe.rest.RestAdapter<T>

All Implemented Interfaces:

Pipe<T>

public final class RestAdapter<T>
extends Object
implements Pipe<T>

Rest implementation of Pipe.

Field Summary

Fields

Modifier and Type	Field and Description
static Executor	THREAD_POOL_EXECUTOR

Constructor Summary

Constructors

Constructor and Description
RestAdapter(Class<T> klass, URL absoluteURL) This will configure the Adapter as with sane RESTful defaults.
RestAdapter(Class<T> klass, URL absoluteURL, RestfulPipeConfiguration config) This will build an adapter based on a configuration.

Method Summary

Modifier and Type	Method and Description
PipeHandler<T>	getHandler() Returns the instance which is responsible for handling read, save, and remove.
Class<T>	getKlass()
RequestBuilder<T>	getRequestBuilder() The RequestBuilder is responsible for turning objects in bodies of requests.
ResponseParser<T>	getResponseParser() The ResponseParser is responsible for turning responses from a SAVE into an object
URL	getUrl() Returns the URL to which this Pipe object points.
void	read(org.jboss.aerogear.android.core.Callback<List<T>> callback) Sends a signal to the Pipe to read its data and return it via the callback.
void	read(org.jboss.aerogear.android.core.ReadFilter filter, org.jboss.aerogear.android.core.Callback<List<T>> callback) Reads all the data from the underlying server connection.
void	read(String id, org.jboss.aerogear.android.core.Callback<T> callback) Sends a signal to the Pipe to read data by id and return it via the callback.
void	remove(String id, org.jboss.aerogear.android.core.Callback<Void> callback) Removes an object from the underlying server connection.
void	save(T data, org.jboss.aerogear.android.core.Callback<T> callback) Saves or updates a given object on the server.

Methods inherited from class java.lang.Object

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

Field Detail

THREAD_POOL_EXECUTOR

public static final Executor THREAD_POOL_EXECUTOR

Constructor Detail

RestAdapter

public RestAdapter(Class<T> klass,
                   URL absoluteURL)

This will configure the Adapter as with sane RESTful defaults.

Parameters:

klass - The type that this adapter will consume and produce

absoluteURL - the RESTful URL endpoint.

RestAdapter

public RestAdapter(Class<T> klass,
                   URL absoluteURL,
                   RestfulPipeConfiguration config)

This will build an adapter based on a configuration.

Parameters:

klass - The type that this adapter will consume and produce

absoluteURL - the RESTful URL endpoint.

config - A PipeConfig to use. NOTE: the URL's provided in the config are ignored in deference to the absoluteURL parameter.

Method Detail

getUrl

public URL getUrl()

Returns the URL to which this Pipe object points.

Specified by:

getUrl in interface Pipe<T>

Returns:

the endpoint URL

read

public void read(String id,
                 org.jboss.aerogear.android.core.Callback<T> callback)

Description copied from interface: Pipe

Sends a signal to the Pipe to read data by id and return it via the callback.

Specified by:

read in interface Pipe<T>

Parameters:

id - representing the ‘id’ of the object

callback - The callback for consuming the result from the Pipe invocation.

read

public void read(org.jboss.aerogear.android.core.ReadFilter filter,
                 org.jboss.aerogear.android.core.Callback<List<T>> callback)

Description copied from interface: Pipe

Reads all the data from the underlying server connection.

Specified by:

read in interface Pipe<T>

Parameters:

filter - a ReadFilter for performing pagination and querying.

callback - The callback for consuming the result from the Pipe invocation.

read

public void read(org.jboss.aerogear.android.core.Callback<List<T>> callback)

Sends a signal to the Pipe to read its data and return it via the callback.

Specified by:

read in interface Pipe<T>

Parameters:

callback - The callback for consuming the result from the Pipe invocation.

save

public void save(T data,
                 org.jboss.aerogear.android.core.Callback<T> callback)

Description copied from interface: Pipe

Saves or updates a given object on the server.

Specified by:

save in interface Pipe<T>

Parameters:

data - the item to save or update

callback - The callback for consuming the result from the Pipe invocation.

remove

public void remove(String id,
                   org.jboss.aerogear.android.core.Callback<Void> callback)

Removes an object from the underlying server connection. The given key argument is used as the objects ID.

Specified by:

remove in interface Pipe<T>

Parameters:

id - representing the ‘id’ of the object to be removed

callback - The callback for consuming the result from the Pipe invocation.

getHandler

public PipeHandler<T> getHandler()

Description copied from interface: Pipe

Returns the instance which is responsible for handling read, save, and remove.

Specified by:

getHandler in interface Pipe<T>

Returns:

the handler performing operations for this Pipe. May be the Pipe itself.

getKlass

public Class<T> getKlass()

Specified by:

getKlass in interface Pipe<T>

Returns:

the class which travels on this pipe

getRequestBuilder

public RequestBuilder<T> getRequestBuilder()

Description copied from interface: Pipe

The RequestBuilder is responsible for turning objects in bodies of requests.

Specified by:

getRequestBuilder in interface Pipe<T>

Returns:

the current RequestBuilder instance

getResponseParser

public ResponseParser<T> getResponseParser()

Description copied from interface: Pipe

The ResponseParser is responsible for turning responses from a SAVE into an object

Specified by:

getResponseParser in interface Pipe<T>

Returns:

the current ResponseParser instance