HttpClientConfiguration (micronaut 1.0.3 API)

java.lang.Object
- io.micronaut.http.client.HttpClientConfiguration

Direct Known Subclasses:

BraveTracerConfiguration.HttpClientSenderConfiguration, DefaultHttpClientConfiguration, DiscoveryClientConfiguration, ServiceHttpClientConfiguration
```
public abstract class HttpClientConfiguration
extends Object
```
Configuration for the HttpClient.

Since:

1.0

Author:

Graeme Rocher

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HttpClientConfiguration.ConnectionPoolConfiguration
Configuration for the HTTP client connnection pool.

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpClientConfiguration.ConnectionPoolConfiguration` Configuration for the HTTP client connnection pool.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_FOLLOW_REDIRECTS` The default follow redirects value.
`static int`	`DEFAULT_MAX_CONTENT_LENGTH` The default shutdown timeout in millis.
`static long`	`DEFAULT_READ_IDLE_TIMEOUT_MINUTES` The default read idle timeout in minutes.
`static long`	`DEFAULT_READ_TIMEOUT_SECONDS` The default read timeout in seconds.
`static long`	`DEFAULT_SHUTDOWN_TIMEOUT_MILLISECONDS` The default shutdown timeout in millis.

Constructor Summary

Constructors
Constructor and Description

HttpClientConfiguration()
Default constructor.

HttpClientConfiguration(ApplicationConfiguration applicationConfiguration)

Constructors
Constructor and Description
`HttpClientConfiguration()` Default constructor.
`HttpClientConfiguration(ApplicationConfiguration applicationConfiguration)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Map<io.netty.channel.ChannelOption,Object>`	`getChannelOptions()`
`abstract HttpClientConfiguration.ConnectionPoolConfiguration`	`getConnectionPoolConfiguration()` Obtains the connection pool configuration.
`Optional<Duration>`	`getConnectTimeout()`
`Charset`	`getDefaultCharset()`
`Optional<String>`	`getLoggerName()`
`int`	`getMaxContentLength()`
`OptionalInt`	`getNumOfThreads()`
`Optional<SocketAddress>`	`getProxyAddress()` The proxy to use.
`Optional<String>`	`getProxyPassword()`
`Proxy.Type`	`getProxyType()` The proxy to use.
`Optional<String>`	`getProxyUsername()`
`Optional<Duration>`	`getReadIdleTimeout()` For streaming requests and WebSockets, the `getReadTimeout()` method does not apply instead a configurable idle timeout is applied.
`Optional<Duration>`	`getReadTimeout()`
`Optional<Duration>`	`getShutdownTimeout()` The amount of time to wait for shutdown.
`SslConfiguration`	`getSslConfiguration()`
`Optional<Class<? extends ThreadFactory>>`	`getThreadFactory()`
`boolean`	`isFollowRedirects()`
`void`	`setChannelOptions(Map<io.netty.channel.ChannelOption,Object> channelOptions)`
`void`	`setConnectTimeout(Duration connectTimeout)` Sets the connect timeout.
`void`	`setDefaultCharset(Charset defaultCharset)` Sets the default charset to use.
`void`	`setFollowRedirects(boolean followRedirects)` Sets whether redirects should be followed.
`void`	`setLoggerName(String loggerName)` Sets the client-specific logger name.
`void`	`setMaxContentLength(int maxContentLength)` Sets the maximum content length the client can consume.
`void`	`setNumOfThreads(Integer numOfThreads)` Sets the number of threads the client should use for requests.
`void`	`setProxyAddress(SocketAddress proxyAddress)` Sets a proxy address.
`void`	`setProxyPassword(String proxyPassword)` Sets the proxy password.
`void`	`setProxyType(Proxy.Type proxyType)`
`void`	`setProxyUsername(String proxyUsername)` Sets the proxy user name to use.
`void`	`setReadIdleTimeout(Duration readIdleTimeout)` Sets the max read idle time for streaming requests.
`void`	`setReadTimeout(Duration readTimeout)` Sets the read timeout.
`void`	`setShutdownTimeout(Duration shutdownTimeout)` Sets the amount of time to wait for shutdown of client thread pools.
`void`	`setSslConfiguration(SslConfiguration sslConfiguration)` Sets the SSL configuration for the client.
`void`	`setThreadFactory(Class<? extends ThreadFactory> threadFactory)` Sets a thread factory.

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

