HttpClient (RxJava Javadoc 0.5.2-RC1)

java.lang.Object
- io.reactivex.netty.protocol.http.client.InterceptingHttpClient<I,O>
- - io.reactivex.netty.protocol.http.client.HttpClient<I,O>

Type Parameters:

I - The type of the content of request.

O - The type of the content of response.

All Implemented Interfaces:

io.reactivex.netty.events.EventSource<HttpClientEventsListener>

Direct Known Subclasses:

HttpClientImpl
```
public abstract class HttpClient<I,O>
extends InterceptingHttpClient<I,O>
```
An HTTP client for executing HTTP requests.
Immutability
An instance of this client is immutable and all mutations produce a new client instance. For this reason it is recommended that the mutations are done during client creation and not during request processing to avoid repeated object creation overhead.

Constructor Summary

Constructors
Constructor and Description

HttpClient()

Constructors
Constructor and Description
`HttpClient()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract <II,OO> HttpClient<II,OO>`	`addChannelHandlerAfter(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String baseName, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)` Adds a `ChannelHandler` to `ChannelPipeline` for all connections created by this client.
`abstract <II,OO> HttpClient<II,OO>`	`addChannelHandlerAfter(java.lang.String baseName, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)` Adds a `ChannelHandler` to `ChannelPipeline` for all connections created by this client.
`abstract <II,OO> HttpClient<II,OO>`	`addChannelHandlerBefore(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String baseName, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)` Adds a `ChannelHandler` to `ChannelPipeline` for all connections created by this client.
`abstract <II,OO> HttpClient<II,OO>`	`addChannelHandlerBefore(java.lang.String baseName, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)` Adds a `ChannelHandler` to `ChannelPipeline` for all connections created by this client.
`abstract <II,OO> HttpClient<II,OO>`	`addChannelHandlerFirst(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)` Adds a `ChannelHandler` to `ChannelPipeline` for all connections created by this client.
`abstract <II,OO> HttpClient<II,OO>`	`addChannelHandlerFirst(java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)` Adds a `ChannelHandler` to `ChannelPipeline` for all connections created by this client.
`abstract <II,OO> HttpClient<II,OO>`	`addChannelHandlerLast(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)` Adds a `ChannelHandler` to `ChannelPipeline` for all connections created by this client.
`abstract <II,OO> HttpClient<II,OO>`	`addChannelHandlerLast(java.lang.String name, rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)` Adds a `ChannelHandler` to `ChannelPipeline` for all connections created by this client.
`abstract <T> HttpClient<I,O>`	`channelOption(io.netty.channel.ChannelOption<T> option, T value)` Creates a new client instances, inheriting all configurations from this client and adding a `ChannelOption` for the connections created by the newly created client instance.
`abstract HttpClient<I,O>`	`channelProvider(io.reactivex.netty.client.ChannelProviderFactory providerFactory)` Creates a new client instance, inheriting all configurations from this client and using the passed `providerFactory`.
`abstract HttpClient<I,O>`	`enableWireLogging(io.netty.handler.logging.LogLevel wireLoggingLevel)` Creates a new client instances, inheriting all configurations from this client and enabling wire logging at the passed level for the newly created client instance.
`abstract HttpClient<I,O>`	`followRedirects(boolean follow)` Creates a new client instances, inheriting all configurations from this client and enabling/disabling redirects for all requests created by the newly created client instance.
`abstract HttpClient<I,O>`	`followRedirects(int maxRedirects)` Creates a new client instances, inheriting all configurations from this client and following the passed number of max HTTP redirects.
`static HttpClient<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf>`	`newClient(io.reactivex.netty.client.ConnectionProviderFactory<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> providerFactory, rx.Observable<io.reactivex.netty.client.Host> hostStream)` Creates a new HTTP client instance using the supplied connection provider.
`static HttpClient<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf>`	`newClient(java.net.SocketAddress serverAddress)` Creates a new HTTP client instance with the passed address of the target server.
`static HttpClient<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf>`	`newClient(java.lang.String host, int port)` Creates a new HTTP client instance with the passed host and port for the target server.
`abstract <II,OO> HttpClient<II,OO>`	`pipelineConfigurator(rx.functions.Action1<io.netty.channel.ChannelPipeline> pipelineConfigurator)` Creates a new client instances, inheriting all configurations from this client and using the passed action to configure all the connections created by the newly created client instance.
`abstract HttpClient<I,O>`	`readTimeOut(int timeOut, java.util.concurrent.TimeUnit timeUnit)` Creates a new client instances, inheriting all configurations from this client and adding the passed read timeout for all requests created by the newly created client instance.
`abstract HttpClient<I,O>`	`secure(rx.functions.Func1<io.netty.buffer.ByteBufAllocator,javax.net.ssl.SSLEngine> sslEngineFactory)` Creates a new client instance, inheriting all configurations from this client and using the passed `sslEngineFactory` for all secured connections created by the newly created client instance.
`abstract HttpClient<I,O>`	`secure(io.reactivex.netty.ssl.SslCodec sslCodec)` Creates a new client instance, inheriting all configurations from this client and using the passed `sslCodec` for all secured connections created by the newly created client instance.
`abstract HttpClient<I,O>`	`secure(javax.net.ssl.SSLEngine sslEngine)` Creates a new client instance, inheriting all configurations from this client and using the passed `sslEngine` for all secured connections created by the newly created client instance.
`abstract HttpClient<I,O>`	`unsafeSecure()` Creates a new client instance, inheriting all configurations from this client and using a trust-all `TrustManagerFactory`for all secured connections created by the newly created client instance.

