HttpClientConf

java.lang.Object
- bayou.http.HttpClientConf

All Implemented Interfaces:

Cloneable
```
public final class HttpClientConf
extends Object
implements Cloneable
```
Configuration for HttpClient.
Each config property can be set by the setter method, for example
```
     conf.proxy("127.0.0.1", 8080);
 
```
The setters return `this` for method chaining; this class is best used in the builder pattern, for example
```
     HttpClient client = new HttpClientConf()
         .proxy("127.0.0.1", 8080)
         .trafficDump(System.err::print)
         ...
         .newClient();
 
```
Categories of Config Properties

TCP

tunnels

SSL

sslContext , sslEngineConf

HTTP

proxy , requestHeader , autoDecompress , autoRedirectMax , cookieStorage , etc.

Logging

trafficDump

Timeout

keepAliveTimeout , etc.

Others

misc properties, not commonly used

Constructor Summary

Constructors
Constructor and Description

HttpClientConf()
Create an HttpClientConf with default values.

Constructors
Constructor and Description
`HttpClientConf()` Create an HttpClientConf with default values.

Method Summary

Instance Methods
`HttpClient`	`newClient()` Create an HttpClient with this configuration.
`HttpClientConf`	`clone()` Return an independent copy of this object.
`HttpClientConf`	`selectorIds(int... selectorIds)` Ids of selectors for HttpClient.
`HttpClientConf`	`socketConf(ConsumerX<SocketChannel> action)` Action to configure each TCP socket.
`HttpClientConf`	`sslContext(SSLContext sslContext)` SSLContext for SSL connections.
`HttpClientConf`	`sslEngineConf(ConsumerX<SSLEngine> action)` Action to configure each SSLEngine.
`HttpClientConf`	`tunnels(TcpTunnel... tunnels)` Tcp tunnels for every HTTP connection.
`HttpClientConf`	`proxy(HttpProxy proxy)` Http proxy.
`HttpClientConf`	`proxy(String host, int port)` Http proxy.
`HttpClientConf`	`requestHeader(String name, String value)` An an additional header for every outgoing request.
`HttpClientConf`	`userPassSupplier(Function<TcpAddress,Async<UserPass>> userPassSupplier)` Username/password supplier for server authentications.
`HttpClientConf`	`userPass(String host, String username, String password)` Username/password for a single host.
`HttpClientConf`	`autoDecompress(boolean autoDecompress)` Whether to automatically decompress response bodies.
`HttpClientConf`	`autoRedirectMax(int autoRedirectMax)` Max number of redirects that will be followed.
`HttpClientConf`	`cookieStorage(CookieStorage cookieStorage)` Storage for cookies.
`HttpClientConf`	`keepAliveTimeout(Duration keepAliveTimeout)` Timeout for keep-alive connections.
`HttpClientConf`	`await100Timeout(Duration await100Timeout)` Timeout for awaiting "100 Continue" responses.
`HttpClientConf`	`responseHeadFieldMaxLength(int responseHeadFieldMaxLength)` Max length for any header value in a response.
`HttpClientConf`	`responseHeadTotalMaxLength(int responseHeadTotalMaxLength)` Max length of a response head.
`HttpClientConf`	`trafficDump(Consumer<CharSequence> trafficDump)` Where to dump http traffic, for debugging purpose.
`int[]`	`get_selectorIds()`
`ConsumerX<SocketChannel>`	`get_socketConf()`
`SSLContext`	`get_sslContext()`
`ConsumerX<SSLEngine>`	`get_sslEngineConf()`
`TcpTunnel[]`	`get_tunnels()`
`HttpProxy`	`get_proxy()`
`HeaderMap`	`get_requestHeaders()`
`Function<TcpAddress,Async<UserPass>>`	`get_userPassSupplier()`
`boolean`	`get_autoDecompress()`
`int`	`get_autoRedirectMax()`
`CookieStorage`	`get_cookieStorage()`
`Duration`	`get_keepAliveTimeout()`
`Duration`	`get_await100Timeout()`
`int`	`get_responseHeadFieldMaxLength()`
`int`	`get_responseHeadTotalMaxLength()`
`Consumer<CharSequence>`	`get_trafficDump()`

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

- Constructor Detail
  - HttpClientConf
```
public HttpClientConf()
```
    Create an HttpClientConf with default values.
- Method Detail
  - newClient
```
public HttpClient newClient()
```
    Create an HttpClient with this configuration.
    Calling this method `conf.newClient()` is equivalent to calling `new HttpClient(conf)`.
  - clone
```
public HttpClientConf clone()
```
    Return an independent copy of this object.
    
    Overrides:
    
    clone in class Object
  - selectorIds
