A B C D E F G H I L M N O P R S T U V W

A

AbstractActivityCallback<T> - Class in org.jboss.aerogear.android.pipe.callback

LoaderPipe will consume callbacks of this type will supply it with a Activity instance before onSuccess or onFailure are called.

AbstractActivityCallback(Object...) - Constructor for class org.jboss.aerogear.android.pipe.callback.AbstractActivityCallback

This accepts an arbitrary list of Object and uses Arrays.hashCode(java.lang.Object[]) to generate a hashcode.

AbstractCallback<T> - Class in org.jboss.aerogear.android.pipe.callback

This class provides a hashcode method for a callback based on constructor parameters.

AbstractCallback(Object...) - Constructor for class org.jboss.aerogear.android.pipe.callback.AbstractCallback

This accepts an arbitrary list of Object and uses Arrays.hashCode(java.lang.Object[]) to generate a hashcode.

AbstractFragmentCallback<T> - Class in org.jboss.aerogear.android.pipe.callback

LoaderPipe which consume callbacks of this type will supply it with a Activity instance before onSuccess or onFailure are called.

AbstractFragmentCallback(Object...) - Constructor for class org.jboss.aerogear.android.pipe.callback.AbstractFragmentCallback

This accepts an arbitrary list of Object and uses Arrays.hashCode(java.lang.Object[]) to generate a hashcode.

AbstractPipeLoader<T> - Class in org.jboss.aerogear.android.pipe.loader

This class maintains references to the callback to be called when a Loader supporting a Pipe's operation completes.

AbstractPipeLoader(Context, Callback<T>) - Constructor for class org.jboss.aerogear.android.pipe.loader.AbstractPipeLoader

addHeader(String, String) - Method in class org.jboss.aerogear.android.pipe.module.AuthorizationFields

addHeader(String, String) - Method in class org.jboss.aerogear.android.pipe.module.ModuleFields

addOnPipeCreatedListener(OnPipeCreatedListener) - Method in class org.jboss.aerogear.android.pipe.PipeConfiguration

OnPipeCreatedListseners are a collection of classes to be notified when the configuration of the Pipe is complete.

addQueryParameter(String, String) - Method in class org.jboss.aerogear.android.pipe.module.AuthorizationFields

addQueryParameter(String, String) - Method in class org.jboss.aerogear.android.pipe.module.ModuleFields

appendQueryToBaseURL(URL, String) - Static method in class org.jboss.aerogear.android.pipe.util.UrlUtils

Append the base url with the query.

appendToBaseURL(URL, String) - Static method in class org.jboss.aerogear.android.pipe.util.UrlUtils

Append the base url with endpoint

asArrayClass(Class<T>) - Static method in class org.jboss.aerogear.android.pipe.util.ClassUtils

This will return a class of the type T[] from a given class.

AuthorizationFields - Class in org.jboss.aerogear.android.pipe.module

This class wraps up fields which need to be applied to a request to ensure it can be securely consumed.

AuthorizationFields() - Constructor for class org.jboss.aerogear.android.pipe.module.AuthorizationFields

B

buildPipeForClass(Class<DATA>) - Method in class org.jboss.aerogear.android.pipe.PipeConfiguration

Validates configuration parameters and returns a Pipe instance.

buildPipeForClass(Class<DATA>) - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

C

CALLBACK - Static variable in interface org.jboss.aerogear.android.pipe.LoaderPipe

Bundle key for callbacks handed to Pipe methods.

CallbackHandler(LoaderAdapter<T>, AbstractPipeLoader, Object) - Constructor for class org.jboss.aerogear.android.pipe.loader.LoaderAdapter.CallbackHandler

ClassUtils - Class in org.jboss.aerogear.android.pipe.util

Utilities for working with classes, reflection, etc

ClassUtils() - Constructor for class org.jboss.aerogear.android.pipe.util.ClassUtils

config(String, Class<CFG>) - Static method in class org.jboss.aerogear.android.pipe.PipeManager

Begins a new fluent configuration stanza.

CONTENT_TYPE - Static variable in class org.jboss.aerogear.android.pipe.rest.gson.GsonRequestBuilder

D

DefaultParameterProvider - Class in org.jboss.aerogear.android.pipe.paging

This class returns the URI calculated from ReadFilter.getQuery

DefaultParameterProvider() - Constructor for class org.jboss.aerogear.android.pipe.paging.DefaultParameterProvider

delete(String) - Method in interface org.jboss.aerogear.android.pipe.http.HttpProvider

Issues an HTTP request, consumes the content, and cleans up after itself.

delete(String) - Method in class org.jboss.aerogear.android.pipe.http.HttpRestProvider

Issues an HTTP request, consumes the content, and cleans up after itself.

E

equals(Object) - Method in class org.jboss.aerogear.android.pipe.rest.multipart.TypeAndStream

exception - Variable in class org.jboss.aerogear.android.pipe.loader.AbstractPipeLoader

F

FILTER - Static variable in interface org.jboss.aerogear.android.pipe.LoaderPipe

Bundle key for the ReadFilter param

