org.jboss.aerogear.android.pipe.rest

Class RestfulPipeConfiguration

java.lang.Object

org.jboss.aerogear.android.pipe.PipeConfiguration<RestfulPipeConfiguration>

org.jboss.aerogear.android.pipe.rest.RestfulPipeConfiguration

All Implemented Interfaces:

org.jboss.aerogear.android.core.Config<RestfulPipeConfiguration>

public class RestfulPipeConfiguration
extends PipeConfiguration<RestfulPipeConfiguration>
implements org.jboss.aerogear.android.core.Config<RestfulPipeConfiguration>

Configures a Pipe which interacts with RESTful endpoints.

Constructor Summary

Constructors

Constructor and Description
RestfulPipeConfiguration()

Method Summary

Modifier and Type	Method and Description
protected <DATA> Pipe<DATA>	buildPipeForClass(Class<DATA> aClass) Validates configuration parameters and returns a Pipe instance.
List<PipeModule>	getModules() Modules are bits of functionality which are called during a Pipes lifecycle.
String	getName() The name is the key which is used to reference the created pipe in PipeManager.
PageConfig	getPageConfig()
PipeHandler	getPipeHandler()
RequestBuilder	getRequestBuilder()
ResponseParser	getResponseParser()
Integer	getTimeout()
URL	getUrl()
RestfulPipeConfiguration	module(PipeModule module) Modules are bits of functionality which are called during a Pipes lifecycle.
RestfulPipeConfiguration	pageConfig(PageConfig pageConfig) Paging is controlled and managed by the pageConfig objects
RestfulPipeConfiguration	pipeHandler(PipeHandler handler)
RestfulPipeConfiguration	requestBuilder(RequestBuilder requestBuilder) Request builders are responsible for serializing the objects provided to the Pipe into binary streams for consumption by a service.
RestfulPipeConfiguration	responseParser(ResponseParser responseParser) Response Parsers turn service responses into Objects for the Pipe.
RestfulPipeConfiguration	setName(String name) The name is the key which is used to reference the created pipe in PipeManager.
RestfulPipeConfiguration	timeout(Integer timeout) Because of their async nature, Pipes need to have a timeout which will error if reached.
RestfulPipeConfiguration	withUrl(URL url) The URL is a location of some resource or service the Pipe will interact with.

Methods inherited from class org.jboss.aerogear.android.pipe.PipeConfiguration

addOnPipeCreatedListener, forClass, getOnPipeCreatedListeners, setOnPipeCreatedListeners

Methods inherited from class java.lang.Object

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

Constructor Detail

RestfulPipeConfiguration

public RestfulPipeConfiguration()

Method Detail

getName

public String getName()

Description copied from class: PipeConfiguration

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

Specified by:

getName in interface org.jboss.aerogear.android.core.Config<RestfulPipeConfiguration>

Overrides:

getName in class PipeConfiguration<RestfulPipeConfiguration>

Returns:

the current name

setName

public RestfulPipeConfiguration setName(String name)

Description copied from class: PipeConfiguration

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

Specified by:

setName in interface org.jboss.aerogear.android.core.Config<RestfulPipeConfiguration>

Overrides:

setName in class PipeConfiguration<RestfulPipeConfiguration>

Parameters:

name - new name

Returns:

this configuration for chaining.

buildPipeForClass

protected <DATA> Pipe<DATA> buildPipeForClass(Class<DATA> aClass)

Description copied from class: PipeConfiguration

Validates configuration parameters and returns a Pipe instance.

Specified by:

buildPipeForClass in class PipeConfiguration<RestfulPipeConfiguration>

Type Parameters:

DATA - The data type of the Pipe

Parameters:

aClass - The data type class of the Pipe

Returns:

A pipe based on this configuration

withUrl

public RestfulPipeConfiguration withUrl(URL url)

Description copied from class: PipeConfiguration

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

Specified by:

withUrl in class PipeConfiguration<RestfulPipeConfiguration>

Parameters:

url - the base URL the pipe will build upon.

Returns:

this configuration

module

public RestfulPipeConfiguration module(PipeModule module)

Description copied from class: PipeConfiguration

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

Specified by:

module in class PipeConfiguration<RestfulPipeConfiguration>

Parameters:

module - a module to add to the lifecycle.

Returns:

this configuration

getModules

public List<PipeModule> getModules()

Description copied from class: PipeConfiguration

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

Specified by:

getModules in class PipeConfiguration<RestfulPipeConfiguration>

Returns:

the current List of Modules

timeout

public RestfulPipeConfiguration timeout(Integer timeout)

Description copied from class: PipeConfiguration

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

Specified by:

timeout in class PipeConfiguration<RestfulPipeConfiguration>

Parameters:

timeout - an amount of time in milliseconds.

Returns:

this configuration

pageConfig

public RestfulPipeConfiguration pageConfig(PageConfig pageConfig)

Description copied from class: PipeConfiguration

Paging is controlled and managed by the pageConfig objects

Specified by:

pageConfig in class PipeConfiguration<RestfulPipeConfiguration>

Parameters:

pageConfig - a pageConfiguration

Returns:

this configuration

requestBuilder

public RestfulPipeConfiguration requestBuilder(RequestBuilder requestBuilder)

Description copied from class: PipeConfiguration

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

Specified by:

requestBuilder in class PipeConfiguration<RestfulPipeConfiguration>

Parameters:

requestBuilder - the requestBuilder

Returns:

this configuration

responseParser

public RestfulPipeConfiguration responseParser(ResponseParser responseParser)

Description copied from class: PipeConfiguration

Response Parsers turn service responses into Objects for the Pipe.

Specified by:

responseParser in class PipeConfiguration<RestfulPipeConfiguration>

Parameters:

responseParser - a resonse Parser instance

Returns:

this configuration

pipeHandler

public RestfulPipeConfiguration pipeHandler(PipeHandler handler)

getPipeHandler

public PipeHandler getPipeHandler()

getTimeout

public Integer getTimeout()

getRequestBuilder

public RequestBuilder getRequestBuilder()

getResponseParser

public ResponseParser getResponseParser()

getPageConfig

public PageConfig getPageConfig()

getUrl

public URL getUrl()