```
public HttpClientConf selectorIds(int... selectorIds)
```
    Ids of selectors for HttpClient.
    default: [0, 1, ... N-1] where N is the number of processors
    
    Conceptually there are infinite number of selectors, each associated with a dedicated thread. A client may choose to use any one or several selectors. Different servers/clients can share selectors or use different selectors.
    
    Returns:
    
    `this`
  - socketConf
```
public HttpClientConf socketConf(ConsumerX<SocketChannel> action)
```
    Action to configure each TCP socket.
    default action: enable TCP_NODELAY
    
    App may want to configure more options on each socket, for example
```
     conf.socketConf( socketChannel ->
     {
         socketChannel.setOption(StandardSocketOptions.TCP_NODELAY, true);
         ...
     });
 
```
    The SocketChannel is in non-blocking model; it must not be changed to blocking mode.
    Returns:
    
    `this`
  - sslContext
```
public HttpClientConf sslContext(SSLContext sslContext)
```
    SSLContext for SSL connections.
    default: null
    
    If null, SSLContext.getDefault() is used. See JSSE Guide.
    
    See also SslConf for creating SSLContext. For example, to trust all server certificates (including self-signed ones)
```
     conf.sslContext( new SslConf().trustAll().createContext() )
 
```
    Returns:
    
    `this`
  - sslEngineConf
```
public HttpClientConf sslEngineConf(ConsumerX<SSLEngine> action)
```
    Action to configure each SSLEngine.
    default action: do nothing
    
    Example:
```
   conf.sslEngineConf( engine->
   {
       engine.setEnabledCipherSuites(...);
   });
 
```
    Returns:
    
    `this`
  - tunnels
```
public HttpClientConf tunnels(TcpTunnel... tunnels)
```
    Tcp tunnels for every HTTP connection.
    default: none
    
    A chain of tunnels can be specified; every HTTP connection will tunnel through all of them in the order specified
    
    Example:
```
   conf.tunnels(
       new Socks5Tunnel("localhost", 9876),
       new ConnectTunnel("some-proxy.com", 8080)
   );
 
```
    Note that ConnectTunnel is commonly known as "HTTPS proxy", but in our API it is considered a tunnel instead of a proxy.
    Returns:
    
    `this`
  - proxy
```
public HttpClientConf proxy(HttpProxy proxy)
```
    Http proxy.
    default: null
    
    If non-null, httpClient.send(request) will forward the request to the proxy instead of the request host.
    
    See also proxy(host, port)
    
    Note that this has nothing to do with "HTTPS proxy"; see tunnels(...) instead.
    
    Returns:
    
    `this`
  - proxy
```
public HttpClientConf proxy(String host,
                            int port)
```
    Http proxy.
    This is a convenience method, equivalent to
```
     proxy( new HttpProxy(host,port) )
 
```
    Returns:
    
    `this`
  - requestHeader
```
public HttpClientConf requestHeader(String name,
                                    String value)
```
    An an additional header for every outgoing request.
    HttpClient maintains a map of additional headers. send(request) will add those headers to the request before sending it out. If a header already exists in the request, it will not be affected by the additional headers.
    
    The map of additional headers initially contains
```
     Accept-Encoding: gzip
     User-Agent: bayou.io
 
```
    Calling this method with value=null will remove the header from that map.
    
    Example usage:
```
     new HttpClientConf()
         .requestHeader(Headers.User_Agent, null)
         .requestHeader(Headers.Cache_Control, "no-cache")
 
```
    Returns:
    
    `this`
  - userPassSupplier
```
public HttpClientConf userPassSupplier(Function<TcpAddress,Async<UserPass>> userPassSupplier)
```
    Username/password supplier for server authentications.
    default: null (none)
    
    During httpClient.send(request), if a 401 Unauthorized response is received with Basic/Digest challenges, the `userPassSupplier` will be invoked with the server address to get the username/password; the request will then be retried with the authentication information.
    
    The userPassSupplier should return (UserPass)null if no username/password is available for the server.
    
    See also userPass(host, username, password)
    
    Returns:
    
    `this`
  - userPass
```
public HttpClientConf userPass(String host,
                               String username,
                               String password)
```
    Username/password for a single host.
    This is a convenience method equivalent to
```
    userPassSupplier(address->
    {
        if(address.host().equalsIgnoreCase(host))
            return Async.success( new UserPass(username, password) );
        else
            return Async.success(null);
    });
 
```
    (This method cannot be used repeatedly to specify username/passwords for multiple servers.)
    Returns:
    
    `this`
  - autoDecompress
```
public HttpClientConf autoDecompress(boolean autoDecompress)
```
    Whether to automatically decompress response bodies.
    default: true
    
    During httpClient.send(request), if the response received from the server is compressed by "Content-Encoding: gzip", it will be automatically decompressed; the application sees a response entity with contentEncoding=null. Note that "ETag" is not transformed by this process, which can cause problems.
    
    Applications may want to set `autoDecompress(false)` if they prefer to receive compressed response bodies. GunzipByteSource can be used for manual decompression.
    
    Returns:
    
    `this`
  - autoRedirectMax