forClass(Class<DATA>) - Method in class org.jboss.aerogear.android.pipe.PipeConfiguration

Creates a pipe based on the current configuration and notifies all listeners

G

get() - Method in interface org.jboss.aerogear.android.pipe.http.HttpProvider

Issues an HTTP request, consumes the content, and cleans up after itself.

get(Object...) - Method in class org.jboss.aerogear.android.pipe.http.HttpProviderFactory

get() - Method in class org.jboss.aerogear.android.pipe.http.HttpRestProvider

Issues an HTTP request, consumes the content, and cleans up after itself.

getActivity() - Method in class org.jboss.aerogear.android.pipe.callback.AbstractActivityCallback

This method should be called in the onSuccess or onFailure methods of subclasses.

getBody() - Method in class org.jboss.aerogear.android.pipe.http.HeaderAndBody

getBody(T) - Method in interface org.jboss.aerogear.android.pipe.RequestBuilder

This method creates the body of a request for a Pipe to use.

getBody(T) - Method in class org.jboss.aerogear.android.pipe.rest.gson.GsonRequestBuilder

getBody(T) - Method in class org.jboss.aerogear.android.pipe.rest.multipart.MultipartRequestBuilder

getCallback() - Method in class org.jboss.aerogear.android.pipe.loader.AbstractPipeLoader

getContentType() - Method in interface org.jboss.aerogear.android.pipe.RequestBuilder

getContentType() - Method in class org.jboss.aerogear.android.pipe.rest.gson.GsonRequestBuilder

getContentType() - Method in class org.jboss.aerogear.android.pipe.rest.multipart.MultipartRequestBuilder

getData() - Method in exception org.jboss.aerogear.android.pipe.http.HttpException

getDataRoot() - Method in class org.jboss.aerogear.android.pipe.MarshallingConfig

DataRoot refers to the dotted location of the result we are interested in from the JSON response from the server.

getEncoding() - Method in class org.jboss.aerogear.android.pipe.MarshallingConfig

Encoding is the data encoding of the http body.

getException() - Method in class org.jboss.aerogear.android.pipe.loader.AbstractPipeLoader

getFileName() - Method in class org.jboss.aerogear.android.pipe.rest.multipart.TypeAndStream

getFragment() - Method in class org.jboss.aerogear.android.pipe.callback.AbstractFragmentCallback

This method should be called in the onSuccess or onFailure methods of subclasses.

getHandler() - Method in class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

getHandler() - Method in interface org.jboss.aerogear.android.pipe.Pipe

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

getHandler() - Method in class org.jboss.aerogear.android.pipe.rest.RestAdapter

getHeader(String) - Method in class org.jboss.aerogear.android.pipe.http.HeaderAndBody

getHeaders() - Method in exception org.jboss.aerogear.android.pipe.http.HttpException

getHeaders() - Method in class org.jboss.aerogear.android.pipe.module.AuthorizationFields

getHeaders() - Method in class org.jboss.aerogear.android.pipe.module.ModuleFields

getInputStream() - Method in class org.jboss.aerogear.android.pipe.rest.multipart.TypeAndStream

getKlass() - Method in class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

getKlass() - Method in interface org.jboss.aerogear.android.pipe.Pipe

getKlass() - Method in class org.jboss.aerogear.android.pipe.rest.RestAdapter

getLimitValue() - Method in class org.jboss.aerogear.android.pipe.paging.PageConfig

LimitValue is the maximum number of results the server should return (default: 10)

getMarshallingConfig() - Method in interface org.jboss.aerogear.android.pipe.RequestBuilder

The marshalling config sets options for reading and processing data

getMarshallingConfig() - Method in interface org.jboss.aerogear.android.pipe.ResponseParser

The marshalling config sets options for reading and processing data

getMarshallingConfig() - Method in class org.jboss.aerogear.android.pipe.rest.gson.GsonRequestBuilder

The marshalling config sets options for reading and processing data

getMarshallingConfig() - Method in class org.jboss.aerogear.android.pipe.rest.gson.GsonResponseParser

The marshalling config sets options for reading and processing data

getMarshallingConfig() - Method in class org.jboss.aerogear.android.pipe.rest.multipart.MultipartRequestBuilder

getMetadataLocation() - Method in class org.jboss.aerogear.android.pipe.paging.PageConfig

MetadataLocation indicates whether paging information is received from the response header, the response body (body) or via RFC 5988 (webLinking), which is the default

getMimeType() - Method in class org.jboss.aerogear.android.pipe.rest.multipart.TypeAndStream

getModules() - Method in class org.jboss.aerogear.android.pipe.PipeConfiguration

Modules are bits of functionality which are called during a Pipes lifecycle.

getModules() - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

getName() - Method in class org.jboss.aerogear.android.pipe.PipeConfiguration

The name is the key which is used to reference the created pipe in PipeManager.

getName() - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

getNextFilter(HeaderAndBody, T) - Method in interface org.jboss.aerogear.android.pipe.paging.PageParameterExtractor

Extracts a usable ReadFilter from the response of a server for the "next" result set.

