Package org.infinispan.client.hotrod.configuration

Interface ConfigurationChildBuilder

All Known Implementing Classes:

AbstractConfigurationChildBuilder, AbstractSecurityConfigurationChildBuilder, AuthenticationConfigurationBuilder, ClusterConfigurationBuilder, ConfigurationBuilder, ConnectionPoolConfigurationBuilder, ExecutorFactoryConfigurationBuilder, NearCacheConfigurationBuilder, SecurityConfigurationBuilder, ServerConfigurationBuilder, SslConfigurationBuilder, StatisticsConfigurationBuilder, TransactionConfigurationBuilder

public interface ConfigurationChildBuilder

ConfigurationChildBuilder.

Since:

5.3

Author:

Tristan Tarrant

Method Summary

Modifier and Type	Method	Description
ClusterConfigurationBuilder	addCluster(String clusterName)	Adds a new remote server cluster
ConfigurationBuilder	addContextInitializer(String contextInitializer)	Supply a SerializationContextInitializer implementation to register classes with the ProtoStreamMarshaller's SerializationContext.
ConfigurationBuilder	addContextInitializer(org.infinispan.protostream.SerializationContextInitializer contextInitializer)	Supply a SerializationContextInitializer implementation to register classes with the ProtoStreamMarshaller's SerializationContext.
ConfigurationBuilder	addContextInitializers(org.infinispan.protostream.SerializationContextInitializer... contextInitializers)	Convenience method to supply multiple SerializationContextInitializer implementations.
ConfigurationBuilder	addJavaSerialAllowList(String... regEx)	List of regular expressions for classes that can be deserialized using standard Java deserialization when reading data that might have been stored with a different endpoint, e.g.
ConfigurationBuilder	addJavaSerialWhiteList(String... regEx)	Deprecated, for removal: This API element is subject to removal in a future version. Use addJavaSerialAllowList(String...) instead.
ServerConfigurationBuilder	addServer()	Adds a new remote server
ConfigurationBuilder	addServers(String servers)	Adds a list of remote servers in the form: host1[:port][;host2[:port]]...
ExecutorFactoryConfigurationBuilder	asyncExecutorFactory()	Configuration for the executor service used for asynchronous work on the Transport, including asynchronous marshalling and Cache 'async operations' such as Cache.putAsync().
ConfigurationBuilder	balancingStrategy(Class<? extends FailoverRequestBalancingStrategy> balancingStrategy)	For replicated (vs distributed) Hot Rod server clusters, the client balances requests to the servers according to this strategy.
ConfigurationBuilder	balancingStrategy(String balancingStrategy)	For replicated (vs distributed) Hot Rod server clusters, the client balances requests to the servers according to this strategy.
ConfigurationBuilder	balancingStrategy(Supplier<FailoverRequestBalancingStrategy> balancingStrategyFactory)	For replicated (vs distributed) Hot Rod server clusters, the client balances requests to the servers according to this strategy.
ConfigurationBuilder	batchSize(int batchSize)	Sets the batch size of internal iterators (ie.
Configuration	build()	Builds a configuration object
ConfigurationBuilder	clientIntelligence(ClientIntelligence clientIntelligence)	Specifies the level of "intelligence" the client should have
ConnectionPoolConfigurationBuilder	connectionPool()	Configures the connection pool
ConfigurationBuilder	connectionTimeout(int connectionTimeout)	This property defines the maximum socket connect timeout in milliseconds before giving up connecting to the server.
ConfigurationBuilder	consistentHashImpl(int version, Class<? extends org.infinispan.client.hotrod.impl.consistenthash.ConsistentHash> consistentHashClass)	Defines the ConsistentHash implementation to use for the specified version.
ConfigurationBuilder	consistentHashImpl(int version, String consistentHashClass)	Defines the ConsistentHash implementation to use for the specified version.
ConfigurationBuilder	dnsResolverMaxTTL(int maxTTL)
ConfigurationBuilder	dnsResolverMinTTL(int minTTL)
ConfigurationBuilder	dnsResolverNegativeTTL(int negativeTTL)
ConfigurationBuilder	forceReturnValues(boolean forceReturnValues)	Whether or not to implicitly FORCE_RETURN_VALUE for all calls.
ConfigurationBuilder	keySizeEstimate(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
ConfigurationBuilder	marshaller(Class<? extends Marshaller> marshaller)	Allows you to specify a custom Marshaller implementation to serialize and deserialize user objects.
ConfigurationBuilder	marshaller(String marshaller)	Allows you to specify a custom Marshaller implementation to serialize and deserialize user objects.
ConfigurationBuilder	marshaller(Marshaller marshaller)	Allows you to specify an instance of Marshaller to serialize and deserialize user objects.
ConfigurationBuilder	maxRetries(int maxRetries)	It sets the maximum number of retries for each request.
RemoteCacheConfigurationBuilder	remoteCache(String name)	Per-cache configuration
SecurityConfigurationBuilder	security()	Security Configuration
ConfigurationBuilder	serverFailureTimeout(int timeoutInMilliseconds)	The time for a failed server to be cleared allowing for it to attempt to reconnect at a later point.
ConfigurationBuilder	socketTimeout(int socketTimeout)	This property defines the maximum socket read timeout in milliseconds before giving up waiting for bytes from the server.
StatisticsConfigurationBuilder	statistics()	Configures client-side statistics.
ConfigurationBuilder	tcpKeepAlive(boolean keepAlive)	Affects TCP KEEPALIVE on the TCP stack.
ConfigurationBuilder	tcpNoDelay(boolean tcpNoDelay)	Affects TCP NODELAY on the TCP stack.
TransactionConfigurationBuilder	transaction()	Transaction configuration
ConfigurationBuilder	transactionTimeout(long timeout, TimeUnit timeUnit)	Sets the transaction's timeout.
ConfigurationBuilder	transportFactory(TransportFactory transportFactory)	Set the TransportFactory.
ConfigurationBuilder	uri(String uri)	Configures this builder using the specified URI.
ConfigurationBuilder	uri(URI uri)	Configures this builder using the specified URI.
ConfigurationBuilder	valueSizeEstimate(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
ConfigurationBuilder	version(ProtocolVersion protocolVersion)	This property defines the protocol version that this client should use.
ConfigurationBuilder	withMetricRegistry(RemoteCacheManagerMetricsRegistry metricRegistry)	Sets the RemoteCacheManagerMetricsRegistry.
ConfigurationBuilder	withProperties(Properties properties)	Configures this builder using the specified properties.

Method Details

addServer

ServerConfigurationBuilder addServer()

Adds a new remote server

addCluster

ClusterConfigurationBuilder addCluster(String clusterName)

Adds a new remote server cluster

addServers

ConfigurationBuilder addServers(String servers)

Adds a list of remote servers in the form: host1[:port][;host2[:port]]...

asyncExecutorFactory

ExecutorFactoryConfigurationBuilder asyncExecutorFactory()

Configuration for the executor service used for asynchronous work on the Transport, including asynchronous marshalling and Cache 'async operations' such as Cache.putAsync().

balancingStrategy

ConfigurationBuilder balancingStrategy(String balancingStrategy)

For replicated (vs distributed) Hot Rod server clusters, the client balances requests to the servers according to this strategy.

balancingStrategy

ConfigurationBuilder balancingStrategy(Supplier<FailoverRequestBalancingStrategy> balancingStrategyFactory)

For replicated (vs distributed) Hot Rod server clusters, the client balances requests to the servers according to this strategy.

balancingStrategy

ConfigurationBuilder balancingStrategy(Class<? extends FailoverRequestBalancingStrategy> balancingStrategy)

For replicated (vs distributed) Hot Rod server clusters, the client balances requests to the servers according to this strategy.

clientIntelligence

ConfigurationBuilder clientIntelligence(ClientIntelligence clientIntelligence)

Specifies the level of "intelligence" the client should have

connectionPool

ConnectionPoolConfigurationBuilder connectionPool()

Configures the connection pool

connectionTimeout

ConfigurationBuilder connectionTimeout(int connectionTimeout)

This property defines the maximum socket connect timeout in milliseconds before giving up connecting to the server. Defaults to ConfigurationProperties.DEFAULT_CONNECT_TIMEOUT

consistentHashImpl

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

Defines the ConsistentHash implementation to use for the specified version. By default, ConsistentHashV2 is used for version 1 and ConsistentHashV2 is used for version 2.

consistentHashImpl

ConfigurationBuilder consistentHashImpl(int version,
 String consistentHashClass)

Defines the ConsistentHash implementation to use for the specified version. By default, ConsistentHashV2 is used for version 1 and ConsistentHashV2 is used for version 2.

dnsResolverMinTTL

ConfigurationBuilder dnsResolverMinTTL(int minTTL)

dnsResolverMaxTTL

ConfigurationBuilder dnsResolverMaxTTL(int maxTTL)

dnsResolverNegativeTTL

ConfigurationBuilder dnsResolverNegativeTTL(int negativeTTL)

forceReturnValues

ConfigurationBuilder forceReturnValues(boolean forceReturnValues)

Whether or not to implicitly FORCE_RETURN_VALUE for all calls.

keySizeEstimate

@Deprecated(forRemoval=true,
            since="12.0")
ConfigurationBuilder keySizeEstimate(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

ConfigurationBuilder marshaller(String marshaller)

Allows you to specify a custom Marshaller implementation to serialize and deserialize user objects. This method is mutually exclusive with marshaller(Marshaller).

marshaller

ConfigurationBuilder marshaller(Class<? extends Marshaller> marshaller)

Allows you to specify a custom Marshaller implementation to serialize and deserialize user objects. This method is mutually exclusive with marshaller(Marshaller).

marshaller

ConfigurationBuilder marshaller(Marshaller marshaller)

Allows you to specify an instance of Marshaller to serialize and deserialize user objects. This method is mutually exclusive with marshaller(Class).

addContextInitializer

ConfigurationBuilder addContextInitializer(String contextInitializer)

Supply a SerializationContextInitializer implementation to register classes with the ProtoStreamMarshaller's SerializationContext.

addContextInitializer

ConfigurationBuilder addContextInitializer(org.infinispan.protostream.SerializationContextInitializer contextInitializer)

Supply a SerializationContextInitializer implementation to register classes with the ProtoStreamMarshaller's SerializationContext.

addContextInitializers

ConfigurationBuilder addContextInitializers(org.infinispan.protostream.SerializationContextInitializer... contextInitializers)

Convenience method to supply multiple SerializationContextInitializer implementations.

version

ConfigurationBuilder version(ProtocolVersion protocolVersion)

This property defines the protocol version that this client should use. Defaults to the latest protocol version supported by this client.

socketTimeout

ConfigurationBuilder socketTimeout(int socketTimeout)

This property defines the maximum socket read timeout in milliseconds before giving up waiting for bytes from the server. Defaults to ConfigurationProperties.DEFAULT_SO_TIMEOUT

security

SecurityConfigurationBuilder security()

Security Configuration

tcpNoDelay

ConfigurationBuilder tcpNoDelay(boolean tcpNoDelay)

Affects TCP NODELAY on the TCP stack. Defaults to enabled

tcpKeepAlive

ConfigurationBuilder tcpKeepAlive(boolean keepAlive)

Affects TCP KEEPALIVE on the TCP stack. Defaults to disable

uri

ConfigurationBuilder uri(URI uri)

Configures this builder using the specified URI.

uri

ConfigurationBuilder uri(String uri)

Configures this builder using the specified URI.

valueSizeEstimate

@Deprecated(forRemoval=true,
            since="12.0")
ConfigurationBuilder valueSizeEstimate(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

ConfigurationBuilder maxRetries(int maxRetries)

It sets the maximum number of retries for each request. A valid value should be greater or equals than 0 (zero). Zero means no retry will made in case of a network failure. It defaults to 10.

serverFailureTimeout

ConfigurationBuilder serverFailureTimeout(int timeoutInMilliseconds)

The time for a failed server to be cleared allowing for it to attempt to reconnect at a later point.

If the value is less than or equal to 0 it will be disabled, meaning a failed server will not be reconnected to until all configured servers have failed or a topology update (ClientIntelligence.TOPOLOGY_AWARE and ClientIntelligence.HASH_DISTRIBUTION_AWARE only)

Parameters:

timeoutInMilliseconds - the timeout to attempt to clear a failed server in milliseconds

Returns:

this builder

addJavaSerialAllowList

ConfigurationBuilder addJavaSerialAllowList(String... regEx)

List of regular expressions for classes that can be deserialized using standard Java deserialization when reading data that might have been stored with a different endpoint, e.g. REST.

addJavaSerialWhiteList

@Deprecated(forRemoval=true,
            since="12.0")
ConfigurationBuilder addJavaSerialWhiteList(String... regEx)

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

Use addJavaSerialAllowList(String...) instead. To be removed in 14.0.

batchSize

ConfigurationBuilder batchSize(int batchSize)

Sets the batch size of internal iterators (ie. keySet().iterator(). Defaults to 10_000

Parameters:

batchSize - the batch size to set

Returns:

this configuration builder with the batch size set

statistics

StatisticsConfigurationBuilder statistics()

Configures client-side statistics.

transaction

TransactionConfigurationBuilder transaction()

Transaction configuration

remoteCache

RemoteCacheConfigurationBuilder remoteCache(String name)

Per-cache configuration

Parameters:

name - the name of the cache to which specific configuration should be applied. You may use wildcard globbing (e.g. cache-*) which will apply to any cache that matches.

Returns:

the RemoteCacheConfigurationBuilder for the cache

transactionTimeout

ConfigurationBuilder transactionTimeout(long timeout,
 TimeUnit timeUnit)

Sets the transaction's timeout.

This timeout is used by the server to rollback unrecoverable transaction when they are idle for this amount of time.

An unrecoverable transaction are transaction enlisted as Synchronization (TransactionMode.NON_XA) or XAResource without recovery enabled (TransactionMode.NON_DURABLE_XA).

For XAResource, this value is overwritten by XAResource.setTransactionTimeout(int).

It defaults to 1 minute.

transportFactory

ConfigurationBuilder transportFactory(TransportFactory transportFactory)

Set the TransportFactory. It defaults to DefaultTransportFactory

Parameters:

transportFactory - an instance of TransportFactory

withProperties

ConfigurationBuilder withProperties(Properties properties)

Configures this builder using the specified properties. See ConfigurationBuilder for a list.

withMetricRegistry

ConfigurationBuilder withMetricRegistry(RemoteCacheManagerMetricsRegistry metricRegistry)

Sets the RemoteCacheManagerMetricsRegistry.

The Hot Rod client will register metrics about connection pool and cache accesses using that instance.

Parameters:

metricRegistry - The RemoteCacheManagerMetricsRegistry implementation.

build

Configuration build()

Builds a configuration object