Package org.infinispan.hotrod.configuration

Class HotRodConfigurationBuilder

java.lang.Object

org.infinispan.hotrod.configuration.HotRodConfigurationBuilder

All Implemented Interfaces:

org.infinispan.commons.configuration.Builder<HotRodConfiguration>, ConfigurationChildBuilder

public class HotRodConfigurationBuilder
extends Object
implements ConfigurationChildBuilder, org.infinispan.commons.configuration.Builder<HotRodConfiguration>

ConfigurationBuilder used to generate immutable HotRodConfiguration objects to pass to the Infinispan.create(Configuration) method.

If you prefer to configure the client declaratively, see org.infinispan.hotrod.configuration

Since:

14.0

Constructor Summary

Constructors

Constructor	Description
HotRodConfigurationBuilder()

Method Summary

Modifier and Type	Method	Description
ClusterConfigurationBuilder	addCluster(String clusterName)	Adds a new remote server cluster
HotRodConfigurationBuilder	addContextInitializer(String contextInitializer)	Supply a SerializationContextInitializer implementation to register classes with the ProtoStreamMarshaller's SerializationContext.
HotRodConfigurationBuilder	addContextInitializer(org.infinispan.protostream.SerializationContextInitializer contextInitializer)	Supply a SerializationContextInitializer implementation to register classes with the ProtoStreamMarshaller's SerializationContext.
HotRodConfigurationBuilder	addContextInitializers(org.infinispan.protostream.SerializationContextInitializer... contextInitializers)	Convenience method to supply multiple SerializationContextInitializer implementations.
HotRodConfigurationBuilder	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.
ServerConfigurationBuilder	addServer()	Adds a new remote server
HotRodConfigurationBuilder	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().
org.infinispan.commons.configuration.attributes.AttributeSet	attributes()
HotRodConfigurationBuilder	balancingStrategy(Class<? extends FailoverRequestBalancingStrategy> balancingStrategy)	For replicated (vs distributed) Hot Rod server clusters, the client balances requests to the servers according to this strategy.
HotRodConfigurationBuilder	balancingStrategy(String balancingStrategy)	For replicated (vs distributed) Hot Rod server clusters, the client balances requests to the servers according to this strategy.
HotRodConfigurationBuilder	balancingStrategy(Supplier<FailoverRequestBalancingStrategy> balancingStrategyFactory)	For replicated (vs distributed) Hot Rod server clusters, the client balances requests to the servers according to this strategy.
HotRodConfigurationBuilder	batchSize(int batchSize)	Sets the batch size of internal iterators (ie.
HotRodConfiguration	build()	Builds a configuration object
HotRodConfiguration	build(boolean validate)
HotRodConfigurationBuilder	clientIntelligence(ClientIntelligence clientIntelligence)	Specifies the level of "intelligence" the client should have
ConnectionPoolConfigurationBuilder	connectionPool()	Configures the connection pool
HotRodConfigurationBuilder	connectionTimeout(int connectionTimeout)	This property defines the maximum socket connect timeout in milliseconds before giving up connecting to the server.
HotRodConfigurationBuilder	consistentHashImpl(int version, Class<? extends ConsistentHash> consistentHashClass)	Defines the ConsistentHash implementation to use for the specified version.
HotRodConfigurationBuilder	consistentHashImpl(int version, String consistentHashClass)	Defines the ConsistentHash implementation to use for the specified version.
HotRodConfiguration	create()
HotRodConfigurationBuilder	disableTracingPropagation()
HotRodConfigurationBuilder	forceReturnValues(boolean forceReturnValues)	Whether or not to implicitly FORCE_RETURN_VALUE for all calls.
HotRodConfigurationBuilder	marshaller(Class<? extends org.infinispan.commons.marshall.Marshaller> marshallerClass)	Allows you to specify a custom Marshaller implementation to serialize and deserialize user objects.
HotRodConfigurationBuilder	marshaller(String marshallerClassName)	Allows you to specify a custom Marshaller implementation to serialize and deserialize user objects.
HotRodConfigurationBuilder	marshaller(org.infinispan.commons.marshall.Marshaller marshaller)	Allows you to specify an instance of Marshaller to serialize and deserialize user objects.
HotRodConfigurationBuilder	maxRetries(int maxRetries)	It sets the maximum number of retries for each request.
static void	parseServers(String servers, BiConsumer<String,Integer> c)
HotRodConfigurationBuilder	read(HotRodConfiguration template)
RemoteCacheConfigurationBuilder	remoteCache(String name)	Per-cache configuration
SecurityConfigurationBuilder	security()	Security Configuration
List<ServerConfigurationBuilder>	servers()
HotRodConfigurationBuilder	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.
HotRodConfigurationBuilder	tcpKeepAlive(boolean keepAlive)	Affects TCP KEEPALIVE on the TCP stack.
HotRodConfigurationBuilder	tcpNoDelay(boolean tcpNoDelay)	Affects TCP NODELAY on the TCP stack.
HotRodConfigurationBuilder	transactionTimeout(long timeout, TimeUnit timeUnit)	Sets the transaction's timeout.
HotRodConfigurationBuilder	transportFactory(TransportFactory transportFactory)	Set the TransportFactory.
HotRodConfigurationBuilder	uri(String uri)	Configures this builder using the specified URI.
HotRodConfigurationBuilder	uri(URI uri)	Configures this builder using the specified URI.
void	validate()
HotRodConfigurationBuilder	version(ProtocolVersion protocolVersion)	This property defines the protocol version that this client should use.
HotRodConfigurationBuilder	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

HotRodConfigurationBuilder

public HotRodConfigurationBuilder()

Method Details

attributes

public org.infinispan.commons.configuration.attributes.AttributeSet attributes()

Specified by:

attributes in interface org.infinispan.commons.configuration.Builder<HotRodConfiguration>

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 HotRodConfigurationBuilder 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

servers

public List<ServerConfigurationBuilder> servers()

parseServers

public static void parseServers(String servers,
 BiConsumer<String,Integer> c)

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 HotRodConfigurationBuilder 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 HotRodConfigurationBuilder 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

balancingStrategy

public HotRodConfigurationBuilder 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

clientIntelligence

public HotRodConfigurationBuilder 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 HotRodConfigurationBuilder 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.

Specified by:

connectionTimeout in interface ConfigurationChildBuilder

consistentHashImpl

public HotRodConfigurationBuilder consistentHashImpl(int version,
 Class<? extends 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 HotRodConfigurationBuilder 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

forceReturnValues

public HotRodConfigurationBuilder 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

marshaller

public HotRodConfigurationBuilder marshaller(String marshallerClassName)

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 HotRodConfigurationBuilder marshaller(Class<? extends org.infinispan.commons.marshall.Marshaller> marshallerClass)

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 HotRodConfigurationBuilder marshaller(org.infinispan.commons.marshall.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 HotRodConfigurationBuilder 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 HotRodConfigurationBuilder 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 HotRodConfigurationBuilder addContextInitializers(org.infinispan.protostream.SerializationContextInitializer... contextInitializers)

Description copied from interface: ConfigurationChildBuilder

Convenience method to supply multiple SerializationContextInitializer implementations.

Specified by:

addContextInitializers in interface ConfigurationChildBuilder

version

public HotRodConfigurationBuilder 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

security

public SecurityConfigurationBuilder security()

Description copied from interface: ConfigurationChildBuilder

Security Configuration

Specified by:

security in interface ConfigurationChildBuilder

socketTimeout

public HotRodConfigurationBuilder 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 60000 (1 minute)

Specified by:

socketTimeout in interface ConfigurationChildBuilder

tcpNoDelay

public HotRodConfigurationBuilder 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 HotRodConfigurationBuilder tcpKeepAlive(boolean keepAlive)

Description copied from interface: ConfigurationChildBuilder

Affects TCP KEEPALIVE on the TCP stack. Defaults to disable

Specified by:

tcpKeepAlive in interface ConfigurationChildBuilder

uri

public HotRodConfigurationBuilder uri(URI uri)

Description copied from interface: ConfigurationChildBuilder

Configures this builder using the specified URI.

Specified by:

uri in interface ConfigurationChildBuilder

uri

public HotRodConfigurationBuilder uri(String uri)

Description copied from interface: ConfigurationChildBuilder

Configures this builder using the specified URI.

Specified by:

uri in interface ConfigurationChildBuilder

maxRetries

public HotRodConfigurationBuilder maxRetries(int maxRetries)

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 HotRodConfigurationBuilder addJavaSerialAllowList(String... regEx)

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

batchSize

public HotRodConfigurationBuilder 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

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 HotRodConfigurationBuilder 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 HotRodConfigurationBuilder transportFactory(TransportFactory transportFactory)

Description copied from interface: ConfigurationChildBuilder

Set the TransportFactory. It defaults to DefaultTransportFactory

Specified by:

transportFactory in interface ConfigurationChildBuilder

Parameters:

transportFactory - an instance of TransportFactory

disableTracingPropagation

public HotRodConfigurationBuilder disableTracingPropagation()

withProperties

public HotRodConfigurationBuilder withProperties(Properties properties)

Description copied from interface: ConfigurationChildBuilder

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

Specified by:

withProperties in interface ConfigurationChildBuilder

validate

public void validate()

Specified by:

validate in interface org.infinispan.commons.configuration.Builder<HotRodConfiguration>

create

public HotRodConfiguration create()

Specified by:

create in interface org.infinispan.commons.configuration.Builder<HotRodConfiguration>

build

public HotRodConfiguration build()

Description copied from interface: ConfigurationChildBuilder

Builds a configuration object

Specified by:

build in interface ConfigurationChildBuilder

build

public HotRodConfiguration build(boolean validate)

read

public HotRodConfigurationBuilder read(HotRodConfiguration template)

Specified by:

read in interface org.infinispan.commons.configuration.Builder<HotRodConfiguration>