getNextFilter(HeaderAndBody, PageConfig) - Method in class org.jboss.aerogear.android.pipe.paging.URIBodyPageParser

getNextFilter(HeaderAndBody, PageConfig) - Method in class org.jboss.aerogear.android.pipe.paging.URIPageHeaderParser

getNextFilter() - Method in class org.jboss.aerogear.android.pipe.paging.WrappingPagedList

getNextIdentifier() - Method in class org.jboss.aerogear.android.pipe.paging.PageConfig

NextIdentifier names the element containing data for the next page (default: next)

getOffsetValue() - Method in class org.jboss.aerogear.android.pipe.paging.PageConfig

OffsetValue is the offset of the first element that should be included in the returned collection (default: 0)

getOnPipeCreatedListeners() - Method in class org.jboss.aerogear.android.pipe.PipeConfiguration

OnPipeCreatedListseners are a collection of classes to be notified when the configuration of the Pipe is complete.

getPageConfig() - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

getPageParameterExtractor() - Method in class org.jboss.aerogear.android.pipe.paging.PageConfig

PageParameterExtractor is the a PageParameterExtractor which parses the response and provides data to a Pipe for the "next" and "previous" pages.

getParameterProvider() - Method in class org.jboss.aerogear.android.pipe.paging.PageConfig

The ParameterProvider for paging.

getParameters(ReadFilter) - Method in class org.jboss.aerogear.android.pipe.paging.DefaultParameterProvider

getParameters(ReadFilter) - Method in interface org.jboss.aerogear.android.pipe.paging.ParameterProvider

getParameters() - Method in class org.jboss.aerogear.android.pipe.paging.WebLink

getPipe(String) - Static method in class org.jboss.aerogear.android.pipe.PipeManager

Fetches a named pipe

getPipe(String, Activity) - Static method in class org.jboss.aerogear.android.pipe.PipeManager

Look up for a pipe object.

getPipe(String, Fragment, Context) - Static method in class org.jboss.aerogear.android.pipe.PipeManager

Look up for a pipe object.

getPipeHandler() - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

getPreviousFilter(HeaderAndBody, T) - Method in interface org.jboss.aerogear.android.pipe.paging.PageParameterExtractor

Extracts a usable ReadFilter from the response of a server for the "previous" result set.

getPreviousFilter(HeaderAndBody, PageConfig) - Method in class org.jboss.aerogear.android.pipe.paging.URIBodyPageParser

getPreviousFilter(HeaderAndBody, PageConfig) - Method in class org.jboss.aerogear.android.pipe.paging.URIPageHeaderParser

getPreviousFilter() - Method in class org.jboss.aerogear.android.pipe.paging.WrappingPagedList

getPreviousIdentifier() - Method in class org.jboss.aerogear.android.pipe.paging.PageConfig

PreviousIdentifier names the element containing data for the previous page (default: previous)

getQueryParameters() - Method in class org.jboss.aerogear.android.pipe.module.AuthorizationFields

getQueryParameters() - Method in class org.jboss.aerogear.android.pipe.module.ModuleFields

getRequestBuilder() - Method in class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

getRequestBuilder() - Method in interface org.jboss.aerogear.android.pipe.Pipe

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

getRequestBuilder() - Method in class org.jboss.aerogear.android.pipe.rest.RestAdapter

getRequestBuilder() - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

getRequestBuilder() - Method in class org.jboss.aerogear.android.pipe.rest.RestRunner

getResponseParser() - Method in class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

getResponseParser() - Method in interface org.jboss.aerogear.android.pipe.Pipe

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

getResponseParser() - Method in class org.jboss.aerogear.android.pipe.rest.RestAdapter

getResponseParser() - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

getStatusCode() - Method in exception org.jboss.aerogear.android.pipe.http.HttpException

getTimeout() - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

getUri() - Method in class org.jboss.aerogear.android.pipe.paging.WebLink

getUrl() - Method in interface org.jboss.aerogear.android.pipe.http.HttpProvider

getUrl() - Method in class org.jboss.aerogear.android.pipe.http.HttpRestProvider

getUrl() - Method in class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

getUrl() - Method in interface org.jboss.aerogear.android.pipe.Pipe

Returns the URL to which this Pipe object points.

getUrl() - Method in class org.jboss.aerogear.android.pipe.rest.RestAdapter

Returns the URL to which this Pipe object points.

getUrl() - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

GsonRequestBuilder<T> - Class in org.jboss.aerogear.android.pipe.rest.gson

GsonRequestBuilder() - Constructor for class org.jboss.aerogear.android.pipe.rest.gson.GsonRequestBuilder

GsonRequestBuilder(Gson) - Constructor for class org.jboss.aerogear.android.pipe.rest.gson.GsonRequestBuilder

GsonResponseParser<T> - Class in org.jboss.aerogear.android.pipe.rest.gson

GsonResponseParser() - Constructor for class org.jboss.aerogear.android.pipe.rest.gson.GsonResponseParser

GsonResponseParser(Gson) - Constructor for class org.jboss.aerogear.android.pipe.rest.gson.GsonResponseParser

