java.lang.Object
- org.infinispan.client.hotrod.configuration.ConfigurationBuilder

All Implemented Interfaces:

ConfigurationChildBuilder, Builder<Configuration>
```
public class ConfigurationBuilder
extends Object
implements ConfigurationChildBuilder, Builder<Configuration>
```
ConfigurationBuilder used to generate immutable Configuration objects to pass to the RemoteCacheManager(Configuration) constructor.

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

Since:

5.3

Author:

Tristan Tarrant

Constructor Summary

Constructors
Constructor Description

ConfigurationBuilder()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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`	`addJavaSerialWhiteList(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
`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`	`balancingStrategy(FailoverRequestBalancingStrategy balancingStrategy)`	Deprecated.
`ConfigurationBuilder`	`batchSize(int batchSize)`	Sets the batch size of internal iterators (ie.
`Configuration`	`build()`	Builds a configuration object
`Configuration`	`build(boolean validate)`
`ConfigurationBuilder`	`classLoader(ClassLoader cl)`	Specifies the `ClassLoader` used to find certain resources used by configuration when specified by name (e.g.
`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.
`Configuration`	`create()`	Create the configuration bean
`ConfigurationBuilder`	`forceReturnValues(boolean forceReturnValues)`	Whether or not to implicitly FORCE_RETURN_VALUE for all calls.
`ConfigurationBuilder`	`keySizeEstimate(int keySizeEstimate)`	This hint allows sizing of byte buffers when serializing and deserializing keys, to minimize array resizing.
`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.
`NearCacheConfigurationBuilder`	`nearCache()`	Deprecated. since 11.0.
`static void`	`parseServers(String servers, BiConsumer<String,Integer> c)`
`ConfigurationBuilder`	`protocolVersion(String protocolVersion)`	Deprecated. Use `version(ProtocolVersion)` instead.
`ConfigurationBuilder`	`read(Configuration template)`	Reads the configuration from an already created configuration bean into this builder.
`RemoteCacheConfigurationBuilder`	`remoteCache(String name)`	Per-cache configuration
`SecurityConfigurationBuilder`	`security()`	Security Configuration
`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
`void`	`validate()`	Validate the data in this builder before building the configuration bean
`ConfigurationBuilder`	`valueSizeEstimate(int valueSizeEstimate)`	This hint allows sizing of byte buffers when serializing and deserializing values, to minimize array resizing.
`ConfigurationBuilder`	`version(ProtocolVersion protocolVersion)`	This property defines the protocol version that this client should use.
`ConfigurationBuilder`	`withProperties(Properties properties)`	Configures this builder using the specified properties.

- Constructor Detail
  - ConfigurationBuilder
```
public ConfigurationBuilder()
```
- Method Detail
  - 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
  - parseServers
```
public static final 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 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
```
@Deprecated
public ConfigurationBuilder balancingStrategy(FailoverRequestBalancingStrategy balancingStrategy)
```
    Deprecated.
    
    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
  - 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
  - classLoader
```
public ConfigurationBuilder classLoader(ClassLoader cl)
```
    Description copied from interface: ConfigurationChildBuilder
    
    Specifies the ClassLoader used to find certain resources used by configuration when specified by name (e.g. certificate stores). Infinispan will search through the classloader which loaded this class, the system classloader, the TCCL and the OSGi classloader (if applicable).
    
    Specified by:
    
    classLoader 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.
    
    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
  - 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
```
public ConfigurationBuilder keySizeEstimate(int keySizeEstimate)
```
    Description copied from interface: ConfigurationChildBuilder
    
    This hint allows sizing of byte buffers when serializing and deserializing keys, to minimize array resizing. It defaults to 64.
    
    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
  - nearCache
```
@Deprecated
public NearCacheConfigurationBuilder nearCache()
```
    Deprecated.
    since 11.0. To be removed in 14.0. Use RemoteCacheConfigurationBuilder.nearCacheMode(NearCacheMode) and RemoteCacheConfigurationBuilder.nearCacheMaxEntries(int) instead.
  - protocolVersion
```
@Deprecated
public ConfigurationBuilder protocolVersion(String protocolVersion)
```
    Deprecated.
    Use version(ProtocolVersion) instead.
    
    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:
    
    protocolVersion in interface ConfigurationChildBuilder
  - 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
  - security
```
public SecurityConfigurationBuilder security()
```
    Description copied from interface: ConfigurationChildBuilder
    
    Security Configuration
    
    Specified by:
    
    security 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 60000 (1 minute)
    
    Specified by:
    
    socketTimeout 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 keepAlive)
```
    Description copied from interface: ConfigurationChildBuilder
    
    Affects TCP KEEPALIVE on the TCP stack. Defaults to disable
    
    Specified by:
    
    tcpKeepAlive in interface ConfigurationChildBuilder
  - valueSizeEstimate
```
public ConfigurationBuilder valueSizeEstimate(int valueSizeEstimate)
```
    Description copied from interface: ConfigurationChildBuilder
    
    This hint allows sizing of byte buffers when serializing and deserializing values, to minimize array resizing. It defaults to 512
    
    Specified by:
    
    valueSizeEstimate in interface ConfigurationChildBuilder
  - maxRetries
```
public ConfigurationBuilder 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
  - addJavaSerialWhiteList
```
public ConfigurationBuilder addJavaSerialWhiteList(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:
    
    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
    
    Returns:
    
    the RemoteCacheConfigurationBuilder for the cache
  - 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
  - validate
```
public void validate()
```
    Description copied from interface: Builder
    
    Validate the data in this builder before building the configuration bean
    
    Specified by:
    
    validate in interface Builder<Configuration>
  - create
```
public Configuration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<Configuration>
    
    Returns:
  - build
```
public Configuration build()
```
    Description copied from interface: ConfigurationChildBuilder
    
    Builds a configuration object
    
    Specified by:
    
    build in interface ConfigurationChildBuilder
  - build
```
public Configuration build(boolean validate)
```
  - read
```
public ConfigurationBuilder read(Configuration template)
```
    Description copied from interface: Builder
    
    Reads the configuration from an already created configuration bean into this builder. Returns an appropriate builder to allow fluent configuration
    
    Specified by:
    
    read in interface Builder<Configuration>
    
    Parameters:
    
    template - the configuration from which to "clone" this config if needed.

Class ConfigurationBuilder

Constructor Summary

Method Summary

Constructor Detail

ConfigurationBuilder

Method Detail

addServer

addCluster

addServers

parseServers

asyncExecutorFactory

balancingStrategy

balancingStrategy

balancingStrategy

balancingStrategy

classLoader

clientIntelligence

connectionPool

connectionTimeout

consistentHashImpl

consistentHashImpl

forceReturnValues

keySizeEstimate

marshaller

marshaller

marshaller

addContextInitializer

addContextInitializer

addContextInitializers

nearCache

protocolVersion

version

security

socketTimeout

tcpNoDelay

tcpKeepAlive

valueSizeEstimate

maxRetries

addJavaSerialWhiteList

batchSize

statistics

transaction

remoteCache

withProperties

validate

create

build

build

read