```
public HttpClientConf autoRedirectMax(int autoRedirectMax)
```
    Max number of redirects that will be followed.
    default: 10
    
    During httpClient.send(request), redirect responses will be automatically followed, up to the limitation of `autoRedirectMax`.
    
    If autoRedirectMax<=0, redirect responses will not be automatically followed.
    
    Returns:
    
    `this`
  - cookieStorage
```
public HttpClientConf cookieStorage(CookieStorage cookieStorage)
```
    Storage for cookies.
    default: CookieStorage.newInMemoryStorage()
    
    httpClient.send(request) will use this storage to load cookies for requests and save cookies from responses.
    
    If cookieStorage is `null`, HttpClient does not handle cookies; application can manage cookies in requests/responses by itself.
    
    Returns:
    
    `this`
  - keepAliveTimeout
```
public HttpClientConf keepAliveTimeout(Duration keepAliveTimeout)
```
    Timeout for keep-alive connections.
    default: 15 seconds
    
    HttpClient will try to cache and reuse connections, `keepAliveTimeout` specifies how long connections could be cached.
    
    If `keepAliveTimeout` is null, 0, or negative, no connections will be cached; each connection is used for one request-response trip.
    
    Returns:
    
    `this`
  - await100Timeout
```
public HttpClientConf await100Timeout(Duration await100Timeout)
```
    Timeout for awaiting "100 Continue" responses.
    default: 1 second
    
    If a request contains header "Expect: 100-continue", HttpClient will delay sending the request body until a "100 Continue" response is received, or `await100Timeout` is reached.
    
    If `await100Timeout` is null, 0, or negative, request body will always be sent immediately.
    
    Returns:
    
    `this`
  - responseHeadFieldMaxLength
```
public HttpClientConf responseHeadFieldMaxLength(int responseHeadFieldMaxLength)
```
    Max length for any header value in a response.
    default: 8*1024 (8KB)
    
    See also responseHeadTotalMaxLength.
    
    Returns:
    
    `this`
  - responseHeadTotalMaxLength
```
public HttpClientConf responseHeadTotalMaxLength(int responseHeadTotalMaxLength)
```
    Max length of a response head.
    default: 32*1024 (32KB)
    
    Returns:
    
    `this`
  - trafficDump
```
public HttpClientConf trafficDump(Consumer<CharSequence> trafficDump)
```
    Where to dump http traffic, for debugging purpose.
    default: null
    
    If non-null, request/response heads will be dumped to it. This feature is mostly enabled during development time.
    
    Example Usage:
```
     trafficDump( System.out::print );
 
```
    Returns:
    
    `this`
  - get_selectorIds
```
public int[] get_selectorIds()
```
  - get_socketConf
```
public ConsumerX<SocketChannel> get_socketConf()
```
  - get_sslContext
```
public SSLContext get_sslContext()
```
  - get_sslEngineConf
```
public ConsumerX<SSLEngine> get_sslEngineConf()
```
  - get_tunnels
```
public TcpTunnel[] get_tunnels()
```
  - get_proxy
```
public HttpProxy get_proxy()
```
  - get_requestHeaders
```
public HeaderMap get_requestHeaders()
```
  - get_userPassSupplier
```
public Function<TcpAddress,Async<UserPass>> get_userPassSupplier()
```
  - get_autoDecompress
```
public boolean get_autoDecompress()
```
  - get_autoRedirectMax
```
public int get_autoRedirectMax()
```
  - get_cookieStorage
```
public CookieStorage get_cookieStorage()
```
  - get_keepAliveTimeout
```
public Duration get_keepAliveTimeout()
```
  - get_await100Timeout
```
public Duration get_await100Timeout()
```
  - get_responseHeadFieldMaxLength
```
public int get_responseHeadFieldMaxLength()
```
  - get_responseHeadTotalMaxLength
```
public int get_responseHeadTotalMaxLength()
```
  - get_trafficDump
```
public Consumer<CharSequence> get_trafficDump()
```

Class HttpClientConf

Categories of Config Properties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpClientConf

Method Detail

newClient

clone

selectorIds

socketConf

sslContext

sslEngineConf

tunnels

proxy

proxy

requestHeader

userPassSupplier

userPass

autoDecompress

autoRedirectMax

cookieStorage

keepAliveTimeout

await100Timeout

responseHeadFieldMaxLength

responseHeadTotalMaxLength

trafficDump

get_selectorIds

get_socketConf

get_sslContext

get_sslEngineConf

get_tunnels

get_proxy

get_requestHeaders

get_userPassSupplier

get_autoDecompress

get_autoRedirectMax

get_cookieStorage

get_keepAliveTimeout

get_await100Timeout

get_responseHeadFieldMaxLength

get_responseHeadTotalMaxLength

get_trafficDump