Package org.infinispan.hotrod.configuration

Interface ConfigurationChildBuilder

All Known Implementing Classes:

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

public interface ConfigurationChildBuilder

ConfigurationChildBuilder.

Since:

14.0

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().
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
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.
HotRodConfigurationBuilder	dnsResolverMaxTTL(int ttl)
HotRodConfigurationBuilder	dnsResolverMinTTL(int ttl)
HotRodConfigurationBuilder	dnsResolverNegativeTTL(int ttl)
HotRodConfigurationBuilder	forceReturnValues(boolean forceReturnValues)	Whether or not to implicitly FORCE_RETURN_VALUE for all calls.
HotRodConfigurationBuilder	marshaller(Class<? extends org.infinispan.commons.marshall.Marshaller> marshaller)	Allows you to specify a custom Marshaller implementation to serialize and deserialize user objects.
HotRodConfigurationBuilder	marshaller(String marshaller)	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.
RemoteCacheConfigurationBuilder	remoteCache(String name)	Per-cache configuration
SecurityConfigurationBuilder	security()	Security Configuration
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.
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.

Method Details

addServer

ServerConfigurationBuilder addServer()

Adds a new remote server

addCluster

ClusterConfigurationBuilder addCluster(String clusterName)

Adds a new remote server cluster

addServers

HotRodConfigurationBuilder 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

HotRodConfigurationBuilder balancingStrategy(String balancingStrategy)

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

balancingStrategy

HotRodConfigurationBuilder balancingStrategy(Supplier<FailoverRequestBalancingStrategy> balancingStrategyFactory)

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

balancingStrategy

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.

clientIntelligence

HotRodConfigurationBuilder clientIntelligence(ClientIntelligence clientIntelligence)

Specifies the level of "intelligence" the client should have

connectionPool

ConnectionPoolConfigurationBuilder connectionPool()

Configures the connection pool

connectionTimeout

HotRodConfigurationBuilder connectionTimeout(int connectionTimeout)

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

consistentHashImpl

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

HotRodConfigurationBuilder 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

HotRodConfigurationBuilder dnsResolverMinTTL(int ttl)

dnsResolverMaxTTL

HotRodConfigurationBuilder dnsResolverMaxTTL(int ttl)

dnsResolverNegativeTTL

HotRodConfigurationBuilder dnsResolverNegativeTTL(int ttl)

forceReturnValues

HotRodConfigurationBuilder forceReturnValues(boolean forceReturnValues)

Whether or not to implicitly FORCE_RETURN_VALUE for all calls.

marshaller

HotRodConfigurationBuilder 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

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

HotRodConfigurationBuilder marshaller(org.infinispan.commons.marshall.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

HotRodConfigurationBuilder addContextInitializer(String contextInitializer)

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

addContextInitializer

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

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

addContextInitializers

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

Convenience method to supply multiple SerializationContextInitializer implementations.

version

HotRodConfigurationBuilder 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

HotRodConfigurationBuilder socketTimeout(int socketTimeout)

This property defines the maximum socket read timeout in milliseconds before giving up waiting for bytes from the server. Defaults to 60000 (1 minute)

security

SecurityConfigurationBuilder security()

Security Configuration

tcpNoDelay

HotRodConfigurationBuilder tcpNoDelay(boolean tcpNoDelay)

Affects TCP NODELAY on the TCP stack. Defaults to enabled

tcpKeepAlive

HotRodConfigurationBuilder tcpKeepAlive(boolean keepAlive)

Affects TCP KEEPALIVE on the TCP stack. Defaults to disable

uri

HotRodConfigurationBuilder uri(URI uri)

Configures this builder using the specified URI.

uri

HotRodConfigurationBuilder uri(String uri)

Configures this builder using the specified URI.

maxRetries

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

addJavaSerialAllowList

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

batchSize

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

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

HotRodConfigurationBuilder 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

HotRodConfigurationBuilder transportFactory(TransportFactory transportFactory)

Set the TransportFactory. It defaults to DefaultTransportFactory

Parameters:

transportFactory - an instance of TransportFactory

withProperties

HotRodConfigurationBuilder withProperties(Properties properties)

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

build

HotRodConfiguration build()

Builds a configuration object