Class AbstractConfigurationChildBuilder

java.lang.Object

org.infinispan.client.hotrod.configuration.AbstractConfigurationChildBuilder

All Implemented Interfaces:

ConfigurationChildBuilder

Direct Known Subclasses:

AbstractSecurityConfigurationChildBuilder, ClusterConfigurationBuilder, ConnectionPoolConfigurationBuilder, ExecutorFactoryConfigurationBuilder, NearCacheConfigurationBuilder, SecurityConfigurationBuilder, ServerConfigurationBuilder, StatisticsConfigurationBuilder, TransactionConfigurationBuilder

public abstract class AbstractConfigurationChildBuilder
extends Object
implements ConfigurationChildBuilder

AbstractConfigurationChildBuilder.

Since:

5.3

Author:

Tristan Tarrant

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractConfigurationChildBuilder(ConfigurationBuilder builder)

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... regExs)	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... regExs)	Deprecated, for removal: This API element is subject to removal in a future version.
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 retriesPerServer)	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 tcpKeepAlive)	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.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractConfigurationChildBuilder

protected AbstractConfigurationChildBuilder(ConfigurationBuilder builder)

Method Details

addServer

public ServerConfigurationBuilder addServer()

Description copied from interface: ConfigurationChildBuilder

Adds a new remote server

Specified by:

addServer in interface ConfigurationChildBuilder

addCluster

public ClusterConfigurationBuilder addCluster(String clusterName)

Description copied from interface: ConfigurationChildBuilder

Adds a new remote server cluster

Specified by:

addCluster in interface ConfigurationChildBuilder

addServers

public ConfigurationBuilder addServers(String servers)

Description copied from interface: ConfigurationChildBuilder

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

Specified by:

addServers in interface ConfigurationChildBuilder

asyncExecutorFactory

public ExecutorFactoryConfigurationBuilder asyncExecutorFactory()

Description copied from interface: ConfigurationChildBuilder

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

Specified by:

asyncExecutorFactory in interface ConfigurationChildBuilder

balancingStrategy

public ConfigurationBuilder balancingStrategy(String balancingStrategy)

Description copied from interface: ConfigurationChildBuilder

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

Specified by:

balancingStrategy in interface ConfigurationChildBuilder

balancingStrategy

public ConfigurationBuilder balancingStrategy(Class<? extends FailoverRequestBalancingStrategy> balancingStrategy)

Description copied from interface: ConfigurationChildBuilder

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

Specified by:

balancingStrategy in interface ConfigurationChildBuilder

balancingStrategy

public ConfigurationBuilder balancingStrategy(Supplier<FailoverRequestBalancingStrategy> balancingStrategyFactory)

Description copied from interface: ConfigurationChildBuilder

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

Specified by:

balancingStrategy in interface ConfigurationChildBuilder

clientIntelligence

public ConfigurationBuilder clientIntelligence(ClientIntelligence clientIntelligence)

Description copied from interface: ConfigurationChildBuilder

Specifies the level of "intelligence" the client should have

Specified by:

clientIntelligence in interface ConfigurationChildBuilder

connectionPool

public ConnectionPoolConfigurationBuilder connectionPool()

Description copied from interface: ConfigurationChildBuilder

Configures the connection pool

Specified by:

connectionPool in interface ConfigurationChildBuilder

connectionTimeout

public ConfigurationBuilder connectionTimeout(int connectionTimeout)

Description copied from interface: ConfigurationChildBuilder

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

Specified by:

connectionTimeout in interface ConfigurationChildBuilder

consistentHashImpl

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

Description copied from interface: ConfigurationChildBuilder

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.

Specified by:

consistentHashImpl in interface ConfigurationChildBuilder

consistentHashImpl

public ConfigurationBuilder consistentHashImpl(int version,
 String consistentHashClass)

Description copied from interface: ConfigurationChildBuilder

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.

Specified by:

consistentHashImpl in interface ConfigurationChildBuilder

dnsResolverMinTTL

public ConfigurationBuilder dnsResolverMinTTL(int minTTL)

Specified by:

dnsResolverMinTTL in interface ConfigurationChildBuilder

dnsResolverMaxTTL

public ConfigurationBuilder dnsResolverMaxTTL(int maxTTL)

Specified by:

dnsResolverMaxTTL in interface ConfigurationChildBuilder

dnsResolverNegativeTTL

public ConfigurationBuilder dnsResolverNegativeTTL(int negativeTTL)

Specified by:

dnsResolverNegativeTTL in interface ConfigurationChildBuilder

serverFailureTimeout

public ConfigurationBuilder serverFailureTimeout(int timeoutInMilliseconds)

Description copied from interface: ConfigurationChildBuilder

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)

Specified by:

serverFailureTimeout in interface ConfigurationChildBuilder

Parameters:

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

Returns:

this builder

forceReturnValues

public ConfigurationBuilder forceReturnValues(boolean forceReturnValues)

Description copied from interface: ConfigurationChildBuilder

Whether or not to implicitly FORCE_RETURN_VALUE for all calls.

Specified by:

forceReturnValues in interface ConfigurationChildBuilder

keySizeEstimate

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

Specified by:

keySizeEstimate in interface ConfigurationChildBuilder

marshaller

public ConfigurationBuilder marshaller(String marshaller)

Description copied from interface: ConfigurationChildBuilder

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

Specified by:

marshaller in interface ConfigurationChildBuilder

marshaller

public ConfigurationBuilder marshaller(Class<? extends Marshaller> marshaller)

Description copied from interface: ConfigurationChildBuilder

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

Specified by:

marshaller in interface ConfigurationChildBuilder

marshaller