H

handleError(HttpException) - Method in interface org.jboss.aerogear.android.pipe.module.PipeModule

This will try to resolve an error.

handleResponse(HeaderAndBody, Class<T>) - Method in interface org.jboss.aerogear.android.pipe.ResponseParser

UnMarshall a response and return an object array.

handleResponse(HeaderAndBody, Class<T>) - Method in class org.jboss.aerogear.android.pipe.rest.gson.GsonResponseParser

hasException() - Method in class org.jboss.aerogear.android.pipe.loader.AbstractPipeLoader

hashCode() - Method in class org.jboss.aerogear.android.pipe.callback.AbstractCallback

hashCode() - Method in class org.jboss.aerogear.android.pipe.rest.multipart.TypeAndStream

HeaderAndBody - Class in org.jboss.aerogear.android.pipe.http

This is a convenience to wrap up headers from a HTTPResponse with its entity.

HeaderAndBody(byte[], Map<String, Object>) - Constructor for class org.jboss.aerogear.android.pipe.http.HeaderAndBody

HttpException - Exception in org.jboss.aerogear.android.pipe.http

If an HTTP Request does not return status code 200 then this will be thrown.

HttpException(byte[], int) - Constructor for exception org.jboss.aerogear.android.pipe.http.HttpException

HttpException(byte[], int, Map<String, String>) - Constructor for exception org.jboss.aerogear.android.pipe.http.HttpException

HttpException(byte[], int, String) - Constructor for exception org.jboss.aerogear.android.pipe.http.HttpException

HttpException(byte[], int, String, Map<String, String>) - Constructor for exception org.jboss.aerogear.android.pipe.http.HttpException

HttpProvider - Interface in org.jboss.aerogear.android.pipe.http

A suite a convenience functions which wrap and clean up common HTTP request operations.

HttpProviderFactory - Class in org.jboss.aerogear.android.pipe.http

HttpProviderFactory() - Constructor for class org.jboss.aerogear.android.pipe.http.HttpProviderFactory

HttpRestProvider - Class in org.jboss.aerogear.android.pipe.http

These are tuned for AeroGear, assume the body is String data, and that the headers don't do anything funny.

HttpRestProvider(URL) - Constructor for class org.jboss.aerogear.android.pipe.http.HttpRestProvider

HttpRestProvider(URL, Integer) - Constructor for class org.jboss.aerogear.android.pipe.http.HttpRestProvider

I

IdReadLoader<T> - Class in org.jboss.aerogear.android.pipe.loader

This class performs a read by id operation on behalf of a Pipe using the Loader infrastructure.

IdReadLoader(Context, Callback<List<T>>, PipeHandler<T>, ReadFilter, Pipe<T>) - Constructor for class org.jboss.aerogear.android.pipe.loader.IdReadLoader

ITEM - Static variable in interface org.jboss.aerogear.android.pipe.LoaderPipe

Bundle key for the item to be saved

L

LoaderAdapter<T> - Class in org.jboss.aerogear.android.pipe.loader

This class wraps a Pipe in an asynchronous Loader.

LoaderAdapter(Activity, Pipe<T>, String) - Constructor for class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

LoaderAdapter(Fragment, Context, Pipe<T>, String) - Constructor for class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

LoaderAdapter.CallbackHandler<T> - Class in org.jboss.aerogear.android.pipe.loader

LoaderPipe<T> - Interface in org.jboss.aerogear.android.pipe

Sometimes a Pipe will actually be wrapped in a Loader.

loadInBackground() - Method in class org.jboss.aerogear.android.pipe.loader.ReadLoader

loadInBackground() - Method in class org.jboss.aerogear.android.pipe.loader.RemoveLoader

loadInBackground() - Method in class org.jboss.aerogear.android.pipe.loader.SaveLoader

loadModule(URI, String, byte[]) - Method in interface org.jboss.aerogear.android.pipe.module.PipeModule

When construction a HTTP request, the module can prepare several parameters to be applied to the request body, query, and headers.

M

MarshallingConfig - Class in org.jboss.aerogear.android.pipe

This class holds configuration data used by requestBuilders and response parsers to manage data.

MarshallingConfig() - Constructor for class org.jboss.aerogear.android.pipe.MarshallingConfig

MetadataLocation - Interface in org.jboss.aerogear.android.pipe.paging

A marker interface for PageConfig which describes where to find paging metadata in a response.

METHOD - Static variable in interface org.jboss.aerogear.android.pipe.LoaderPipe

Bundle key for the Pipe method which was called

module(PipeModule) - Method in class org.jboss.aerogear.android.pipe.PipeConfiguration

Modules are bits of functionality which are called during a Pipes lifecycle.

module(PipeModule) - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

ModuleFields - Class in org.jboss.aerogear.android.pipe.module

This class encapsulates the possible extra fields which may be applied to a request by a module

ModuleFields() - Constructor for class org.jboss.aerogear.android.pipe.module.ModuleFields

MultipartRequestBuilder<T> - Class in org.jboss.aerogear.android.pipe.rest.multipart

