ConnectionPoolConfigurationBuilder (Infinispan JavaDoc All 9.2.5.Final API)

java.lang.Object
- org.infinispan.client.hotrod.configuration.AbstractConfigurationChildBuilder
- - org.infinispan.client.hotrod.configuration.ConnectionPoolConfigurationBuilder

All Implemented Interfaces:

ConfigurationChildBuilder, Builder<ConnectionPoolConfiguration>
```
public class ConnectionPoolConfigurationBuilder
extends AbstractConfigurationChildBuilder
implements Builder<ConnectionPoolConfiguration>
```
ConnectionPoolConfigurationBuilder. Specifies connection pooling properties for the HotRod client.

Since:

5.3

Author:

Tristan Tarrant

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ConnectionPoolConfiguration`	`create()` Create the configuration bean
`ConnectionPoolConfigurationBuilder`	`exhaustedAction(ExhaustedAction exhaustedAction)` Specifies what happens when asking for a connection from a server's pool, and that pool is exhausted.
`ConnectionPoolConfigurationBuilder`	`lifo(boolean enabled)` Deprecated. Always LIFO.
`ConnectionPoolConfigurationBuilder`	`maxActive(int maxActive)` Controls the maximum number of connections per server that are allocated (checked out to client threads, or idle in the pool) at one time.
`ConnectionPoolConfigurationBuilder`	`maxIdle(int maxIdle)` Deprecated. Unsupported with Netty pool implementation.
`ConnectionPoolConfigurationBuilder`	`maxPendingRequests(int maxPendingRequests)` Specifies maximum number of requests sent over single connection at one instant.
`ConnectionPoolConfigurationBuilder`	`maxTotal(int maxTotal)` Deprecated. Since with Netty implementation we keep a pool-per-server we can't limit totals. While setting a total number of connections may seem convenient, it leads to port exhaustion under heavy load: the pool keeps closing and opening connections in a fast succession and since port is not freed by operating system immediately after closing that (it's in TIME_WAIT state), the client runs out of available ports (<64k) soon.
`ConnectionPoolConfigurationBuilder`	`maxWait(long maxWait)` The amount of time in milliseconds to wait for a connection to become available when the exhausted action is `ExhaustedAction.WAIT`, after which a `NoSuchElementException` will be thrown.
`ConnectionPoolConfigurationBuilder`	`minEvictableIdleTime(long minEvictableIdleTime)` Specifies the minimum amount of time that an connection may sit idle in the pool before it is eligible for eviction due to idle time.
`ConnectionPoolConfigurationBuilder`	`minIdle(int minIdle)` Sets a target value for the minimum number of idle connections (per server) that should always be available.
`ConnectionPoolConfigurationBuilder`	`numTestsPerEvictionRun(int numTestsPerEvictionRun)` Deprecated. Unsupported with Netty pool implementation.
`ConnectionPoolConfigurationBuilder`	`read(ConnectionPoolConfiguration template)` Reads the configuration from an already created configuration bean into this builder.
`ConnectionPoolConfigurationBuilder`	`testOnBorrow(boolean testOnBorrow)` Deprecated.
`ConnectionPoolConfigurationBuilder`	`testOnReturn(boolean testOnReturn)` Deprecated.
`ConnectionPoolConfigurationBuilder`	`testWhileIdle(boolean testWhileIdle)` Deprecated.
`ConnectionPoolConfigurationBuilder`	`timeBetweenEvictionRuns(long timeBetweenEvictionRuns)` Deprecated. Connection eviction uses the event-loop executor thread.
`void`	`validate()` Validate the data in this builder before building the configuration bean
`ConnectionPoolConfigurationBuilder`	`withPoolProperties(Properties properties)` Configures the connection pool parameter according to properties

Methods inherited from class org.infinispan.client.hotrod.configuration.AbstractConfigurationChildBuilder
addCluster, addJavaSerialWhiteList, addServer, addServers, asyncExecutorFactory, balancingStrategy, balancingStrategy, balancingStrategy, batchSize, build, classLoader, clientIntelligence, connectionPool, connectionTimeout, consistentHashImpl, consistentHashImpl, forceReturnValues, keySizeEstimate, marshaller, marshaller, marshaller, maxRetries, protocolVersion, security, socketTimeout, tcpKeepAlive, tcpNoDelay, transportFactory, transportFactory, valueSizeEstimate, version, withProperties

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

- Method Detail
  - exhaustedAction
```
public ConnectionPoolConfigurationBuilder exhaustedAction(ExhaustedAction exhaustedAction)
```
    Specifies what happens when asking for a connection from a server's pool, and that pool is exhausted.
  - lifo
```
@Deprecated
public ConnectionPoolConfigurationBuilder lifo(boolean enabled)
```
    Deprecated. Always LIFO.
    
    Sets the LIFO status. True means that borrowObject returns the most recently used ("last in") idle object in a pool (if there are idle instances available). False means that pools behave as FIFO queues - objects are taken from idle object pools in the order that they are returned. The default setting is true
  - maxActive
```
public ConnectionPoolConfigurationBuilder maxActive(int maxActive)
```
    Controls the maximum number of connections per server that are allocated (checked out to client threads, or idle in the pool) at one time. When non-positive, there is no limit to the number of connections per server. When maxActive is reached, the connection pool for that server is said to be exhausted. The default setting for this parameter is -1, i.e. there is no limit.
  - maxTotal
```
@Deprecated
public ConnectionPoolConfigurationBuilder maxTotal(int maxTotal)
```
    Deprecated. Since with Netty implementation we keep a pool-per-server we can't limit totals. While setting a total number of connections may seem convenient, it leads to port exhaustion under heavy load: the pool keeps closing and opening connections in a fast succession and since port is not freed by operating system immediately after closing that (it's in TIME_WAIT state), the client runs out of available ports (<64k) soon.
    
    Sets a global limit on the number persistent connections that can be in circulation within the combined set of servers. When non-positive, there is no limit to the total number of persistent connections in circulation. When maxTotal is exceeded, all connections pools are exhausted. The default setting for this parameter is -1 (no limit).
  - maxWait
```
public ConnectionPoolConfigurationBuilder maxWait(long maxWait)
```
    The amount of time in milliseconds to wait for a connection to become available when the exhausted action is ExhaustedAction.WAIT, after which a NoSuchElementException will be thrown. If a negative value is supplied, the pool will block indefinitely.
  - maxIdle
```
@Deprecated
public ConnectionPoolConfigurationBuilder maxIdle(int maxIdle)
```
    Deprecated. Unsupported with Netty pool implementation.
    
    Controls the maximum number of idle persistent connections, per server, at any time. When negative, there is no limit to the number of connections that may be idle per server. The default setting for this parameter is -1.
  - minIdle
```
public ConnectionPoolConfigurationBuilder minIdle(int minIdle)
```
    Sets a target value for the minimum number of idle connections (per server) that should always be available. If this parameter is set to a positive number and timeBetweenEvictionRunsMillis > 0, each time the idle connection eviction thread runs, it will try to create enough idle instances so that there will be minIdle idle instances available for each server. The default setting for this parameter is 1.
  - numTestsPerEvictionRun
```
@Deprecated
public ConnectionPoolConfigurationBuilder numTestsPerEvictionRun(int numTestsPerEvictionRun)
```
    Deprecated. Unsupported with Netty pool implementation.
    
    Indicates the maximum number of connections to test during idle eviction runs. The default setting is 3.
  - timeBetweenEvictionRuns
```
@Deprecated
public ConnectionPoolConfigurationBuilder timeBetweenEvictionRuns(long timeBetweenEvictionRuns)
```
    Deprecated. Connection eviction uses the event-loop executor thread.
    
    Indicates how long the eviction thread should sleep before "runs" of examining idle connections. When non-positive, no eviction thread will be launched. The default setting for this parameter is 2 minutes.
  - minEvictableIdleTime
```
public ConnectionPoolConfigurationBuilder minEvictableIdleTime(long minEvictableIdleTime)
```
    Specifies the minimum amount of time that an connection may sit idle in the pool before it is eligible for eviction due to idle time. When non-positive, no connection will be dropped from the pool due to idle time alone. This setting has no effect unless timeBetweenEvictionRunsMillis > 0. The default setting for this parameter is 1800000(30 minutes).
  - testOnBorrow
```
@Deprecated
public ConnectionPoolConfigurationBuilder testOnBorrow(boolean testOnBorrow)
```
    Deprecated.
    
    Indicates whether connections should be validated before being taken from the pool by sending an TCP packet to the server. Connections that fail to validate will be dropped from the pool. The default setting for this parameter is false.
  - testOnReturn
```
@Deprecated
public ConnectionPoolConfigurationBuilder testOnReturn(boolean testOnReturn)
```
    Deprecated.
    
    Indicates whether connections should be validated when being returned to the pool sending an TCP packet to the server. Connections that fail to validate will be dropped from the pool. The default setting for this parameter is false.
  - testWhileIdle
```
@Deprecated
public ConnectionPoolConfigurationBuilder testWhileIdle(boolean testWhileIdle)
```
    Deprecated.
    
    Indicates whether or not idle connections should be validated by sending an TCP packet to the server, during idle connection eviction runs. Connections that fail to validate will be dropped from the pool. This setting has no effect unless timeBetweenEvictionRunsMillis > 0. The default setting for this parameter is true.
  - maxPendingRequests
```
public ConnectionPoolConfigurationBuilder maxPendingRequests(int maxPendingRequests)
```
    Specifies maximum number of requests sent over single connection at one instant. Connections with more concurrent requests will be ignored in the pool when choosing available connection and the pool will try to create a new connection if all connections are utilized. Only if the new connection cannot be created and the exhausted action is set to ExhaustedAction.WAIT the pool will allow sending the request over one of the over-utilized connections. The rule of thumb is that this should be set to higher values if the values are small (< 1kB) and to lower values if the entries are big (> 10kB). Default setting for this parameter is 5.
  - withPoolProperties
```
public ConnectionPoolConfigurationBuilder withPoolProperties(Properties properties)
```
    Configures the connection pool parameter according to properties
  - validate
```
public void validate()
```
    Description copied from interface: Builder
    
    Validate the data in this builder before building the configuration bean
    
    Specified by:
    
    validate in interface Builder<ConnectionPoolConfiguration>
  - create
```
public ConnectionPoolConfiguration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<ConnectionPoolConfiguration>
    
    Returns:
  - read
```
public ConnectionPoolConfigurationBuilder read(ConnectionPoolConfiguration template)
```
    Description copied from interface: Builder
    
    Reads the configuration from an already created configuration bean into this builder. Returns an appropriate builder to allow fluent configuration
    
    Specified by:
    
    read in interface Builder<ConnectionPoolConfiguration>
    
    Parameters:
    
    template - the configuration from which to "clone" this config if needed.

Class ConnectionPoolConfigurationBuilder

Method Summary

Methods inherited from class org.infinispan.client.hotrod.configuration.AbstractConfigurationChildBuilder

Methods inherited from class java.lang.Object

Method Detail

exhaustedAction

lifo

maxActive

maxTotal

maxWait

maxIdle

minIdle

numTestsPerEvictionRun

timeBetweenEvictionRuns

minEvictableIdleTime

testOnBorrow

testOnReturn

testWhileIdle

maxPendingRequests

withPoolProperties

validate

create

read