Package org.infinispan.client.hotrod.configuration

Interface ConfigurationChildBuilder

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 Details Link icon

    • addServer Link icon

      ServerConfigurationBuilder addServer()
      Adds a new remote server

    • addCluster Link icon

      ClusterConfigurationBuilder addCluster(String clusterName)
      Adds a new remote server cluster

    • addServers Link icon

      ConfigurationBuilder addServers(String servers)
      Adds a list of remote servers in the form: host1[:port][;host2[:port]]...

    • asyncExecutorFactory Link icon

      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 Link icon

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

    • balancingStrategy Link icon

      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 Link icon

      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.

    • clientIntelligence Link icon

      ConfigurationBuilder clientIntelligence(ClientIntelligence clientIntelligence)
      Specifies the level of "intelligence" the client should have

    • connectionPool Link icon

      ConnectionPoolConfigurationBuilder connectionPool()
      Configures the connection pool

    • connectionTimeout Link icon

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

    • consistentHashImpl Link icon

      ConfigurationBuilder consistentHashImpl(int version, Class<? extends org.infinispan.client.hotrod.impl.consistenthash.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 Link icon

      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.

    • dnsResolverMinTTL Link icon

      ConfigurationBuilder dnsResolverMinTTL(int minTTL)

    • dnsResolverMaxTTL Link icon

      ConfigurationBuilder dnsResolverMaxTTL(int maxTTL)

    • dnsResolverNegativeTTL Link icon

      ConfigurationBuilder dnsResolverNegativeTTL(int negativeTTL)

    • forceReturnValues Link icon

      ConfigurationBuilder forceReturnValues(boolean forceReturnValues)
      Whether or not to implicitly FORCE_RETURN_VALUE for all calls.

    • keySizeEstimate Link icon

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

    • marshaller Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      ConfigurationBuilder addContextInitializer(String contextInitializer)
      Supply a SerializationContextInitializer implementation to register classes with the ProtoStreamMarshaller's SerializationContext.

    • addContextInitializer Link icon

      ConfigurationBuilder addContextInitializer(org.infinispan.protostream.SerializationContextInitializer contextInitializer)
      Supply a SerializationContextInitializer implementation to register classes with the ProtoStreamMarshaller's SerializationContext.

    • addContextInitializers Link icon

      ConfigurationBuilder addContextInitializers(org.infinispan.protostream.SerializationContextInitializer... contextInitializers)
      Convenience method to supply multiple SerializationContextInitializer implementations.

    • version Link icon

      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 Link icon

      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 ConfigurationProperties.DEFAULT_SO_TIMEOUT

    • security Link icon

      SecurityConfigurationBuilder security()
      Security Configuration

    • tcpNoDelay Link icon

      ConfigurationBuilder tcpNoDelay(boolean tcpNoDelay)
      Affects TCP NODELAY on the TCP stack. Defaults to enabled

    • tcpKeepAlive Link icon

      ConfigurationBuilder tcpKeepAlive(boolean keepAlive)
      Affects TCP KEEPALIVE on the TCP stack. Defaults to disable

    • uri Link icon

      ConfigurationBuilder uri(URI uri)
      Configures this builder using the specified URI.

    • uri Link icon

      ConfigurationBuilder uri(String uri)
      Configures this builder using the specified URI.

    • valueSizeEstimate Link icon

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

    • maxRetries Link icon

      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.

    • serverFailureTimeout Link icon

      ConfigurationBuilder serverFailureTimeout(int timeoutInMilliseconds)
      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)

      Parameters:
      timeoutInMilliseconds - the timeout to attempt to clear a failed server in milliseconds
      Returns:
      this builder

    • addJavaSerialAllowList Link icon

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

    • addJavaSerialWhiteList Link icon

      @Deprecated(forRemoval=true, since="12.0") ConfigurationBuilder addJavaSerialWhiteList(String... regEx)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use addJavaSerialAllowList(String...) instead. To be removed in 14.0.

    • batchSize Link icon

      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 Link icon

      StatisticsConfigurationBuilder statistics()
      Configures client-side statistics.

    • transaction Link icon

      TransactionConfigurationBuilder transaction()
      Transaction configuration

    • remoteCache Link icon

      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 Link icon

      ConfigurationBuilder 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 Link icon

      ConfigurationBuilder transportFactory(TransportFactory transportFactory)
      Set the TransportFactory. It defaults to DefaultTransportFactory
      Parameters:
      transportFactory - an instance of TransportFactory

    • withProperties Link icon

      ConfigurationBuilder withProperties(Properties properties)
      Configures this builder using the specified properties. See ConfigurationBuilder for a list.

    • build Link icon

      Configuration build()
      Builds a configuration object