org.jboss.aerogear.android.pipe.rest

Class RestRunner<T>

java.lang.Object

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

All Implemented Interfaces:

PipeHandler<T>

public class RestRunner<T>
extends Object
implements PipeHandler<T>

Constructor Summary

Constructors

Constructor and Description
RestRunner(Class<T> klass, URL baseURL)

Method Summary

Modifier and Type	Method and Description
protected RequestBuilder<T>	getRequestBuilder()
HeaderAndBody	onRawRead(Pipe<T> requestingPipe) This method fetches a resource on behalf of a Pipe.
HeaderAndBody	onRawRead(Pipe<T> requestingPipe, String id) This method fetches a resource with an id on behalf of a Pipe.
HeaderAndBody	onRawReadWithFilter(org.jboss.aerogear.android.core.ReadFilter filter, Pipe<T> requestingPipe) This method fetches a resource with an filter on behalf of a Pipe.
HeaderAndBody	onRawSave(String id, byte[] item) This method will save data for a Pipe.
void	onRemove(String id) This method removes a resource with the id.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestRunner

public RestRunner(Class<T> klass,
                  URL baseURL)

Method Detail

onRemove

public void onRemove(String id)

Description copied from interface: PipeHandler

This method removes a resource with the id. This method may throw a unchecked exception if the remove is unsuccessful, but the exact exception depends on the implementation. This often performs an HTTP DELETE but is not required.

Specified by:

onRemove in interface PipeHandler<T>

Parameters:

id - the id of the resource to remove. Must not be null or empty.

getRequestBuilder

protected RequestBuilder<T> getRequestBuilder()

onRawRead

public HeaderAndBody onRawRead(Pipe<T> requestingPipe,
                               String id)

Description copied from interface: PipeHandler

This method fetches a resource with an id on behalf of a Pipe. This method will often be an HTTP GET but it is not required to be.

Specified by:

onRawRead in interface PipeHandler<T>

Parameters:

requestingPipe - the Pipe the handler is acting on behalf of.

id - the id of the remote resource

Returns:

parsed headers (if any) and the raw byte array of the remote resource stored in the body parameter.

onRawRead

public HeaderAndBody onRawRead(Pipe<T> requestingPipe)

Description copied from interface: PipeHandler

This method fetches a resource on behalf of a Pipe. This method will often be an HTTP GET but it is not required to be.

Specified by:

onRawRead in interface PipeHandler<T>

Parameters:

requestingPipe - the Pipe the handler is acting on behalf of.

Returns:

parsed headers (if any) and the raw byte array of the remote resource stored in the body parameter.

onRawReadWithFilter

public HeaderAndBody onRawReadWithFilter(org.jboss.aerogear.android.core.ReadFilter filter,
                                         Pipe<T> requestingPipe)

Description copied from interface: PipeHandler

This method fetches a resource with an filter on behalf of a Pipe. This method will often be an HTTP GET but it is not required to be.

Specified by:

onRawReadWithFilter in interface PipeHandler<T>

Parameters:

filter - an object with various filter parameters to use during the request.

requestingPipe - the Pipe the handler is acting on behalf of.

Returns:

parsed headers (if any) and the raw byte array of the remote resource stored in the body parameter.

onRawSave

public HeaderAndBody onRawSave(String id,
                               byte[] item)

Description copied from interface: PipeHandler

This method will save data for a Pipe. This is often an HTTP PUT or HTTP POST but is not required to be.

Specified by:

onRawSave in interface PipeHandler<T>

Parameters:

id - The id of the object to save. May be empty or null.

item - data to save. This must not be null.

Returns:

the results of the save operation. The contents will vary based on implementation.