This class generates a Multipart request with the type multipart/form-data It will load the entire contents of files into memory before it uploads them.

MultipartRequestBuilder() - Constructor for class org.jboss.aerogear.android.pipe.rest.multipart.MultipartRequestBuilder

N

newConfiguration() - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfigurationProvider

Returns a new instance of RestfulPipeConfiguration

next(Callback<List<T>>) - Method in interface org.jboss.aerogear.android.pipe.paging.PagedList

Retrieve the next result set.

next(Callback<List<T>>) - Method in class org.jboss.aerogear.android.pipe.paging.WrappingPagedList

O

onCreateLoader(int, Bundle) - Method in class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

onLoaderReset(Loader<HeaderAndBody>) - Method in class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

onLoadFinished(Loader<HeaderAndBody>, HeaderAndBody) - Method in class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

onPipeCreated(PipeConfiguration<?>, Pipe<?>) - Method in interface org.jboss.aerogear.android.pipe.OnPipeCreatedListener

A method called when Pipes are created.

OnPipeCreatedListener - Interface in org.jboss.aerogear.android.pipe

A Listener called when pipes are created.

onRawRead(Pipe<T>, String) - Method in interface org.jboss.aerogear.android.pipe.PipeHandler

This method fetches a resource with an id on behalf of a Pipe.

onRawRead(Pipe<T>) - Method in interface org.jboss.aerogear.android.pipe.PipeHandler

This method fetches a resource on behalf of a Pipe.

onRawRead(Pipe<T>, String) - Method in class org.jboss.aerogear.android.pipe.rest.RestRunner

onRawRead(Pipe<T>) - Method in class org.jboss.aerogear.android.pipe.rest.RestRunner

onRawReadWithFilter(ReadFilter, Pipe<T>) - Method in interface org.jboss.aerogear.android.pipe.PipeHandler

This method fetches a resource with an filter on behalf of a Pipe.

onRawReadWithFilter(ReadFilter, Pipe<T>) - Method in class org.jboss.aerogear.android.pipe.rest.RestRunner

onRawSave(String, byte[]) - Method in interface org.jboss.aerogear.android.pipe.PipeHandler

This method will save data for a Pipe.

onRawSave(String, byte[]) - Method in class org.jboss.aerogear.android.pipe.rest.RestRunner

onRemove(String) - Method in interface org.jboss.aerogear.android.pipe.PipeHandler

This method removes a resource with the id.

onRemove(String) - Method in class org.jboss.aerogear.android.pipe.rest.RestRunner

onReset() - Method in class org.jboss.aerogear.android.pipe.loader.AbstractPipeLoader

onReset() - Method in class org.jboss.aerogear.android.pipe.loader.ReadLoader

onStartLoading() - Method in class org.jboss.aerogear.android.pipe.loader.ReadLoader

onStartLoading() - Method in class org.jboss.aerogear.android.pipe.loader.RemoveLoader

onStartLoading() - Method in class org.jboss.aerogear.android.pipe.loader.SaveLoader

org.jboss.aerogear.android.pipe - package org.jboss.aerogear.android.pipe

org.jboss.aerogear.android.pipe.callback - package org.jboss.aerogear.android.pipe.callback

org.jboss.aerogear.android.pipe.http - package org.jboss.aerogear.android.pipe.http

org.jboss.aerogear.android.pipe.loader - package org.jboss.aerogear.android.pipe.loader

org.jboss.aerogear.android.pipe.module - package org.jboss.aerogear.android.pipe.module

org.jboss.aerogear.android.pipe.paging - package org.jboss.aerogear.android.pipe.paging

org.jboss.aerogear.android.pipe.rest - package org.jboss.aerogear.android.pipe.rest

org.jboss.aerogear.android.pipe.rest.gson - package org.jboss.aerogear.android.pipe.rest.gson

org.jboss.aerogear.android.pipe.rest.multipart - package org.jboss.aerogear.android.pipe.rest.multipart

org.jboss.aerogear.android.pipe.util - package org.jboss.aerogear.android.pipe.util

P

PageConfig - Class in org.jboss.aerogear.android.pipe.paging

PageConfig() - Constructor for class org.jboss.aerogear.android.pipe.paging.PageConfig

pageConfig(PageConfig) - Method in class org.jboss.aerogear.android.pipe.PipeConfiguration

Paging is controlled and managed by the pageConfig objects

pageConfig(PageConfig) - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

PageConfig.MetadataLocations - Enum in org.jboss.aerogear.android.pipe.paging

PagedList<T> - Interface in org.jboss.aerogear.android.pipe.paging

This class wraps a result and provides methods for retrieving the next and previous result sets.

PageParameterExtractor<T extends PageConfig> - Interface in org.jboss.aerogear.android.pipe.paging

Classes which implement this interface are responsible for consuming a response from a server and extracting paging information (if any).

ParameterProvider - Interface in org.jboss.aerogear.android.pipe.paging

Classes which implement this interface should provide the necessary parameters for paging to a Pipe's read request.

