Package org.infinispan.persistence.remote.configuration

Class ConnectionPoolConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.AbstractPersistenceConfigurationChildBuilder

org.infinispan.configuration.cache.AbstractStoreConfigurationChildBuilder<S>

org.infinispan.persistence.remote.configuration.AbstractRemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

org.infinispan.persistence.remote.configuration.ConnectionPoolConfigurationBuilder

All Implemented Interfaces:

Builder<ConnectionPoolConfiguration>, ConfigurationChildBuilder, PersistenceConfigurationChildBuilder, StoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>, RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

public class ConnectionPoolConfigurationBuilder
extends AbstractRemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>
implements Builder<ConnectionPoolConfiguration>

ConnectionPoolConfigurationBuilder. Specifies connection pooling properties for the HotRod client.

Since:

5.2

Author:

Tristan Tarrant

Field Summary

Fields inherited from class org.infinispan.persistence.remote.configuration.AbstractRemoteStoreConfigurationChildBuilder

attributes, builder

Method Summary

Modifier and Type	Method	Description
AttributeSet	attributes()
Configuration	build()
ClusteringConfigurationBuilder	clustering()
ConnectionPoolConfiguration	create()	Create the configuration bean
CustomInterceptorsConfigurationBuilder	customInterceptors()	Deprecated, for removal: This API element is subject to removal in a future version. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
EncodingConfigurationBuilder	encoding()
ConnectionPoolConfigurationBuilder	exhaustedAction(ExhaustedAction exhaustedAction)	Specifies what happens when asking for a connection from a server's pool, and that pool is exhausted.
ExpirationConfigurationBuilder	expiration()
protected ConfigurationBuilder	getBuilder()
IndexingConfigurationBuilder	indexing()
InvocationBatchingConfigurationBuilder	invocationBatching()
LockingConfigurationBuilder	locking()
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, for removal: This API element is subject to removal in a future version. since 10.0.
ConnectionPoolConfigurationBuilder	maxPendingRequests(int maxPendingRequests)	Specifies maximum number of requests sent over single connection at one instant.
ConnectionPoolConfigurationBuilder	maxTotal(int maxTotal)	Deprecated, for removal: This API element is subject to removal in a future version. since 10.0.
ConnectionPoolConfigurationBuilder	maxWait(int 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.
MemoryConfigurationBuilder	memory()
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.
PersistenceConfigurationBuilder	persistence()
QueryConfigurationBuilder	query()
ConnectionPoolConfigurationBuilder	read(ConnectionPoolConfiguration template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
SecurityConfigurationBuilder	security()
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
SitesConfigurationBuilder	sites()
StatisticsConfigurationBuilder	statistics()
ConfigurationChildBuilder	template(boolean template)
ConnectionPoolConfigurationBuilder	testWhileIdle(boolean testWhileIdle)	Deprecated, for removal: This API element is subject to removal in a future version. since 10.0.
ConnectionPoolConfigurationBuilder	timeBetweenEvictionRuns(long timeBetweenEvictionRuns)	Deprecated, for removal: This API element is subject to removal in a future version. since 10.0.
TransactionConfigurationBuilder	transaction()
UnsafeConfigurationBuilder	unsafe()
void	validate(GlobalConfiguration globalConfig)

Methods inherited from class org.infinispan.persistence.remote.configuration.AbstractRemoteStoreConfigurationChildBuilder

addServer, asyncExecutorFactory, balancingStrategy, connectionPool, connectionTimeout, forceReturnValues, getRemoteStoreBuilder, hotRodWrapping, keySizeEstimate, marshaller, marshaller, protocolVersion, rawValues, remoteCacheName, remoteSecurity, socketTimeout, tcpNoDelay, transportFactory, transportFactory, valueSizeEstimate

Methods inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationChildBuilder

addProperty, async, fetchPersistentState, ignoreModifications, maxBatchSize, preload, purgeOnStartup, segmented, shared, transactional, withProperties, writeOnly

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commons.configuration.Builder

read, reset, validate

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder

build, clustering, customInterceptors, encoding, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, query, security, simpleCache, simpleCache, sites, statistics, template, transaction, unsafe

Methods inherited from interface org.infinispan.configuration.cache.PersistenceConfigurationChildBuilder

persistence

Methods inherited from interface org.infinispan.configuration.cache.StoreConfigurationChildBuilder

addProperty, async, fetchPersistentState, ignoreModifications, maxBatchSize, preload, purgeOnStartup, segmented, shared, transactional, withProperties, writeOnly

Method Details

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<ConnectionPoolConfiguration>

exhaustedAction

public ConnectionPoolConfigurationBuilder exhaustedAction(ExhaustedAction exhaustedAction)

Specifies what happens when asking for a connection from a server's pool, and that pool is exhausted.

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(forRemoval=true)
public ConnectionPoolConfigurationBuilder maxTotal(int maxTotal)

Deprecated, for removal: This API element is subject to removal in a future version.

since 10.0. This method has no effect

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).

maxIdle

@Deprecated(forRemoval=true)
public ConnectionPoolConfigurationBuilder maxIdle(int maxIdle)

Deprecated, for removal: This API element is subject to removal in a future version.

since 10.0. This method has no effect

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.

maxWait

public ConnectionPoolConfigurationBuilder maxWait(int 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.

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.

timeBetweenEvictionRuns

@Deprecated(forRemoval=true)
public ConnectionPoolConfigurationBuilder timeBetweenEvictionRuns(long timeBetweenEvictionRuns)

Deprecated, for removal: This API element is subject to removal in a future version.

since 10.0. This method has no effect

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).

testWhileIdle

@Deprecated(forRemoval=true)
public ConnectionPoolConfigurationBuilder testWhileIdle(boolean testWhileIdle)

Deprecated, for removal: This API element is subject to removal in a future version.

since 10.0. This method has no effect

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.

validate

public void validate(GlobalConfiguration globalConfig)

Specified by:

validate in interface ConfigurationChildBuilder

Overrides:

validate in class AbstractRemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

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,
 Combine combine)

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.

