RxHttpClient.Builder

java.lang.Object
- be.wegenenverkeer.rxhttp.RxHttpClient.Builder

Enclosing class:: RxHttpClient

public static class RxHttpClient.Builder
extends java.lang.Object

A Builder for RxHttpClient builders.

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RxHttpClient.Builder`	`addRequestSigner(RequestSigner requestSigner)`
`RxHttpClient`	`build()`
`RxHttpClient.Builder`	`setAccept(java.lang.String acceptHeaderValue)` Sets the default Accept request-header for requests built using this instance.
`RxHttpClient.Builder`	`setAcceptAnyCertificate(boolean acceptAnyCertificate)`
`RxHttpClient.Builder`	`setAllowPoolingConnections(boolean allowPoolingConnections)` Set true if connection can be pooled by a ChannelPool.
`RxHttpClient.Builder`	`setAllowPoolingSslConnections(boolean allowPoolingSslConnections)` Set whether connections pooling is enabled.
`RxHttpClient.Builder`	`setAwsCredentialsProvider(AwsCredentialsProvider provider)`
`RxHttpClient.Builder`	`setAwsEndPoint(AwsService service, AwsRegion region)`
`RxHttpClient.Builder`	`setAwsEndPoint(AwsService service, AwsRegion region, java.lang.String domain)`
`RxHttpClient.Builder`	`setBaseUrl(java.lang.String url)` Sets the base URL for this client.
`RxHttpClient.Builder`	`setCompressionEnforced(boolean compressionEnforced)` Enforce HTTP compression.
`RxHttpClient.Builder`	`setConnectionTTL(int connectionTTL)` Set the maximum time in millisecond connection can be added to the pool for further reuse
`RxHttpClient.Builder`	`setConnectTimeout(int connectTimeOut)` Set the maximum time in millisecond an `AsyncHttpClient` can wait when connecting to a remote host
`RxHttpClient.Builder`	`setDisableUrlEncodingForBoundedRequests(boolean disableUrlEncodingForBoundedRequests)` Disable automatic url escaping
`RxHttpClient.Builder`	`setEnabledCipherSuites(java.lang.String[] enabledCipherSuites)`
`RxHttpClient.Builder`	`setEnabledProtocols(java.lang.String[] enabledProtocols)`
`RxHttpClient.Builder`	`setExecutorService(java.util.concurrent.ExecutorService applicationThreadPool)` Set the `ExecutorService` an `AsyncHttpClient` use for handling asynchronous response.
`RxHttpClient.Builder`	`setFollowRedirect(boolean followRedirect)` Set to true to enable HTTP redirect
`RxHttpClient.Builder`	`setHostnameVerifier(javax.net.ssl.HostnameVerifier hostnameVerifier)` Set the `HostnameVerifier`
`RxHttpClient.Builder`	`setIOThreadMultiplier(int multiplier)`
`RxHttpClient.Builder`	`setMaxConnections(int maxConnections)` Set the maximum number of connections an `AsyncHttpClient` can handle.
`RxHttpClient.Builder`	`setMaxRedirects(int maxRedirects)` Set the maximum number of HTTP redirect
`RxHttpClient.Builder`	`setMaxRequestRetry(int maxRequestRetry)` Set the number of time a request will be retried when an `IOException` occurs because of a Network exception.
`RxHttpClient.Builder`	`setPooledConnectionIdleTimeout(int pooledConnectionIdleTimeout)` Set the maximum time in millisecond an `AsyncHttpClient` will keep connection idle in pool.
`RxHttpClient.Builder`	`setReadTimeout(int readTimeout)` Set the maximum time in millisecond an `AsyncHttpClient` can stay idle.
`RxHttpClient.Builder`	`setRequestTimeout(int requestTimeout)` Set the maximum time in millisecond an `AsyncHttpClient` waits until the response is completed.
`RxHttpClient.Builder`	`setSSLContext(javax.net.ssl.SSLContext sslContext)` Set the `SSLContext` for secure connection.
`RxHttpClient.Builder`	`setStrict302Handling(boolean strict302Handling)` Configures this AHC instance to be strict in it's handling of 302 redirects in a POST/Redirect/GET situation.
`RxHttpClient.Builder`	`setThrottling(int maxWait)` Throttles requests by blocking until connections in the pool become available, waiting for the response to arrives before executing the next request.
`RxHttpClient.Builder`	`setUseProxyProperties(boolean useProxyProperties)` Sets whether AHC should use the default http.proxy* system properties to obtain proxy information.
`RxHttpClient.Builder`	`setUseProxySelector(boolean useProxySelector)` Sets whether AHC should use the default JDK ProxySelector to select a proxy server.
`RxHttpClient.Builder`	`setUserAgent(java.lang.String userAgent)` Set the USER_AGENT header value
`RxHttpClient.Builder`	`setUseRelativeURIsWithConnectProxies(boolean useRelativeURIsWithConnectProxies)` Configures this AHC instance to use relative URIs instead of absolute ones when talking with a SSL proxy or WebSocket proxy.
`RxHttpClient.Builder`	`setWebSocketTimeout(int webSocketTimeout)` Set the maximum time in millisecond an `WebSocket` can stay idle.

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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - build
```
public RxHttpClient build()
```
  - addRequestSigner
```
public RxHttpClient.Builder addRequestSigner(RequestSigner requestSigner)
```
  - setAccept
```
public RxHttpClient.Builder setAccept(java.lang.String acceptHeaderValue)
```
    Sets the default Accept request-header for requests built using this instance.
    
    Parameters:
    
    acceptHeaderValue - the Media-range and accept-params to use as value for the Accept request-header field
    
    Returns:
    
    this Builder
    
    See Also:
    
    W3C HTTP 1.1 specs.
  - setBaseUrl
```
public RxHttpClient.Builder setBaseUrl(java.lang.String url)
```
    Sets the base URL for this client.
    
    The base url will be prepended to any relative URL path specified in the RequestBuilder
    
    Parameters:
    
    url - the base URL for this instance
    
    Returns:
    
    this.Builder
  - setMaxConnections
```
public RxHttpClient.Builder setMaxConnections(int maxConnections)
```
    Set the maximum number of connections an AsyncHttpClient can handle.
    
    Parameters:
    
    maxConnections - the maximum number of connections an AsyncHttpClient can handle.
    
    Returns:
    
    a RxHttpClient.Builder
  - setAllowPoolingConnections
```
public RxHttpClient.Builder setAllowPoolingConnections(boolean allowPoolingConnections)
```
    Set true if connection can be pooled by a ChannelPool. Default is true.
    
    Parameters:
    
    allowPoolingConnections - true if connection can be pooled by a ChannelPool
    
    Returns:
    
    a RxHttpClient.Builder
  - setThrottling
```
public RxHttpClient.Builder setThrottling(int maxWait)
```
    Throttles requests by blocking until connections in the pool become available, waiting for the response to arrives before executing the next request.
    
    Parameters:
    
    maxWait - timeout in millisceconds
    
    Returns:
    
    this Builder
  - setConnectTimeout
```
public RxHttpClient.Builder setConnectTimeout(int connectTimeOut)
```
    Set the maximum time in millisecond an AsyncHttpClient can wait when connecting to a remote host
    
    Parameters:
    
    connectTimeOut - the maximum time in millisecond an AsyncHttpClient can wait when connecting to a remote host
    
    Returns:
    
    a RxHttpClient.Builder
  - setExecutorService
```
public RxHttpClient.Builder setExecutorService(java.util.concurrent.ExecutorService applicationThreadPool)
```
    Set the ExecutorService an AsyncHttpClient use for handling asynchronous response.
    
    By default a Cached Threadpool will be used, that will create threads as needed (see Executors.newCachedThreadPool())
    
    Parameters:
    
    applicationThreadPool - the ExecutorService an AsyncHttpClient use for handling asynchronous response.
    
    Returns:
    
    a RxHttpClient.Builder
  - setWebSocketTimeout
```
public RxHttpClient.Builder setWebSocketTimeout(int webSocketTimeout)
```
    Set the maximum time in millisecond an WebSocket can stay idle.
    
    Parameters:
    
    webSocketTimeout - the maximum time in millisecond an WebSocket can stay idle.
    
    Returns:
    
    a RxHttpClient.Builder
  - setMaxRequestRetry
```
public RxHttpClient.Builder setMaxRequestRetry(int maxRequestRetry)
```
    Set the number of time a request will be retried when an IOException occurs because of a Network exception.
    
    Parameters:
    
    maxRequestRetry - the number of time a request will be retried
    
    Returns:
    
    this
  - setHostnameVerifier
```
public RxHttpClient.Builder setHostnameVerifier(javax.net.ssl.HostnameVerifier hostnameVerifier)
```
    Set the HostnameVerifier
    
    Parameters:
    
    hostnameVerifier - HostnameVerifier
    
    Returns:
    
    this
  - setEnabledProtocols
```
public RxHttpClient.Builder setEnabledProtocols(java.lang.String[] enabledProtocols)
```
  - setUseRelativeURIsWithConnectProxies
```
public RxHttpClient.Builder setUseRelativeURIsWithConnectProxies(boolean useRelativeURIsWithConnectProxies)
```
    Configures this AHC instance to use relative URIs instead of absolute ones when talking with a SSL proxy or WebSocket proxy.
    
    Parameters:
    
    useRelativeURIsWithConnectProxies - use relative URIs with connect proxies
    
    Returns:
    
    this
    
    Since:
    
    1.8.13
  - setEnabledCipherSuites
```
public RxHttpClient.Builder setEnabledCipherSuites(java.lang.String[] enabledCipherSuites)
```
  - setAllowPoolingSslConnections
```
public RxHttpClient.Builder setAllowPoolingSslConnections(boolean allowPoolingSslConnections)
```
    Set whether connections pooling is enabled.
    
    Default is set to true
    
    Parameters:
    
    allowPoolingSslConnections - true if enabled
    
    Returns:
    
    this
  - setUseProxyProperties
```
public RxHttpClient.Builder setUseProxyProperties(boolean useProxyProperties)
```
    Sets whether AHC should use the default http.proxy* system properties to obtain proxy information. This differs from setUseProxySelector(boolean) in that AsyncHttpClient will use its own logic to handle the system properties, potentially supporting other protocols that the the JDK ProxySelector doesn't.
    If useProxyProperties is set to true but setUseProxySelector(boolean) was also set to true, the latter is preferred.
    See http://download.oracle.com/javase/1.4.2/docs/guide/net/properties.html
    
    Parameters:
    
    useProxyProperties - whether AHC should use the default http.proxy* system properties
  - setUseProxySelector
```
public RxHttpClient.Builder setUseProxySelector(boolean useProxySelector)
```
    Sets whether AHC should use the default JDK ProxySelector to select a proxy server.
    See http://docs.oracle.com/javase/7/docs/api/java/net/ProxySelector.html
    
    Parameters:
    
    useProxySelector - whether AHC should use the default JDK ProxySelector to select a proxy server.
  - setMaxRedirects
```
public RxHttpClient.Builder setMaxRedirects(int maxRedirects)
```
    Set the maximum number of HTTP redirect
    
    Parameters:
    
    maxRedirects - the maximum number of HTTP redirect
    
    Returns:
    
    a RxHttpClient.Builder
  - setAcceptAnyCertificate
```
public RxHttpClient.Builder setAcceptAnyCertificate(boolean acceptAnyCertificate)
```
  - setIOThreadMultiplier
```
public RxHttpClient.Builder setIOThreadMultiplier(int multiplier)
```
  - setStrict302Handling
```
public RxHttpClient.Builder setStrict302Handling(boolean strict302Handling)
```
    Configures this AHC instance to be strict in it's handling of 302 redirects in a POST/Redirect/GET situation.
    
    Parameters:
    
    strict302Handling - strict handling
    
    Returns:
    
    this
    
    Since:
    
    1.7.2
  - setConnectionTTL
```
public RxHttpClient.Builder setConnectionTTL(int connectionTTL)
```
    Set the maximum time in millisecond connection can be added to the pool for further reuse
    
    Default is -1 (no TTL set)
    
    Parameters:
    
    connectionTTL - the maximum time in millisecond connection can be added to the pool for further reuse
    
    Returns:
    
    a RxHttpClient.Builder
  - setUserAgent
```
public RxHttpClient.Builder setUserAgent(java.lang.String userAgent)
```
    Set the USER_AGENT header value
    
    Parameters:
    
    userAgent - the USER_AGENT header value
    
    Returns:
    
    a RxHttpClient.Builder
  - setFollowRedirect
```
public RxHttpClient.Builder setFollowRedirect(boolean followRedirect)
```
    Set to true to enable HTTP redirect
    
    Parameters:
    
    followRedirect@return - a RxHttpClient.Builder
  - setDisableUrlEncodingForBoundedRequests
```
public RxHttpClient.Builder setDisableUrlEncodingForBoundedRequests(boolean disableUrlEncodingForBoundedRequests)
```
    Disable automatic url escaping
    
    Parameters:
    
    disableUrlEncodingForBoundedRequests - disables the url encoding if set to true
    
    Returns:
    
    this Builder
  - setRequestTimeout
```
public RxHttpClient.Builder setRequestTimeout(int requestTimeout)
```
    Set the maximum time in millisecond an AsyncHttpClient waits until the response is completed.
    
    Parameters:
    
    requestTimeout - the maximum time in millisecond an AsyncHttpClient waits until the response is completed.
    
    Returns:
    
    a RxHttpClient.Builder
  - setSSLContext
```
public RxHttpClient.Builder setSSLContext(javax.net.ssl.SSLContext sslContext)
```
    Set the SSLContext for secure connection.
    
    Parameters:
    
    sslContext - the SSLContext for secure connection
    
    Returns:
    
    a RxHttpClient.Builder
  - setCompressionEnforced
```
public RxHttpClient.Builder setCompressionEnforced(boolean compressionEnforced)
```
    Enforce HTTP compression.
    
    Parameters:
    
    compressionEnforced - true if compression is enforced
    
    Returns:
    
    a RxHttpClient.Builder
  - setPooledConnectionIdleTimeout
```
public RxHttpClient.Builder setPooledConnectionIdleTimeout(int pooledConnectionIdleTimeout)
```
    Set the maximum time in millisecond an AsyncHttpClient will keep connection idle in pool.
    
    Default is 60000 millis (1 min.)
    
    Parameters:
    
    pooledConnectionIdleTimeout@return - a RxHttpClient.Builder
  - setReadTimeout
```
public RxHttpClient.Builder setReadTimeout(int readTimeout)
```
    Set the maximum time in millisecond an AsyncHttpClient can stay idle.
    
    Parameters:
    
    readTimeout - the maximum time in millisecond an RestClient can stay idle.
    
    Returns:
    
    a RxHttpClient.Builder
  - setAwsEndPoint
```
public RxHttpClient.Builder setAwsEndPoint(AwsService service,
                                           AwsRegion region)
```
  - setAwsEndPoint
```
public RxHttpClient.Builder setAwsEndPoint(AwsService service,
                                           AwsRegion region,
                                           java.lang.String domain)
```
  - setAwsCredentialsProvider
```
public RxHttpClient.Builder setAwsCredentialsProvider(AwsCredentialsProvider provider)
```

Class RxHttpClient.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

addRequestSigner

setAccept

setBaseUrl

setMaxConnections

setAllowPoolingConnections

setThrottling

setConnectTimeout

setExecutorService

setWebSocketTimeout

setMaxRequestRetry

setHostnameVerifier

setEnabledProtocols

setUseRelativeURIsWithConnectProxies

setEnabledCipherSuites

setAllowPoolingSslConnections

setUseProxyProperties

setUseProxySelector

setMaxRedirects

setAcceptAnyCertificate

setIOThreadMultiplier

setStrict302Handling

setConnectionTTL

setUserAgent

setFollowRedirect

setDisableUrlEncodingForBoundedRequests

setRequestTimeout

setSSLContext

setCompressionEnforced

setPooledConnectionIdleTimeout

setReadTimeout

setAwsEndPoint

setAwsEndPoint

setAwsCredentialsProvider