Package org.infinispan.client.hotrod.configuration

Class Configuration

java.lang.Object

org.infinispan.client.hotrod.configuration.Configuration

All Implemented Interfaces:

org.infinispan.api.configuration.Configuration

public class Configuration
extends Object
implements org.infinispan.api.configuration.Configuration

Configuration.

Since:

5.3

Author:

Tristan Tarrant

Constructor Summary

Constructors

Constructor

Description

Configuration(ExecutorFactoryConfiguration asyncExecutorFactory, Supplier<FailoverRequestBalancingStrategy> balancingStrategyFactory, ClassLoader classLoader, ClientIntelligence clientIntelligence, ConnectionPoolConfiguration connectionPool, int connectionTimeout, Class<? extends org.infinispan.client.hotrod.impl.consistenthash.ConsistentHash>[] consistentHashImpl, int dnsResolverMinTTL, int dnsResolverMaxTTL, int dnsResolverNegativeTTL, boolean forceReturnValues, int keySizeEstimate, Marshaller marshaller, Class<? extends Marshaller> marshallerClass, ProtocolVersion protocolVersion, List<ServerConfiguration> servers, int socketTimeout, SecurityConfiguration security, boolean tcpNoDelay, boolean tcpKeepAlive, int valueSizeEstimate, int maxRetries, NearCacheConfiguration nearCache, List<ClusterConfiguration> clusters, List<String> serialAllowList, int batchSize, TransactionConfiguration transaction, StatisticsConfiguration statistics, Features features, List<org.infinispan.protostream.SerializationContextInitializer> contextInitializers, Map<String,RemoteCacheConfiguration> remoteCaches, TransportFactory transportFactory, boolean tracingPropagationEnabled, RemoteCacheManagerMetricsRegistry metricRegistry, int serverFailureTimeout)

Method Summary

Modifier and Type	Method	Description
RemoteCacheConfiguration	addRemoteCache(String name, Consumer<RemoteCacheConfigurationBuilder> builderConsumer)	Create a new RemoteCacheConfiguration.
ExecutorFactoryConfiguration	asyncExecutorFactory()
Supplier<FailoverRequestBalancingStrategy>	balancingStrategyFactory()
int	batchSize()
ClassLoader	classLoader()	Deprecated, for removal: This API element is subject to removal in a future version.
ClientIntelligence	clientIntelligence()
List<ClusterConfiguration>	clusters()
ConnectionPoolConfiguration	connectionPool()
int	connectionTimeout()
Class<? extends org.infinispan.client.hotrod.impl.consistenthash.ConsistentHash>[]	consistentHashImpl()
Class<? extends org.infinispan.client.hotrod.impl.consistenthash.ConsistentHash>	consistentHashImpl(int version)
int	dnsResolverMaxTTL()
int	dnsResolverMinTTL()
int	dnsResolverNegativeTTL()
Features	features()
boolean	forceReturnValues()
ClassAllowList	getClassAllowList()
ClassAllowList	getClassWhiteList()	Deprecated, for removal: This API element is subject to removal in a future version. Use getClassAllowList() instead.
List<org.infinispan.protostream.SerializationContextInitializer>	getContextInitializers()
int	keySizeEstimate()	Deprecated, for removal: This API element is subject to removal in a future version. Since 12.0, does nothing and will be removed in 15.0
Marshaller	marshaller()
Class<? extends Marshaller>	marshallerClass()
int	maxRetries()
RemoteCacheManagerMetricsRegistry	metricRegistry()
NearCacheConfiguration	nearCache()	Deprecated, for removal: This API element is subject to removal in a future version.
Properties	properties()
Map<String,RemoteCacheConfiguration>	remoteCaches()
void	removeRemoteCache(String name)	Remove a RemoteCacheConfiguration from this Configuration.
SecurityConfiguration	security()
List<String>	serialAllowList()
List<String>	serialWhitelist()	Deprecated, for removal: This API element is subject to removal in a future version. Use serialAllowList() instead.
int	serverFailureTimeout()	Controls how long a server is marked as failed in milliseconds.
List<ServerConfiguration>	servers()
int	socketTimeout()
StatisticsConfiguration	statistics()
boolean	tcpKeepAlive()
boolean	tcpNoDelay()
String	toString()
boolean	tracingPropagationEnabled()	OpenTelemetry tracing propagation will be activated if this property is true and if the OpenTelemetry API jar is detected on the classpath.
TransactionConfiguration	transaction()	Deprecated, for removal: This API element is subject to removal in a future version. since 12.0.
long	transactionTimeout()	see ConfigurationBuilder.transactionTimeout(long, TimeUnit),
TransportFactory	transportFactory()
int	valueSizeEstimate()	Deprecated, for removal: This API element is subject to removal in a future version. Since 12.0, does nothing and will be removed in 15.0
ProtocolVersion	version()

Methods inherited from class java.lang.Object

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

Constructor Details

Configuration