combine - the way attributes and children of this instance and the template should be combined.

template

public ConfigurationChildBuilder template(boolean template)

Specified by:

template in interface ConfigurationChildBuilder

simpleCache

public ConfigurationChildBuilder simpleCache(boolean simpleCache)

Specified by:

simpleCache in interface ConfigurationChildBuilder

simpleCache

public boolean simpleCache()

Specified by:

simpleCache in interface ConfigurationChildBuilder

clustering

public ClusteringConfigurationBuilder clustering()

Specified by:

clustering in interface ConfigurationChildBuilder

customInterceptors

@Deprecated(forRemoval=true)
public CustomInterceptorsConfigurationBuilder customInterceptors()

Deprecated, for removal: This API element is subject to removal in a future version.

Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors

Specified by:

customInterceptors in interface ConfigurationChildBuilder

encoding

public EncodingConfigurationBuilder encoding()

Specified by:

encoding in interface ConfigurationChildBuilder

expiration

public ExpirationConfigurationBuilder expiration()

Specified by:

expiration in interface ConfigurationChildBuilder

query

public QueryConfigurationBuilder query()

Specified by:

query in interface ConfigurationChildBuilder

indexing

public IndexingConfigurationBuilder indexing()

Specified by:

indexing in interface ConfigurationChildBuilder

invocationBatching

public InvocationBatchingConfigurationBuilder invocationBatching()

Specified by:

invocationBatching in interface ConfigurationChildBuilder

statistics

public StatisticsConfigurationBuilder statistics()

Specified by:

statistics in interface ConfigurationChildBuilder

persistence

public PersistenceConfigurationBuilder persistence()

Specified by:

persistence in interface ConfigurationChildBuilder

locking

public LockingConfigurationBuilder locking()

Specified by:

locking in interface ConfigurationChildBuilder

security

public SecurityConfigurationBuilder security()

Specified by:

security in interface ConfigurationChildBuilder

transaction

public TransactionConfigurationBuilder transaction()

Specified by:

transaction in interface ConfigurationChildBuilder

unsafe

public UnsafeConfigurationBuilder unsafe()

Specified by:

unsafe in interface ConfigurationChildBuilder

sites

public SitesConfigurationBuilder sites()

Specified by:

sites in interface ConfigurationChildBuilder

memory

public MemoryConfigurationBuilder memory()

Specified by:

memory in interface ConfigurationChildBuilder

getBuilder

protected ConfigurationBuilder getBuilder()

build

public Configuration build()

Specified by:

build in interface ConfigurationChildBuilder