ConfigurationChildBuilder (Red Hat JBoss Enterprise Application Platform 7.4.0.GA public API)

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

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`ClusterConfigurationBuilder`	`addCluster(String clusterName)` Adds a new remote server cluster
`ConfigurationBuilder`	`addContextInitializer(org.infinispan.protostream.SerializationContextInitializer contextInitializer)` Supply a `SerializationContextInitializer` implementation to register classes with the `ProtoStreamMarshaller`'s `SerializationContext`.
`ConfigurationBuilder`	`addContextInitializer(String 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(FailoverRequestBalancingStrategy balancingStrategy)` Deprecated. since 9.3. To be removed in 12.0. Use `balancingStrategy(Supplier)` instead.
`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`	`classLoader(ClassLoader classLoader)` Deprecated. since 9.0. To be removed in 12.0. If you need to load configuration resources from other locations, you will need to do so yourself and use the appropriate configuration methods (e.g. `SslConfigurationBuilder.sslContext(javax.net.ssl.SSLContext)`)
`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 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`	`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(Marshaller marshaller)` Allows you to specify an instance of `Marshaller` 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`	`maxRetries(int maxRetries)` It sets the maximum number of retries for each request.
`ConfigurationBuilder`	`protocolVersion(String protocolVersion)` Deprecated. since 9.0. To be removed in 12.0. Use `version(ProtocolVersion)` instead.
`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
`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)` 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.

- Method Detail
  - 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
```
@Deprecated
ConfigurationBuilder balancingStrategy(FailoverRequestBalancingStrategy balancingStrategy)
```
    Deprecated. since 9.3. To be removed in 12.0. Use balancingStrategy(Supplier) instead.
    
    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.
  - classLoader
```
@Deprecated
ConfigurationBuilder classLoader(ClassLoader classLoader)
```
    Deprecated. since 9.0. To be removed in 12.0. If you need to load configuration resources from other locations, you will need to do so yourself and use the appropriate configuration methods (e.g. SslConfigurationBuilder.sslContext(javax.net.ssl.SSLContext))
    
    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).
  - 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.
  - consistentHashImpl
```
ConfigurationBuilder 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
```
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.
  - forceReturnValues
```
ConfigurationBuilder forceReturnValues(boolean forceReturnValues)
```
    Whether or not to implicitly FORCE_RETURN_VALUE for all calls.
  - keySizeEstimate
```
ConfigurationBuilder keySizeEstimate(int keySizeEstimate)
```
    This hint allows sizing of byte buffers when serializing and deserializing keys, to minimize array resizing. It defaults to 64.
  - 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.
    
    See Also:
    
    addContextInitializer(SerializationContextInitializer).
  - protocolVersion
```
@Deprecated
ConfigurationBuilder protocolVersion(String protocolVersion)
```
    Deprecated. since 9.0. To be removed in 12.0. Use version(ProtocolVersion) instead.
    
    This property defines the protocol version that this client should use. Defaults to the latest protocol version supported by this client.
  - 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 60000 (1 minute)
  - 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
```
ConfigurationBuilder valueSizeEstimate(int valueSizeEstimate)
```
    This hint allows sizing of byte buffers when serializing and deserializing values, to minimize array resizing. It defaults to 512
  - 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.
  - addJavaSerialWhiteList
```
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. REST.
  - 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
  - withProperties
```
ConfigurationBuilder withProperties(Properties properties)
```
    Configures this builder using the specified properties. See ConfigurationBuilder for a list.
  - build
```
Configuration build()
```
    Builds a configuration object

Interface ConfigurationChildBuilder

Method Summary

Method Detail

addServer

addCluster

addServers

asyncExecutorFactory

balancingStrategy

balancingStrategy

balancingStrategy

balancingStrategy

classLoader

clientIntelligence

connectionPool

connectionTimeout

consistentHashImpl

consistentHashImpl

forceReturnValues

keySizeEstimate

marshaller

marshaller

marshaller

addContextInitializer

addContextInitializer

addContextInitializers

protocolVersion

version

socketTimeout

security

tcpNoDelay

tcpKeepAlive

uri

uri

valueSizeEstimate

maxRetries

addJavaSerialWhiteList

batchSize

statistics

transaction

remoteCache

withProperties

build