parse(String) - Static method in class org.jboss.aerogear.android.pipe.util.WebLinkParser

ParseException - Exception in org.jboss.aerogear.android.pipe.util

This exception is thrown by something which parses if parsing fails(ex WebLinkParser)

ParseException(String) - Constructor for exception org.jboss.aerogear.android.pipe.util.ParseException

Pipe<T> - Interface in org.jboss.aerogear.android.pipe

A Pipe represents a server connection.

PipeConfiguration<CONFIGURATION extends PipeConfiguration<CONFIGURATION>> - Class in org.jboss.aerogear.android.pipe

This is the top level PipeConfiguration class.

PipeConfiguration() - Constructor for class org.jboss.aerogear.android.pipe.PipeConfiguration

PipeHandler<T> - Interface in org.jboss.aerogear.android.pipe

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

pipeHandler(PipeHandler) - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

PipeManager - Class in org.jboss.aerogear.android.pipe

A Manager which handles the registration of configurations and references to created pipes.

PipeModule - Interface in org.jboss.aerogear.android.pipe.module

A PipeModule allows special actions to be taken during certain phases of the Pipe life cycle.

post(String) - Method in interface org.jboss.aerogear.android.pipe.http.HttpProvider

Issues an HTTP request, consumes the content, and cleans up after itself.

post(byte[]) - Method in interface org.jboss.aerogear.android.pipe.http.HttpProvider

Issues an HTTP request, consumes the content, and cleans up after itself.

post(String) - Method in class org.jboss.aerogear.android.pipe.http.HttpRestProvider

Issues an HTTP request, consumes the content, and cleans up after itself.

post(byte[]) - Method in class org.jboss.aerogear.android.pipe.http.HttpRestProvider

Issues an HTTP request, consumes the content, and cleans up after itself.

previous(Callback<List<T>>) - Method in interface org.jboss.aerogear.android.pipe.paging.PagedList

Retrieve the previous result set.

previous(Callback<List<T>>) - Method in class org.jboss.aerogear.android.pipe.paging.WrappingPagedList

put(String, String) - Method in interface org.jboss.aerogear.android.pipe.http.HttpProvider

Issues an HTTP request, consumes the content, and cleans up after itself.

put(String, byte[]) - Method in interface org.jboss.aerogear.android.pipe.http.HttpProvider

Issues an HTTP request, consumes the content, and cleans up after itself.

put(String, String) - Method in class org.jboss.aerogear.android.pipe.http.HttpRestProvider

Issues an HTTP request, consumes the content, and cleans up after itself.

put(String, byte[]) - Method in class org.jboss.aerogear.android.pipe.http.HttpRestProvider

Issues an HTTP request, consumes the content, and cleans up after itself.

R

read(String, Callback<T>) - Method in class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

read(Callback<List<T>>) - Method in class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

read(ReadFilter, Callback<List<T>>) - Method in class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

read(String, Callback<T>) - Method in interface org.jboss.aerogear.android.pipe.Pipe

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

read(Callback<List<T>>) - Method in interface org.jboss.aerogear.android.pipe.Pipe

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

read(ReadFilter, Callback<List<T>>) - Method in interface org.jboss.aerogear.android.pipe.Pipe

Reads all the data from the underlying server connection.

read(String, Callback<T>) - Method in class org.jboss.aerogear.android.pipe.rest.RestAdapter

read(ReadFilter, Callback<List<T>>) - Method in class org.jboss.aerogear.android.pipe.rest.RestAdapter

read(Callback<List<T>>) - Method in class org.jboss.aerogear.android.pipe.rest.RestAdapter

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

ReadLoader<T> - Class in org.jboss.aerogear.android.pipe.loader

This class performs a read operation on behalf of a Pipe using the Loader infrastructure.

ReadLoader(Context, Callback<List<T>>, PipeHandler<T>, ReadFilter, Pipe<T>) - Constructor for class org.jboss.aerogear.android.pipe.loader.ReadLoader

registerConfigurationProvider(Class<CFG>, ConfigurationProvider<CFG>) - Static method in class org.jboss.aerogear.android.pipe.PipeManager

This will add a new Configuration that this Manager can build Configurations for.

remove(String, Callback<Void>) - Method in class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

remove(String, Callback<Void>) - Method in interface org.jboss.aerogear.android.pipe.Pipe

Removes an object from the underlying server connection.

remove(String, Callback<Void>) - Method in class org.jboss.aerogear.android.pipe.rest.RestAdapter

Removes an object from the underlying server connection.

REMOVE_ID - Static variable in interface org.jboss.aerogear.android.pipe.LoaderPipe

Bundle key for the id of the item to remove

RemoveLoader<T> - Class in org.jboss.aerogear.android.pipe.loader

This class performs a remove operation on behalf of a Pipe using the Loader infrastructure.

RemoveLoader(Context, Callback<T>, PipeHandler<T>, String) - Constructor for class org.jboss.aerogear.android.pipe.loader.RemoveLoader

requestBuilder(RequestBuilder) - Method in class org.jboss.aerogear.android.pipe.PipeConfiguration