- Field Detail
  - DEFAULT_READ_TIMEOUT_SECONDS
```
public static final long DEFAULT_READ_TIMEOUT_SECONDS
```
    The default read timeout in seconds.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_READ_IDLE_TIMEOUT_MINUTES
```
public static final long DEFAULT_READ_IDLE_TIMEOUT_MINUTES
```
    The default read idle timeout in minutes.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SHUTDOWN_TIMEOUT_MILLISECONDS
```
public static final long DEFAULT_SHUTDOWN_TIMEOUT_MILLISECONDS
```
    The default shutdown timeout in millis.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_CONTENT_LENGTH
```
public static final int DEFAULT_MAX_CONTENT_LENGTH
```
    The default shutdown timeout in millis.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_FOLLOW_REDIRECTS
```
public static final boolean DEFAULT_FOLLOW_REDIRECTS
```
    The default follow redirects value.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpClientConfiguration
```
public HttpClientConfiguration()
```
    Default constructor.
  - HttpClientConfiguration
```
public HttpClientConfiguration(ApplicationConfiguration applicationConfiguration)
```
    Parameters:
    
    applicationConfiguration - The application configuration
- Method Detail
  - getConnectionPoolConfiguration
```
public abstract HttpClientConfiguration.ConnectionPoolConfiguration getConnectionPoolConfiguration()
```
    Obtains the connection pool configuration.
    
    Returns:
    
    The connection pool configuration.
  - getSslConfiguration
```
public SslConfiguration getSslConfiguration()
```
    Returns:
    
    The SslConfiguration for the client
  - setSslConfiguration
```
public void setSslConfiguration(SslConfiguration sslConfiguration)
```
    Sets the SSL configuration for the client.
    
    Parameters:
    
    sslConfiguration - The SSL configuration
  - isFollowRedirects
```
public boolean isFollowRedirects()
```
    Returns:
    
    Whether redirects should be followed
  - getLoggerName
```
public Optional<String> getLoggerName()
```
    Returns:
    
    The client-specific logger name if configured
  - setLoggerName
```
public void setLoggerName(@Nullable
                          String loggerName)
```
    Sets the client-specific logger name.
    
    Parameters:
    
    loggerName - The name of the logger.
  - setFollowRedirects
```
public void setFollowRedirects(boolean followRedirects)
```
    Sets whether redirects should be followed. Default value (DEFAULT_FOLLOW_REDIRECTS).
    
    Parameters:
    
    followRedirects - Whether redirects should be followed
  - getDefaultCharset
```
public Charset getDefaultCharset()
```
    Returns:
    
    The default charset to use
  - setDefaultCharset
```
public void setDefaultCharset(Charset defaultCharset)
```
    Sets the default charset to use. Default value (UTF-8);
    
    Parameters:
    
    defaultCharset - The charset to use
  - getChannelOptions
```
public Map<io.netty.channel.ChannelOption,Object> getChannelOptions()
```
    Returns:
    
    The Netty channel options.
    
    See Also:
    
    AbstractBootstrap.options()
  - setChannelOptions
```
public void setChannelOptions(Map<io.netty.channel.ChannelOption,Object> channelOptions)
```
    Parameters:
    
    channelOptions - The Netty channel options
    
    See Also:
    
    AbstractBootstrap.options()
  - getReadTimeout
```
public Optional<Duration> getReadTimeout()
```
    Returns:
    
    The default read timeout. Defaults to 10 seconds.
  - getReadIdleTimeout
```
public Optional<Duration> getReadIdleTimeout()
```
    For streaming requests and WebSockets, the getReadTimeout() method does not apply instead a configurable idle timeout is applied.
    
    Returns:
    
    The default amount of time to allow read operation connections to remain idle
  - getConnectTimeout
```
public Optional<Duration> getConnectTimeout()
```
    Returns:
    
    The default connect timeout. Defaults to Netty default.
  - getShutdownTimeout
```
public Optional<Duration> getShutdownTimeout()
```
    The amount of time to wait for shutdown.
    
    Returns:
    
    The shutdown timeout
  - setShutdownTimeout
```
public void setShutdownTimeout(@Nullable
                               Duration shutdownTimeout)
```
    Sets the amount of time to wait for shutdown of client thread pools. Default value (100L milliseconds).
    
    Parameters:
    
    shutdownTimeout - The shutdown time
  - setReadTimeout
