PipeConfig (AeroGear Android Library 1.4.0 API)

java.lang.Object
- org.jboss.aerogear.android.impl.pipeline.PipeConfig

```
public final class PipeConfig
extends Object
```
Specifies configurations for Pipe to be build by Pipeline

Constructor Summary

Constructors
Constructor and Description

PipeConfig(URL baseURL, Class klass)

Constructors
Constructor and Description
`PipeConfig(URL baseURL, Class klass)`

Method Summary

Methods
Modifier and Type	Method and Description
`AuthenticationModule`	`getAuthModule()`
`AuthzModule`	`getAuthzModule()`
`URL`	`getBaseURL()`
`String`	`getDataRoot()` Deprecated. use `MarshallingConfig.getDataRoot()` instead
`Charset`	`getEncoding()` Deprecated. Use `MarshallingConfig.getEncoding()` instead
`String`	`getEndpoint()`
`com.google.gson.GsonBuilder`	`getGsonBuilder()` Deprecated. Pipes are moving to a more generic RequestBuilder interface. `GsonRequestBuilder`
`PipeHandler`	`getHandler()`
`String`	`getName()`
`PageConfig`	`getPageConfig()` PageConfig is the configuration information for Paging.
`RequestBuilder`	`getRequestBuilder()` A request builder is responsible for turning an object into a request used in a Pipe's save methods.
`ResponseParser`	`getResponseParser()` A ResponseParser is responsible for parsing a String value of the response from a remote source into a object instance.
`Integer`	`getTimeout()` Timeout is the length of time in milliseconds that a Pipe will wait for a response from a call to read, save or remove
`PipeType`	`getType()`
`void`	`setAuthModule(AuthenticationModule authModule)` This value must be set to use Authentication in Pipes build from this config.
`void`	`setAuthzModule(AuthzModule authzModule)`
`void`	`setBaseURL(URL baseURL)` Change the URL which Endpoints are appended to.
`void`	`setDataRoot(String dataRoot)` Deprecated. use `MarshallingConfig.setDataRoot(java.lang.String)` instead
`void`	`setEncoding(Charset encoding)` Deprecated. Use `MarshallingConfig.setEncoding(java.nio.charset.Charset)`} instead
`void`	`setEncoding(String charsetName)` Deprecated. Use `MarshallingConfig.setEncoding(java.nio.charset.Charset)`} instead
`void`	`setEndpoint(String endpoint)` Change the string appended to BaseURL.
`void`	`setGsonBuilder(com.google.gson.GsonBuilder gsonBuilder)` Deprecated. Pipes are moving to a more generic RequestBuilder interface. `GsonRequestBuilder`
`void`	`setHandler(PipeHandler handler)`
`void`	`setName(String name)` Modify the name field.
`void`	`setPageConfig(PageConfig pageConfig)` PageConfig is the configuration information for Paging.
`void`	`setRequestBuilder(RequestBuilder requestBuilder)` A request builder is responsible for turning an object into a request used in a Pipe's save methods.
`void`	`setResponseParser(ResponseParser responseParser)` A ResponseParser is responsible for parsing a String value of the response from a remote source into a object instance.
`void`	`setTimeout(Integer timeout)` Timeout is the length of time in milliseconds that a Pipe will wait for a response from a call to read, save or remove
`void`	`setType(PipeType type)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PipeConfig
```
public PipeConfig(URL baseURL,
          Class klass)