Request builders are responsible for serializing the objects provided to the Pipe into binary streams for consumption by a service.

RequestBuilder<T> - Interface in org.jboss.aerogear.android.pipe

requestBuilder(RequestBuilder) - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

reset() - Method in class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

reset() - Method in interface org.jboss.aerogear.android.pipe.LoaderPipe

Calls reset on all loaders associated with this pipe.

responseParser(ResponseParser) - Method in class org.jboss.aerogear.android.pipe.PipeConfiguration

Response Parsers turn service responses into Objects for the Pipe.

ResponseParser<T> - Interface in org.jboss.aerogear.android.pipe

responseParser(ResponseParser) - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

RestAdapter<T> - Class in org.jboss.aerogear.android.pipe.rest

Rest implementation of Pipe.

RestAdapter(Class<T>, URL) - Constructor for class org.jboss.aerogear.android.pipe.rest.RestAdapter

This will configure the Adapter as with sane RESTful defaults.

RestAdapter(Class<T>, URL, RestfulPipeConfiguration) - Constructor for class org.jboss.aerogear.android.pipe.rest.RestAdapter

This will build an adapter based on a configuration.

RestfulPipeConfiguration - Class in org.jboss.aerogear.android.pipe.rest

Configures a Pipe which interacts with RESTful endpoints.

RestfulPipeConfiguration() - Constructor for class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

RestfulPipeConfigurationProvider - Class in org.jboss.aerogear.android.pipe.rest

This provides the configuration for RestfulPipeConfiguration

RestfulPipeConfigurationProvider() - Constructor for class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfigurationProvider

RestRunner<T> - Class in org.jboss.aerogear.android.pipe.rest

RestRunner(Class<T>, URL) - Constructor for class org.jboss.aerogear.android.pipe.rest.RestRunner

run() - Method in class org.jboss.aerogear.android.pipe.loader.LoaderAdapter.CallbackHandler

S

save(T, Callback<T>) - Method in class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

save(T, Callback<T>) - Method in interface org.jboss.aerogear.android.pipe.Pipe

Saves or updates a given object on the server.

save(T, Callback<T>) - Method in class org.jboss.aerogear.android.pipe.rest.RestAdapter

SAVE_ID - Static variable in interface org.jboss.aerogear.android.pipe.LoaderPipe

Bundle key for the id of the item to save

SaveLoader<T> - Class in org.jboss.aerogear.android.pipe.loader

This class performs a save operation on behalf of a Pipe using the Loader infrastructure.

SaveLoader(Context, Callback<T>, PipeHandler<T>, byte[], String) - Constructor for class org.jboss.aerogear.android.pipe.loader.SaveLoader

setActivity(Activity) - Method in class org.jboss.aerogear.android.pipe.callback.AbstractActivityCallback

This method is called by AbstractPipeLoader during the onLoadComplete method before onSuccess or onFailure are called.

setDataRoot(String) - Method in class org.jboss.aerogear.android.pipe.MarshallingConfig

DataRoot refers to the dotted location of the result we are interested in from the JSON response from the server.

setDefaultHeader(String, String) - Method in interface org.jboss.aerogear.android.pipe.http.HttpProvider

Will set a default header value to be used on all calls

setDefaultHeader(String, String) - Method in class org.jboss.aerogear.android.pipe.http.HttpRestProvider

setEncoding(Charset) - Method in class org.jboss.aerogear.android.pipe.MarshallingConfig

Encoding is the data encoding of the http body.

setFragment(Fragment) - Method in class org.jboss.aerogear.android.pipe.callback.AbstractFragmentCallback

This method is called by AbstractPipeLoader or AbstractAuthenticationLoader during the onLoadComplete method before onSuccess or onFailure are called.

setHeader(String, Object) - Method in class org.jboss.aerogear.android.pipe.http.HeaderAndBody

setHeaders(List<Pair<String, String>>) - Method in class org.jboss.aerogear.android.pipe.module.AuthorizationFields

setHeaders(List<Pair<String, String>>) - Method in class org.jboss.aerogear.android.pipe.module.ModuleFields

setLimitValue(Integer) - Method in class org.jboss.aerogear.android.pipe.paging.PageConfig

LimitValue is the maximum number of results the server should return (default: 10)

setLoaderIds(Map<String, List<Integer>>) - Method in class org.jboss.aerogear.android.pipe.loader.LoaderAdapter

setLoaderIds(Map<String, List<Integer>>) - Method in interface org.jboss.aerogear.android.pipe.LoaderPipe

Passes in a multimap of ids for the named pipe.

setMarshallingConfig(MarshallingConfig) - Method in class org.jboss.aerogear.android.pipe.rest.gson.GsonRequestBuilder

setMarshallingConfig(MarshallingConfig) - Method in class org.jboss.aerogear.android.pipe.rest.gson.GsonResponseParser

setMarshallingConfig(MarshallingConfig) - Method in class org.jboss.aerogear.android.pipe.rest.multipart.MultipartRequestBuilder

