com.amazonaws.opensdk.config

Class ConnectionConfiguration

java.lang.Object

com.amazonaws.opensdk.config.ConnectionConfiguration

public class ConnectionConfiguration
extends Object

Configuration options for the client's http connections like max number of open HTTP connections, connection expiration time etc.

Constructor Summary

Constructors

Constructor and Description
ConnectionConfiguration()

Method Summary

Modifier and Type	Method and Description
ConnectionConfiguration	connectionMaxIdleMillis(long connectionMaxIdleMillis) Sets the maximum amount of time that an idle connection may sit in the connection pool and still be eligible for reuse.
ConnectionConfiguration	connectionTTL(long connectionTTL) Sets the expiration time (in milliseconds) for a connection in the connection pool.
Optional<Long>	getConnectionMaxIdleMillis() Returns an Optional which contains the maximum amount of time that an idle connection may sit in the connection pool and still be eligible for reuse.
Optional<Long>	getConnectionTTL() Returns an Optional that contains the expiration time (in milliseconds) for a connection in the connection pool.
Optional<Integer>	getMaxConnections() Returns an Optional that contains the maximum number of allowed open HTTP connections.
Optional<Boolean>	isUseReaper() Checks if the IdleConnectionReaper is to be started.
ConnectionConfiguration	maxConnections(int maxConnections) Sets the maximum number of allowed open HTTP connections.
void	setConnectionMaxIdleMillis(Long connectionMaxIdleMillis) Sets the maximum amount of time that an idle connection may sit in the connection pool and still be eligible for reuse.
void	setConnectionTTL(Long connectionTTL) Sets the expiration time (in milliseconds) for a connection in the connection pool.
void	setMaxConnections(Integer maxConnections) Sets the maximum number of allowed open HTTP connections.
void	setUseReaper(Boolean useReaper) Sets whether the IdleConnectionReaper is to be started as a daemon thread.
ConnectionConfiguration	useReaper(boolean useReaper) Sets whether the IdleConnectionReaper is to be started as a daemon thread.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConnectionConfiguration

public ConnectionConfiguration()

Method Detail

getMaxConnections

public Optional<Integer> getMaxConnections()

Returns an Optional that contains the maximum number of allowed open HTTP connections.

Default value is 50.

Returns:

The maximum number of allowed open HTTP connections.

setMaxConnections

public void setMaxConnections(Integer maxConnections)

Sets the maximum number of allowed open HTTP connections.

Default value is 50.

Parameters:

maxConnections - The maximum number of allowed open HTTP connections.

maxConnections

public ConnectionConfiguration maxConnections(int maxConnections)

Sets the maximum number of allowed open HTTP connections.

Default value is 50.

Parameters:

maxConnections - The maximum number of allowed open HTTP connections.

Returns:

This object for method chaining.

getConnectionTTL

public Optional<Long> getConnectionTTL()

Returns an Optional that contains the expiration time (in milliseconds) for a connection in the connection pool. When retrieving a connection from the pool to make a request, the total time that the connection has been open is compared against this value. Connections which have been open for longer are discarded, and if needed a new connection is created.

Tuning this setting down (together with an appropriately-low setting for Java's DNS cache TTL) ensures that your application will quickly rotate over to new IP addresses when the service begins announcing them through DNS, at the cost of having to re-establish new connections more frequently.

Default value is -1L, which means connections do not expire.

Returns:

The connection TTL, in milliseconds.

setConnectionTTL

public void setConnectionTTL(Long connectionTTL)

Sets the expiration time (in milliseconds) for a connection in the connection pool. When retrieving a connection from the pool to make a request, the total time that the connection has been open is compared against this value. Connections which have been open for longer are discarded, and if needed a new connection is created.

Tuning this setting down (together with an appropriately-low setting for Java's DNS cache TTL) ensures that your application will quickly rotate over to new IP addresses when the service begins announcing them through DNS, at the cost of having to re-establish new connections more frequently.

Default value is -1L, which means connections do not expire.

Parameters:

connectionTTL - The connection TTL, in milliseconds

connectionTTL

public ConnectionConfiguration connectionTTL(long connectionTTL)

Sets the expiration time (in milliseconds) for a connection in the connection pool. When retrieving a connection from the pool to make a request, the total time that the connection has been open is compared against this value. Connections which have been open for longer are discarded, and if needed a new connection is created.

Tuning this setting down (together with an appropriately-low setting for Java's DNS cache TTL) ensures that your application will quickly rotate over to new IP addresses when the service begins announcing them through DNS, at the cost of having to re-establish new connections more frequently.

Default value is -1L, which means connections do not expire.

Parameters:

connectionTTL - The connection TTL, in milliseconds

Returns:

This object for method chaining.

getConnectionMaxIdleMillis

public Optional<Long> getConnectionMaxIdleMillis()

Returns an Optional which contains the maximum amount of time that an idle connection may sit in the connection pool and still be eligible for reuse. When retrieving a connection from the pool to make a request, the amount of time the connection has been idle is compared against this value. Connections which have been idle for longer are discarded, and if needed a new connection is created.

Tuning this setting down reduces the likelihood of a race condition (wherein you begin sending a request down a connection which appears to be healthy, but before it arrives the service decides the connection has been idle for too long and closes it) at the cost of having to re-establish new connections more frequently.

Default value is 60000L.

Returns:

The connection maximum idle time, in milliseconds.

setConnectionMaxIdleMillis

public void setConnectionMaxIdleMillis(Long connectionMaxIdleMillis)

Sets the maximum amount of time that an idle connection may sit in the connection pool and still be eligible for reuse. When retrieving a connection from the pool to make a request, the amount of time the connection has been idle is compared against this value. Connections which have been idle for longer are discarded, and if needed a new connection is created.

Tuning this setting down reduces the likelihood of a race condition (wherein you begin sending a request down a connection which appears to be healthy, but before it arrives the service decides the connection has been idle for too long and closes it) at the cost of having to re-establish new connections more frequently.

Default value is 60000L.

Parameters:

connectionMaxIdleMillis - The connection maximum idle time, in milliseconds

connectionMaxIdleMillis

public ConnectionConfiguration connectionMaxIdleMillis(long connectionMaxIdleMillis)

Sets the maximum amount of time that an idle connection may sit in the connection pool and still be eligible for reuse. When retrieving a connection from the pool to make a request, the amount of time the connection has been idle is compared against this value. Connections which have been idle for longer are discarded, and if needed a new connection is created.

Tuning this setting down reduces the likelihood of a race condition (wherein you begin sending a request down a connection which appears to be healthy, but before it arrives the service decides the connection has been idle for too long and closes it) at the cost of having to re-establish new connections more frequently.

Default value is 60000L.

Parameters:

connectionMaxIdleMillis - The connection maximum idle time, in milliseconds

Returns:

This object for method chaining.

isUseReaper

public Optional<Boolean> isUseReaper()

Checks if the IdleConnectionReaper is to be started.

Default value is true.

Returns:

If the IdleConnectionReaper is to be started.

setUseReaper

public void setUseReaper(Boolean useReaper)

Sets whether the IdleConnectionReaper is to be started as a daemon thread.

Default value is true.

Parameters:

useReaper - The IdleConnectionReaper is to be started as a daemon thread

useReaper

public ConnectionConfiguration useReaper(boolean useReaper)

Sets whether the IdleConnectionReaper is to be started as a daemon thread.

Default value is true.

Parameters:

useReaper - The IdleConnectionReaper is to be started as a daemon thread

Returns:

This object for method chaining.