Methods inherited from class io.reactivex.netty.protocol.http.client.InterceptingHttpClient
createConnect, createDelete, createGet, createHead, createOptions, createPatch, createPost, createPut, createRequest, createRequest, createTrace, intercept

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

Methods inherited from interface io.reactivex.netty.events.EventSource
subscribe

- Constructor Detail
  - HttpClient
```
public HttpClient()
```
- Method Detail
  - readTimeOut
```
public abstract HttpClient<I,O> readTimeOut(int timeOut,
                                            java.util.concurrent.TimeUnit timeUnit)
```
    Creates a new client instances, inheriting all configurations from this client and adding the passed read timeout for all requests created by the newly created client instance.
    
    Parameters:
    
    timeOut - Read timeout duration.
    
    timeUnit - Timeunit for the timeout.
    
    Returns:
    
    A new HttpClient instance.
  - channelOption
```
public abstract <T> HttpClient<I,O> channelOption(io.netty.channel.ChannelOption<T> option,
                                                  T value)
```
    Creates a new client instances, inheriting all configurations from this client and adding a ChannelOption for the connections created by the newly created client instance.
    
    Parameters:
    
    option - Option to add.
    
    value - Value for the option.
    
    Returns:
    
    A new HttpClient instance.
  - addChannelHandlerFirst