```
public void setReadTimeout(@Nullable
                           Duration readTimeout)
```
    Sets the read timeout. Default value (10L seconds).
    
    Parameters:
    
    readTimeout - The read timeout
  - setReadIdleTimeout
```
public void setReadIdleTimeout(@Nullable
                               Duration readIdleTimeout)
```
    Sets the max read idle time for streaming requests. Default value (5L seconds).
    
    Parameters:
    
    readIdleTimeout - The read idle time
  - setConnectTimeout
```
public void setConnectTimeout(@Nullable
                              Duration connectTimeout)
```
    Sets the connect timeout.
    
    Parameters:
    
    connectTimeout - The connect timeout
  - getNumOfThreads
```
public OptionalInt getNumOfThreads()
```
    Returns:
    
    The number of threads the client should use for requests
  - setNumOfThreads
```
public void setNumOfThreads(@Nullable
                            Integer numOfThreads)
```
    Sets the number of threads the client should use for requests.
    
    Parameters:
    
    numOfThreads - The number of threads the client should use for requests
  - getThreadFactory
```
public Optional<Class<? extends ThreadFactory>> getThreadFactory()
```
    Returns:
    
    An Optional ThreadFactory
  - setThreadFactory
```
public void setThreadFactory(Class<? extends ThreadFactory> threadFactory)
```
    Sets a thread factory.
    
    Parameters:
    
    threadFactory - The thread factory
  - getMaxContentLength
```
public int getMaxContentLength()
```
    Returns:
    
    The maximum content length the client can consume
  - setMaxContentLength
```
public void setMaxContentLength(@ReadableBytes
                                int maxContentLength)
```
    Sets the maximum content length the client can consume. Default value (10485760 => 10MB).
    
    Parameters:
    
    maxContentLength - The maximum content length the client can consume
  - getProxyType
```
public Proxy.Type getProxyType()
```
    The proxy to use. For authentication specify http.proxyUser and http.proxyPassword system properties.
    Alternatively configure a java.net.ProxySelector
    
    Returns:
    
    The proxy type
  - setProxyType
```
public void setProxyType(Proxy.Type proxyType)
```
    Parameters:
    
    proxyType - The proxy type
  - getProxyAddress
```
public Optional<SocketAddress> getProxyAddress()
```
    The proxy to use. For authentication specify http.proxyUser and http.proxyPassword system properties.
    Alternatively configure a java.net.ProxySelector
    
    Returns:
    
    The optional proxy address
  - setProxyAddress
```
public void setProxyAddress(SocketAddress proxyAddress)
```
    Sets a proxy address.
    
    Parameters:
    
    proxyAddress - The proxy address
  - getProxyUsername
```
public Optional<String> getProxyUsername()
```
    Returns:
    
    The proxy user name to use
  - setProxyUsername
```
public void setProxyUsername(String proxyUsername)
```
    Sets the proxy user name to use.
    
    Parameters:
    
    proxyUsername - The proxy user name to use
  - getProxyPassword
```
public Optional<String> getProxyPassword()
```
    Returns:
    
    The proxy password to use.
  - setProxyPassword
```
public void setProxyPassword(String proxyPassword)
```
    Sets the proxy password.
    
    Parameters:
    
    proxyPassword - The proxy password

Class HttpClientConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_READ_TIMEOUT_SECONDS

DEFAULT_READ_IDLE_TIMEOUT_MINUTES

DEFAULT_SHUTDOWN_TIMEOUT_MILLISECONDS

DEFAULT_MAX_CONTENT_LENGTH

DEFAULT_FOLLOW_REDIRECTS

Constructor Detail

HttpClientConfiguration

HttpClientConfiguration

Method Detail

getConnectionPoolConfiguration

getSslConfiguration

setSslConfiguration

isFollowRedirects

getLoggerName

setLoggerName

setFollowRedirects

getDefaultCharset

setDefaultCharset

getChannelOptions

setChannelOptions

getReadTimeout

getReadIdleTimeout

getConnectTimeout

getShutdownTimeout

setShutdownTimeout

setReadTimeout

setReadIdleTimeout

setConnectTimeout

getNumOfThreads

setNumOfThreads

getThreadFactory

setThreadFactory

getMaxContentLength

setMaxContentLength

getProxyType

setProxyType

getProxyAddress

setProxyAddress

getProxyUsername

setProxyUsername

getProxyPassword

setProxyPassword