public ConfigurationBuilder marshaller(Marshaller marshaller)

Description copied from interface: ConfigurationChildBuilder

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

Specified by:

marshaller in interface ConfigurationChildBuilder

addContextInitializer

public ConfigurationBuilder addContextInitializer(String contextInitializer)

Description copied from interface: ConfigurationChildBuilder

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

Specified by:

addContextInitializer in interface ConfigurationChildBuilder

addContextInitializer

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

Description copied from interface: ConfigurationChildBuilder

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

Specified by:

addContextInitializer in interface ConfigurationChildBuilder

addContextInitializers

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

Description copied from interface: ConfigurationChildBuilder

Convenience method to supply multiple SerializationContextInitializer implementations.

Specified by:

addContextInitializers in interface ConfigurationChildBuilder

See Also:

• ConfigurationChildBuilder.addContextInitializer(SerializationContextInitializer)

version

public ConfigurationBuilder version(ProtocolVersion protocolVersion)

Description copied from interface: ConfigurationChildBuilder

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

Specified by:

version in interface ConfigurationChildBuilder

socketTimeout

public ConfigurationBuilder socketTimeout(int socketTimeout)

Description copied from interface: ConfigurationChildBuilder

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

Specified by:

socketTimeout in interface ConfigurationChildBuilder

security

public SecurityConfigurationBuilder security()

Description copied from interface: ConfigurationChildBuilder

Security Configuration

Specified by:

security in interface ConfigurationChildBuilder

tcpNoDelay

public ConfigurationBuilder tcpNoDelay(boolean tcpNoDelay)

Description copied from interface: ConfigurationChildBuilder

Affects TCP NODELAY on the TCP stack. Defaults to enabled

Specified by:

tcpNoDelay in interface ConfigurationChildBuilder

tcpKeepAlive

public ConfigurationBuilder tcpKeepAlive(boolean tcpKeepAlive)

Description copied from interface: ConfigurationChildBuilder

Affects TCP KEEPALIVE on the TCP stack. Defaults to disable

Specified by:

tcpKeepAlive in interface ConfigurationChildBuilder

valueSizeEstimate

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

Specified by:

valueSizeEstimate in interface ConfigurationChildBuilder

maxRetries

public ConfigurationBuilder maxRetries(int retriesPerServer)

Description copied from interface: ConfigurationChildBuilder

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.

Specified by:

maxRetries in interface ConfigurationChildBuilder

addJavaSerialAllowList

public ConfigurationBuilder addJavaSerialAllowList(String... regExs)

Description copied from interface: ConfigurationChildBuilder

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.

Specified by:

addJavaSerialAllowList in interface ConfigurationChildBuilder

addJavaSerialWhiteList

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

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

Specified by:

addJavaSerialWhiteList in interface ConfigurationChildBuilder

batchSize

public ConfigurationBuilder batchSize(int batchSize)

Description copied from interface: ConfigurationChildBuilder

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

Specified by:

batchSize in interface ConfigurationChildBuilder

Parameters:

batchSize - the batch size to set

Returns:

this configuration builder with the batch size set

statistics

public StatisticsConfigurationBuilder statistics()

Description copied from interface: ConfigurationChildBuilder

Configures client-side statistics.

Specified by:

statistics in interface ConfigurationChildBuilder

transaction

public TransactionConfigurationBuilder transaction()

Description copied from interface: ConfigurationChildBuilder

Transaction configuration

Specified by:

transaction in interface ConfigurationChildBuilder

remoteCache

public RemoteCacheConfigurationBuilder remoteCache(String name)

Description copied from interface: ConfigurationChildBuilder

Per-cache configuration

Specified by:

remoteCache in interface ConfigurationChildBuilder

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

public ConfigurationBuilder transactionTimeout(long timeout,
 TimeUnit timeUnit)

Description copied from interface: ConfigurationChildBuilder

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.

Specified by:

transactionTimeout in interface ConfigurationChildBuilder

transportFactory

public ConfigurationBuilder transportFactory(TransportFactory transportFactory)

Description copied from interface: ConfigurationChildBuilder

Set the TransportFactory. It defaults to DefaultTransportFactory Defaults to TransportFactory.DEFAULT. If any other factory is used, any event loop created/used via TransportFactory.createEventLoopGroup(int, ExecutorService) will not be closed upon shutdown of the RemoteCacheManager.

Specified by:

transportFactory in interface ConfigurationChildBuilder

Parameters:

transportFactory - an instance of TransportFactory

withMetricRegistry

public ConfigurationBuilder withMetricRegistry(RemoteCacheManagerMetricsRegistry metricRegistry)

Description copied from interface: ConfigurationChildBuilder

Sets the RemoteCacheManagerMetricsRegistry.

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

Specified by:

withMetricRegistry in interface ConfigurationChildBuilder

Parameters:

metricRegistry - The RemoteCacheManagerMetricsRegistry implementation.

uri

public ConfigurationBuilder uri(URI uri)

Description copied from interface: ConfigurationChildBuilder

Configures this builder using the specified URI.

Specified by:

uri in interface ConfigurationChildBuilder

uri

public ConfigurationBuilder uri(String uri)

Description copied from interface: ConfigurationChildBuilder

Configures this builder using the specified URI.

Specified by:

uri in interface ConfigurationChildBuilder

withProperties

public ConfigurationBuilder withProperties(Properties properties)

Description copied from interface: ConfigurationChildBuilder

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

Specified by:

withProperties in interface ConfigurationChildBuilder

build

public Configuration build()

Description copied from interface: ConfigurationChildBuilder

Builds a configuration object

Specified by:

build in interface ConfigurationChildBuilder