```
public abstract <II,OO> HttpClient<II,OO> addChannelHandlerFirst(java.lang.String name,
                                                                 rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)
```
    Adds a ChannelHandler to ChannelPipeline for all connections created by this client. The specified handler is added at the first position of the pipeline as specified by ChannelPipeline.addFirst(String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.
    
    Parameters:
    
    name - Name of the handler.
    
    handlerFactory - Factory to create handler instance to add.
    
    Returns:
    
    A new HttpClient instance.
  - addChannelHandlerFirst
```
public abstract <II,OO> HttpClient<II,OO> addChannelHandlerFirst(io.netty.util.concurrent.EventExecutorGroup group,
                                                                 java.lang.String name,
                                                                 rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)
```
    Adds a ChannelHandler to ChannelPipeline for all connections created by this client. The specified handler is added at the first position of the pipeline as specified by ChannelPipeline.addFirst(EventExecutorGroup, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.
    
    Parameters:
    
    group - the EventExecutorGroup which will be used to execute the ChannelHandler methods
    
    name - the name of the handler to append
    
    handlerFactory - Factory to create handler instance to add.
    
    Returns:
    
    A new HttpClient instance.
  - addChannelHandlerLast
```
public abstract <II,OO> HttpClient<II,OO> addChannelHandlerLast(java.lang.String name,
                                                                rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)
```
    Adds a ChannelHandler to ChannelPipeline for all connections created by this client. The specified handler is added at the last position of the pipeline as specified by ChannelPipeline.addLast(String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.
    
    Parameters:
    
    name - Name of the handler.
    
    handlerFactory - Factory to create handler instance to add.
    
    Returns:
    
    A new HttpClient instance.
  - addChannelHandlerLast
```
public abstract <II,OO> HttpClient<II,OO> addChannelHandlerLast(io.netty.util.concurrent.EventExecutorGroup group,
                                                                java.lang.String name,
                                                                rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)
```
    Adds a ChannelHandler to ChannelPipeline for all connections created by this client. The specified handler is added at the last position of the pipeline as specified by ChannelPipeline.addLast(EventExecutorGroup, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.
    
    Parameters:
    
    group - the EventExecutorGroup which will be used to execute the ChannelHandler methods
    
    name - the name of the handler to append
    
    handlerFactory - Factory to create handler instance to add.
    
    Returns:
    
    A new HttpClient instance.
  - addChannelHandlerBefore
```
public abstract <II,OO> HttpClient<II,OO> addChannelHandlerBefore(java.lang.String baseName,
                                                                  java.lang.String name,
                                                                  rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)
```
    Adds a ChannelHandler to ChannelPipeline for all connections created by this client. The specified handler is added before an existing handler with the passed baseName in the pipeline as specified by ChannelPipeline.addBefore(String, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.
    
    Parameters:
    
    baseName - the name of the existing handler
    
    name - Name of the handler.
    
    handlerFactory - Factory to create handler instance to add.
    
    Returns:
    
    A new HttpClient instance.
  - addChannelHandlerBefore
```
public abstract <II,OO> HttpClient<II,OO> addChannelHandlerBefore(io.netty.util.concurrent.EventExecutorGroup group,
                                                                  java.lang.String baseName,
                                                                  java.lang.String name,
                                                                  rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)
```
    Adds a ChannelHandler to ChannelPipeline for all connections created by this client. The specified handler is added before an existing handler with the passed baseName in the pipeline as specified by ChannelPipeline.addBefore(EventExecutorGroup, String, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.
    
    Parameters:
    
    group - the EventExecutorGroup which will be used to execute the ChannelHandler methods
    
    baseName - the name of the existing handler
    
    name - the name of the handler to append
    
    handlerFactory - Factory to create handler instance to add.
    
    Returns:
    
    A new HttpClient instance.
  - addChannelHandlerAfter
```
public abstract <II,OO> HttpClient<II,OO> addChannelHandlerAfter(java.lang.String baseName,
                                                                 java.lang.String name,
                                                                 rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)
```
    Adds a ChannelHandler to ChannelPipeline for all connections created by this client. The specified handler is added after an existing handler with the passed baseName in the pipeline as specified by ChannelPipeline.addAfter(String, String, ChannelHandler)
    
    Parameters:
    
    baseName - the name of the existing handler
    
    name - Name of the handler.
    
    handlerFactory - Factory to create handler instance to add.
    
    Returns:
    
    A new HttpClient instance.
  - addChannelHandlerAfter
```
public abstract <II,OO> HttpClient<II,OO> addChannelHandlerAfter(io.netty.util.concurrent.EventExecutorGroup group,
                                                                 java.lang.String baseName,
                                                                 java.lang.String name,
                                                                 rx.functions.Func0<io.netty.channel.ChannelHandler> handlerFactory)
```
    Adds a ChannelHandler to ChannelPipeline for all connections created by this client. The specified handler is added after an existing handler with the passed baseName in the pipeline as specified by ChannelPipeline.addAfter(EventExecutorGroup, String, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.
    
    Parameters:
    
    group - the EventExecutorGroup which will be used to execute the ChannelHandler methods
    
    baseName - the name of the existing handler
    
    name - the name of the handler to append
    
    handlerFactory - Factory to create handler instance to add.
    
    Returns:
    
    A new HttpClient instance.
  - pipelineConfigurator
```
public abstract <II,OO> HttpClient<II,OO> pipelineConfigurator(rx.functions.Action1<io.netty.channel.ChannelPipeline> pipelineConfigurator)
```
    Creates a new client instances, inheriting all configurations from this client and using the passed action to configure all the connections created by the newly created client instance.
    
    Parameters:
    
    pipelineConfigurator - Action to configure ChannelPipeline.
    
    Returns:
    
    A new HttpClient instance.
  - secure
```
public abstract HttpClient<I,O> secure(rx.functions.Func1<io.netty.buffer.ByteBufAllocator,javax.net.ssl.SSLEngine> sslEngineFactory)
```
    Creates a new client instance, inheriting all configurations from this client and using the passed sslEngineFactory for all secured connections created by the newly created client instance. If the SSLEngine instance can be statically, created, secure(SSLEngine) can be used.
    
    Parameters:
    
    sslEngineFactory - Factory for all secured connections created by the newly created client instance.
    
    Returns:
    
    A new HttpClient instance.
  - secure
```
public abstract HttpClient<I,O> secure(javax.net.ssl.SSLEngine sslEngine)
```
    Creates a new client instance, inheriting all configurations from this client and using the passed sslEngine for all secured connections created by the newly created client instance. If the SSLEngine instance can not be statically, created, secure(Func1) )} can be used.
    
    Parameters:
    
    sslEngine - SSLEngine for all secured connections created by the newly created client instance.
    
    Returns:
    
    A new HttpClient instance.
  - secure
```
public abstract HttpClient<I,O> secure(io.reactivex.netty.ssl.SslCodec sslCodec)
```
    Creates a new client instance, inheriting all configurations from this client and using the passed sslCodec for all secured connections created by the newly created client instance. This is required only when the SslHandler used by SslCodec is to be modified before adding to the ChannelPipeline. For most of the cases, secure(Func1) or secure(SSLEngine) will be enough.
    
    Parameters:
    
    sslCodec - SslCodec for all secured connections created by the newly created client instance.
    
    Returns:
    
    A new HttpClient instance.
  - unsafeSecure
```
public abstract HttpClient<I,O> unsafeSecure()
```
    Creates a new client instance, inheriting all configurations from this client and using a trust-all TrustManagerFactoryfor all secured connections created by the newly created client instance. This is only for testing and should not be used for real production clients.
    
    Returns:
    
    A new HttpClient instance.
  - enableWireLogging
```
public abstract HttpClient<I,O> enableWireLogging(io.netty.handler.logging.LogLevel wireLoggingLevel)
```
    Creates a new client instances, inheriting all configurations from this client and enabling wire logging at the passed level for the newly created client instance.
    
    Parameters:
    
    wireLoggingLevel - Logging level at which the wire logs will be logged. The wire logging will only be done if logging is enabled at this level for LoggingHandler
    
    Returns:
    
    A new HttpClient instance.
  - channelProvider
```
public abstract HttpClient<I,O> channelProvider(io.reactivex.netty.client.ChannelProviderFactory providerFactory)
```
    Creates a new client instance, inheriting all configurations from this client and using the passed providerFactory.
    
    Parameters:
    
    providerFactory - Channel provider factory.
    
    Returns:
    
    A new HttpClient instance.
  - newClient
```
public static HttpClient<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> newClient(java.lang.String host,
                                                                                    int port)
```
    Creates a new HTTP client instance with the passed host and port for the target server.
    
    Parameters:
    
    host - Hostname for the target server.
    
    port - Port for the target server.
    
    Returns:
    
    A new HttpClient instance.
  - newClient
```
public static HttpClient<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> newClient(java.net.SocketAddress serverAddress)
```
    Creates a new HTTP client instance with the passed address of the target server.
    
    Parameters:
    
    serverAddress - Socket address for the target server.
    
    Returns:
    
    A new HttpClient instance.
  - newClient
```
public static HttpClient<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> newClient(io.reactivex.netty.client.ConnectionProviderFactory<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> providerFactory,
                                                                                    rx.Observable<io.reactivex.netty.client.Host> hostStream)
```
    Creates a new HTTP client instance using the supplied connection provider.
    
    Parameters:
    
    providerFactory - ConnectionProviderFactory for the client.
    
    hostStream - Stream of hosts for the client.
    
    Returns:
    
    A new HttpClient instance.
  - followRedirects
```
public abstract HttpClient<I,O> followRedirects(int maxRedirects)
```
    Creates a new client instances, inheriting all configurations from this client and following the passed number of max HTTP redirects.
    
    Parameters:
    
    maxRedirects - Maximum number of redirects to follow for any request.
    
    Returns:
    
    A new HttpClient instance.
  - followRedirects
```
public abstract HttpClient<I,O> followRedirects(boolean follow)
```
    Creates a new client instances, inheriting all configurations from this client and enabling/disabling redirects for all requests created by the newly created client instance.
    
    Parameters:
    
    follow - true to follow redirects. false to disable any redirects.
    
    Returns:
    
    A new HttpClient instance.

RxJava

Class HttpClient<I,O>

Immutability

Constructor Summary

Method Summary

Methods inherited from class io.reactivex.netty.protocol.http.client.InterceptingHttpClient

Methods inherited from class java.lang.Object

Methods inherited from interface io.reactivex.netty.events.EventSource

Constructor Detail

HttpClient

Method Detail

readTimeOut

channelOption

addChannelHandlerFirst

addChannelHandlerFirst

addChannelHandlerLast

addChannelHandlerLast

addChannelHandlerBefore

addChannelHandlerBefore

addChannelHandlerAfter

addChannelHandlerAfter

pipelineConfigurator

secure

secure

secure

unsafeSecure

enableWireLogging

channelProvider

newClient

newClient

newClient

followRedirects

followRedirects