org.jboss.aerogear.android.pipe

Interface PipeHandler<T>

All Known Implementing Classes:

RestRunner

public interface PipeHandler<T>

Classes which implement this interface provide the logic for how pipes interact with services.

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

onRawRead

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

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.

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

HeaderAndBody onRawRead(Pipe<T> requestingPipe)

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.

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

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. This method will often be an HTTP GET but it is not required to be.

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

HeaderAndBody onRawSave(String id,
                        byte[] item)

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

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.

onRemove

void onRemove(String id)

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.

Parameters:

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