```
- Method Detail
  - getName
```
public String getName()
```
    Returns:
    The Name that Pipeline will use to reference Pipes built by this configuration.
  - setName
```
public void setName(String name)
```
    Modify the name field. This is the value Pipeline uses to reference a Pipe built by this configuration.
    
    Parameters:
    name - the name of this pipe
  - getBaseURL
```
public URL getBaseURL()
```
    Returns:
    the URL which Endpoints will be appended to.
  - setBaseURL
```
public void setBaseURL(URL baseURL)
```
    Change the URL which Endpoints are appended to.
    
    Parameters:
    baseURL - the URL which Endpoints are appended to.
  - getEndpoint
```
public String getEndpoint()
```
    Returns:
    the string appended to BaseURL. It is the resource a Pipe connects to.
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Change the string appended to BaseURL. It is the resource a Pipe connects to.
    
    Parameters:
    endpoint - the new endpoint name
  - getType
```
public PipeType getType()
```
    Returns:
    type of Pipe to configure.
    See Also:
    PipeTypes
  - setType
```
public void setType(PipeType type)
```
    Parameters:
    type - a PipeType to use when building a Pipe with this config.
    See Also:
    PipeTypes
  - getGsonBuilder
```
public com.google.gson.GsonBuilder getGsonBuilder()
```
    Deprecated. Pipes are moving to a more generic RequestBuilder interface. GsonRequestBuilder
    
    Returns:
    the current GSONBuilder which will be used to generate GSON objects to be used by Pipes with this config.
    
    Throws:
    
    IllegalStateException - if ResponseBuilder is not an instance of GsonResponseParser
  - setGsonBuilder
```
@Deprecated
public void setGsonBuilder(com.google.gson.GsonBuilder gsonBuilder)
```
    Deprecated. Pipes are moving to a more generic RequestBuilder interface. GsonRequestBuilder
    
    Parameters:
    gsonBuilder - GSONBuilder which will be used to generate GSON objects to be used by Pipes with this config.
    
    Throws:
    
    IllegalStateException - if ResponseBuilder is not an instance of GsonResponseParser
  - getAuthModule
```
public AuthenticationModule getAuthModule()
```
    Returns:
    a AuthenticationModule which will be used for Authentication.
  - setAuthModule
```
public void setAuthModule(AuthenticationModule authModule)
```
    This value must be set to use Authentication in Pipes build from this config.
    
    Parameters:
    authModule - a AuthenticationModule which works with this PipeConfig
  - getEncoding
```
@Deprecated
public Charset getEncoding()
```
    Deprecated. Use MarshallingConfig.getEncoding() instead
    
    The Encoding is the String encoding to expect from the server.
    
    Returns:
    the current encoding, will not be null.
  - setEncoding
```
@Deprecated
public void setEncoding(Charset encoding)
```
    Deprecated. Use MarshallingConfig.setEncoding(java.nio.charset.Charset)} instead
    
    Parameters:
    encoding - a not null encoding
    
    Throws:
    
    IllegalArgumentException - if encoding is null
  - setEncoding
```
@Deprecated
public void setEncoding(String charsetName)
```
    Deprecated. Use MarshallingConfig.setEncoding(java.nio.charset.Charset)} instead
    
    Parameters:
    charsetName - a string for the encoding to be used
    
    Throws:
    
    UnsupportedCharsetException - if charSet is not supported
  - getPageConfig
```
public PageConfig getPageConfig()
```
    PageConfig is the configuration information for Paging.
    
    Returns:
    the current pageConfig
    See Also:
    the current pageconfig
  - setPageConfig
```
public void setPageConfig(PageConfig pageConfig)
```
    PageConfig is the configuration information for Paging.
    
    Parameters:
    pageConfig - a new pageconfig
    See Also:
    PageConfig
  - getDataRoot
```
@Deprecated
public String getDataRoot()
```
    Deprecated. use MarshallingConfig.getDataRoot() instead
    DataRoot refers to the dotted location of the result we are interested in from the JSON response from the server. For example:
```
 {
 "speakers": {
      "data": [
          {"speakerName":"John Doe", "speakerid":42},
          {"speakerName":"Jesse James", "speakerid":5309},
      ]
  }
 }
 
```
    A DataRoot of "speakers.data" would make the pipe pass a List using the array of speakers to the onSuccess method of callback.
    Returns:
    the current dataRoot
  - setDataRoot
```
@Deprecated
public void setDataRoot(String dataRoot)
```
    Deprecated. use MarshallingConfig.setDataRoot(java.lang.String) instead
    DataRoot refers to the dotted location of the result we are interested in from the JSON response from the server. For example:
```
 {
 "speakers": {
      "data": [
          {"speakerName":"John Doe", "speakerid":42},
          {"speakerName":"Jesse James", "speakerid":5309},
      ]
  }
 }
 
```
    A DataRoot of "speakers.data" would make the pipe pass a List using the array of speakers to the onSuccess method of callback.
    Parameters:
    dataRoot - the new dataroot
  - getHandler
```
public PipeHandler getHandler()
```
    Returns:
    the current PipeHandler for Pipes build using this configuration
  - setHandler
```
public void setHandler(PipeHandler handler)
```
    Parameters:
    handler - a new PipeHandler for Pipes build using this configuration
  - getTimeout
```
public Integer getTimeout()
```
    Timeout is the length of time in milliseconds that a Pipe will wait for a response from a call to read, save or remove
    
    Returns:
    the current timeout.
  - setTimeout
```
public void setTimeout(Integer timeout)
```
    Timeout is the length of time in milliseconds that a Pipe will wait for a response from a call to read, save or remove
    
    Parameters:
    timeout - a new
  - setRequestBuilder
```
public void setRequestBuilder(RequestBuilder requestBuilder)
```
    A request builder is responsible for turning an object into a request used in a Pipe's save methods. This value defaults to GsonRequestBuilder
    
    Parameters:
    requestBuilder - a new request builder
  - getRequestBuilder
```
public RequestBuilder getRequestBuilder()
```
    A request builder is responsible for turning an object into a request used in a Pipe's save methods. This value defaults to GsonRequestBuilder
    
    Returns:
    the current request builder.
  - getResponseParser
```
public ResponseParser getResponseParser()
```
    A ResponseParser is responsible for parsing a String value of the response from a remote source into a object instance.
    
    Returns:
    the current value of the ResponseParser field
  - setResponseParser
```
public void setResponseParser(ResponseParser responseParser)
```
    A ResponseParser is responsible for parsing a String value of the response from a remote source into a object instance.
    
    Parameters:
    responseParser - the response parser to use
  - getAuthzModule
```
public AuthzModule getAuthzModule()
```
  - setAuthzModule
```
public void setAuthzModule(AuthzModule authzModule)
```

Class PipeConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PipeConfig

Method Detail

getName

setName

getBaseURL

setBaseURL

getEndpoint

setEndpoint

getType

setType

getGsonBuilder

setGsonBuilder

getAuthModule

setAuthModule

getEncoding

setEncoding

setEncoding

getPageConfig

setPageConfig

getDataRoot

setDataRoot

getHandler

setHandler

getTimeout

setTimeout

setRequestBuilder

getRequestBuilder

getResponseParser

setResponseParser

getAuthzModule

setAuthzModule