public Configuration(ExecutorFactoryConfiguration asyncExecutorFactory,
 Supplier<FailoverRequestBalancingStrategy> balancingStrategyFactory,
 ClassLoader classLoader,
 ClientIntelligence clientIntelligence,
 ConnectionPoolConfiguration connectionPool,
 int connectionTimeout,
 Class<? extends org.infinispan.client.hotrod.impl.consistenthash.ConsistentHash>[] consistentHashImpl,
 int dnsResolverMinTTL,
 int dnsResolverMaxTTL,
 int dnsResolverNegativeTTL,
 boolean forceReturnValues,
 int keySizeEstimate,
 Marshaller marshaller,
 Class<? extends Marshaller> marshallerClass,
 ProtocolVersion protocolVersion,
 List<ServerConfiguration> servers,
 int socketTimeout,
 SecurityConfiguration security,
 boolean tcpNoDelay,
 boolean tcpKeepAlive,
 int valueSizeEstimate,
 int maxRetries,
 NearCacheConfiguration nearCache,
 List<ClusterConfiguration> clusters,
 List<String> serialAllowList,
 int batchSize,
 TransactionConfiguration transaction,
 StatisticsConfiguration statistics,
 Features features,
 List<org.infinispan.protostream.SerializationContextInitializer> contextInitializers,
 Map<String,RemoteCacheConfiguration> remoteCaches,
 TransportFactory transportFactory,
 boolean tracingPropagationEnabled,
 RemoteCacheManagerMetricsRegistry metricRegistry,
 int serverFailureTimeout)

Method Details

asyncExecutorFactory

public ExecutorFactoryConfiguration asyncExecutorFactory()

balancingStrategyFactory

public Supplier<FailoverRequestBalancingStrategy> balancingStrategyFactory()

classLoader

@Deprecated(forRemoval=true)
public ClassLoader classLoader()

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

clientIntelligence

public ClientIntelligence clientIntelligence()

connectionPool

public ConnectionPoolConfiguration connectionPool()

connectionTimeout

public int connectionTimeout()

consistentHashImpl

public Class<? extends org.infinispan.client.hotrod.impl.consistenthash.ConsistentHash>[] consistentHashImpl()

consistentHashImpl

public Class<? extends org.infinispan.client.hotrod.impl.consistenthash.ConsistentHash> consistentHashImpl(int version)

dnsResolverMinTTL

public int dnsResolverMinTTL()

dnsResolverMaxTTL

public int dnsResolverMaxTTL()

dnsResolverNegativeTTL

public int dnsResolverNegativeTTL()

forceReturnValues

public boolean forceReturnValues()

keySizeEstimate

@Deprecated(forRemoval=true,
            since="12.0")
public int keySizeEstimate()

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

Since 12.0, does nothing and will be removed in 15.0

marshaller

public Marshaller marshaller()

marshallerClass

public Class<? extends Marshaller> marshallerClass()

nearCache

@Deprecated(forRemoval=true,
            since="11.0")
public NearCacheConfiguration nearCache()

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

version

public ProtocolVersion version()

servers

public List<ServerConfiguration> servers()

clusters

public List<ClusterConfiguration> clusters()

socketTimeout

public int socketTimeout()

security

public SecurityConfiguration security()

tcpNoDelay

public boolean tcpNoDelay()

tcpKeepAlive

public boolean tcpKeepAlive()

valueSizeEstimate

@Deprecated(forRemoval=true,
            since="12.0")
public int valueSizeEstimate()

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

Since 12.0, does nothing and will be removed in 15.0

maxRetries

public int maxRetries()

serialWhitelist

@Deprecated(forRemoval=true,
            since="12.0")
public List<String> serialWhitelist()

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

Use serialAllowList() instead. To be removed in 14.0.

serialAllowList

public List<String> serialAllowList()

getClassWhiteList

@Deprecated(forRemoval=true,
            since="12.0")
public ClassAllowList getClassWhiteList()

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

Use getClassAllowList() instead. To be removed in 14.0.

getClassAllowList

public ClassAllowList getClassAllowList()

batchSize

public int batchSize()

remoteCaches

public Map<String,RemoteCacheConfiguration> remoteCaches()

addRemoteCache

public RemoteCacheConfiguration addRemoteCache(String name,
 Consumer<RemoteCacheConfigurationBuilder> builderConsumer)

Create a new RemoteCacheConfiguration. This can be used to create additional configurations after a RemoteCacheManager has been initialized.

Parameters:

name - the name of the cache configuration to create

builderConsumer - a Consumer which receives a RemoteCacheConfigurationBuilder and can apply the necessary configurations on it.

Returns:

the RemoteCacheConfiguration

Throws:

IllegalArgumentException - if a cache configuration with the same name already exists

removeRemoteCache

public void removeRemoteCache(String name)

Remove a RemoteCacheConfiguration from this Configuration. If the cache configuration doesn't exist, this method has no effect.

Parameters:

name - the name of the RemoteCacheConfiguration to remove.

statistics

public StatisticsConfiguration statistics()

transaction

@Deprecated(forRemoval=true,
            since="12.0")
public TransactionConfiguration transaction()

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

since 12.0. To be removed in Infinispan 14.

transactionTimeout

public long transactionTimeout()

see ConfigurationBuilder.transactionTimeout(long, TimeUnit),

features

public Features features()

getContextInitializers

public List<org.infinispan.protostream.SerializationContextInitializer> getContextInitializers()

transportFactory

public TransportFactory transportFactory()

tracingPropagationEnabled

public boolean tracingPropagationEnabled()

OpenTelemetry tracing propagation will be activated if this property is true and if the OpenTelemetry API jar is detected on the classpath. By default, the property is true.

Returns:

if the tracing propagation is enabled

metricRegistry

public RemoteCacheManagerMetricsRegistry metricRegistry()

Returns:

The RemoteCacheManagerMetricsRegistry implementation to use for metrics.

serverFailureTimeout

public int serverFailureTimeout()

Controls how long a server is marked as failed in milliseconds. Default is 30_000 milliseconds or 30 seconds.

Returns:

time in milliseconds

toString

public String toString()

Overrides:

toString in class Object

properties

public Properties properties()