setMetadataLocation(MetadataLocation) - Method in class org.jboss.aerogear.android.pipe.paging.PageConfig

MetadataLocation indicates whether paging information is received from the response header, the response body (body) or via RFC 5988 (webLinking), which is the default

setName(String) - Method in class org.jboss.aerogear.android.pipe.PipeConfiguration

The name is the key which is used to reference the created pipe in PipeManager.

setName(String) - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

setNextIdentifier(String) - Method in class org.jboss.aerogear.android.pipe.paging.PageConfig

NextIdentifier names the element containing data for the next page (default: next)

setOffsetValue(String) - Method in class org.jboss.aerogear.android.pipe.paging.PageConfig

OffsetValue is the offset of the first element that should be included in the returned collection (default: 0)

setOnPipeCreatedListeners(Collection<OnPipeCreatedListener>) - Method in class org.jboss.aerogear.android.pipe.PipeConfiguration

OnPipeCreatedListseners are a collection of classes to be notified when the configuration of the Pipe is complete.

setPageParameterExtractor(PageParameterExtractor) - Method in class org.jboss.aerogear.android.pipe.paging.PageConfig

PageParameterExtractor is the a PageParameterExtractor which parses the response and provides data to a Pipe for the "next" and "previous" pages.

setParameterProvider(ParameterProvider) - Method in class org.jboss.aerogear.android.pipe.paging.PageConfig

The ParameterProvider for paging.

setPreviousIdentifier(String) - Method in class org.jboss.aerogear.android.pipe.paging.PageConfig

PreviousIdentifier names the element containing data for the previous page (default: previous)

setQueryParameters(List<Pair<String, String>>) - Method in class org.jboss.aerogear.android.pipe.module.AuthorizationFields

setQueryParameters(List<Pair<String, String>>) - Method in class org.jboss.aerogear.android.pipe.module.ModuleFields

T

THREAD_POOL_EXECUTOR - Static variable in class org.jboss.aerogear.android.pipe.rest.RestAdapter

timeout(Integer) - Method in class org.jboss.aerogear.android.pipe.PipeConfiguration

Because of their async nature, Pipes need to have a timeout which will error if reached.

timeout(Integer) - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

toString() - Method in enum org.jboss.aerogear.android.pipe.paging.PageConfig.MetadataLocations

toString() - Method in class org.jboss.aerogear.android.pipe.rest.multipart.TypeAndStream

TypeAndStream - Class in org.jboss.aerogear.android.pipe.rest.multipart

Convenience Wrapper for posting multipart files

TypeAndStream(String, String, InputStream) - Constructor for class org.jboss.aerogear.android.pipe.rest.multipart.TypeAndStream

U

URIBodyPageParser - Class in org.jboss.aerogear.android.pipe.paging

This class assumes the response body paging properties are URI's and parses them accordingly.

URIBodyPageParser(URI) - Constructor for class org.jboss.aerogear.android.pipe.paging.URIBodyPageParser

URIBodyPageParser(URL) - Constructor for class org.jboss.aerogear.android.pipe.paging.URIBodyPageParser

URIBodyPageParser() - Constructor for class org.jboss.aerogear.android.pipe.paging.URIBodyPageParser

URIPageHeaderParser - Class in org.jboss.aerogear.android.pipe.paging

This class assumes the header responses in a response are URI's and parses them accordingly.

URIPageHeaderParser(URI) - Constructor for class org.jboss.aerogear.android.pipe.paging.URIPageHeaderParser

URIPageHeaderParser(URL) - Constructor for class org.jboss.aerogear.android.pipe.paging.URIPageHeaderParser

URIPageHeaderParser() - Constructor for class org.jboss.aerogear.android.pipe.paging.URIPageHeaderParser

UrlUtils - Class in org.jboss.aerogear.android.pipe.util

V

valueOf(String) - Static method in enum org.jboss.aerogear.android.pipe.paging.PageConfig.MetadataLocations

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.jboss.aerogear.android.pipe.paging.PageConfig.MetadataLocations

Returns an array containing the constants of this enum type, in the order they are declared.

W

WebLink - Class in org.jboss.aerogear.android.pipe.paging

This class represents a "Link" header link.

WebLink(String) - Constructor for class org.jboss.aerogear.android.pipe.paging.WebLink

Attempts to parse a header value into a WebLink.

WebLinkParser - Class in org.jboss.aerogear.android.pipe.util

A utility class to parse WebLink headers.

WebLinkParser() - Constructor for class org.jboss.aerogear.android.pipe.util.WebLinkParser

withUrl(URL) - Method in class org.jboss.aerogear.android.pipe.PipeConfiguration

The URL is a location of some resource or service the Pipe will interact with.

withUrl(URL) - Method in class org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

WrappingPagedList<T> - Class in org.jboss.aerogear.android.pipe.paging

Wraps a resultSet in a ForwardingList and provides paging methods.

WrappingPagedList(Pipe<T>, List<T>, ReadFilter, ReadFilter) - Constructor for class org.jboss.aerogear.android.pipe.paging.WrappingPagedList

A B C D E F G H I L M N O P R S T U V W