package org.infinispan.client.hotrod.configuration;
import java.util.Properties;
import org.infinispan.client.hotrod.ProtocolVersion;
import org.infinispan.client.hotrod.impl.consistenthash.ConsistentHash;
import org.infinispan.client.hotrod.impl.consistenthash.ConsistentHashV2;
import org.infinispan.client.hotrod.impl.transport.TransportFactory;
import org.infinispan.client.hotrod.impl.transport.tcp.FailoverRequestBalancingStrategy;
import org.infinispan.commons.marshall.Marshaller;
import javax.net.ssl.SSLContext;
/**
* ConfigurationChildBuilder.
*
* @author Tristan Tarrant
* @since 5.3
*/
public interface ConfigurationChildBuilder {
/**
* Adds a new remote server
*/
ServerConfigurationBuilder addServer();
/**
* Adds a new remote server cluster
*/
ClusterConfigurationBuilder addCluster(String clusterName);
/**
* Adds a list of remote servers in the form: host1[:port][;host2[:port]]...
*/
ConfigurationBuilder addServers(String servers);
/**
* Configuration for the executor service used for asynchronous work on the Transport, including
* asynchronous marshalling and Cache 'async operations' such as Cache.putAsync().
*/
ExecutorFactoryConfigurationBuilder asyncExecutorFactory();
/**
* 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(FailoverRequestBalancingStrategy balancingStrategy);
/**
* For replicated (vs distributed) Hot Rod server clusters, the client balances requests to the
* servers according to this strategy.
*/
ConfigurationBuilder balancingStrategy(Class<? extends FailoverRequestBalancingStrategy> balancingStrategy);
/**
* Specifies the {@link 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).
* @deprecated since 9.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. {@link SslConfigurationBuilder#sslContext(SSLContext)})
*/
@Deprecated
ConfigurationBuilder classLoader(ClassLoader classLoader);
/**
* Specifies the level of "intelligence" the client should have
*/
ConfigurationBuilder clientIntelligence(ClientIntelligence clientIntelligence);
/**
* Configures the connection pool
*/
ConnectionPoolConfigurationBuilder connectionPool();
/**
* This property defines the maximum socket connect timeout before giving up connecting to the
* server.
*/
ConfigurationBuilder connectionTimeout(int connectionTimeout);
/**
* Defines the {@link ConsistentHash} implementation to use for the specified version. By default,
* {@link ConsistentHashV2} is used for version 1 and {@link ConsistentHashV2} is used for version 2.
*/
ConfigurationBuilder consistentHashImpl(int version, Class<? extends ConsistentHash> consistentHashClass);
/**
* Defines the {@link ConsistentHash} implementation to use for the specified version. By default,
* {@link ConsistentHashV2} is used for version 1 and {@link ConsistentHashV2} is used for version 2.
*/
ConfigurationBuilder consistentHashImpl(int version, String consistentHashClass);
/**
* Whether or not to implicitly FORCE_RETURN_VALUE for all calls.
*/
ConfigurationBuilder forceReturnValues(boolean forceReturnValues);
/**
* This hint allows sizing of byte buffers when serializing and deserializing keys, to minimize array resizing. It defaults to 64.
*/
ConfigurationBuilder keySizeEstimate(int keySizeEstimate);
/**
* Allows you to specify a custom {@link Marshaller} implementation to
* serialize and deserialize user objects. This method is mutually exclusive with {@link #marshaller(Marshaller)}.
*/
ConfigurationBuilder marshaller(String marshaller);
/**
* Allows you to specify a custom {@link Marshaller} implementation to
* serialize and deserialize user objects. This method is mutually exclusive with {@link #marshaller(Marshaller)}.
*/
ConfigurationBuilder marshaller(Class<? extends Marshaller> marshaller);
/**
* Allows you to specify an instance of {@link Marshaller} to serialize
* and deserialize user objects. This method is mutually exclusive with {@link #marshaller(Class)}.
*/
ConfigurationBuilder marshaller(Marshaller marshaller);
/**
* This property defines the protocol version that this client should use. Defaults to the latest protocol version
* supported by this client.
*
* @deprecated Use {@link ConfigurationChildBuilder#version(ProtocolVersion)} instead.
*/
@Deprecated
ConfigurationBuilder protocolVersion(String protocolVersion);
/**
* This property defines the protocol version that this client should use. Defaults to the latest protocol version
* supported by this client.
*/
ConfigurationBuilder version(ProtocolVersion protocolVersion);
/**
* This property defines the maximum socket read timeout in milliseconds before giving up waiting
* for bytes from the server. Defaults to 60000 (1 minute)
*/
ConfigurationBuilder socketTimeout(int socketTimeout);
/**
* Security Configuration
*/
SecurityConfigurationBuilder security();
/**
* Affects TCP NODELAY on the TCP stack. Defaults to enabled
*/
ConfigurationBuilder tcpNoDelay(boolean tcpNoDelay);
/**
* Affects TCP KEEPALIVE on the TCP stack. Defaults to disable
*/
ConfigurationBuilder tcpKeepAlive(boolean keepAlive);
/**
* Controls which transport to use. Currently only the TcpTransport is supported.
*/
ConfigurationBuilder transportFactory(String transportFactory);
/**
* Controls which transport to use. Currently only the TcpTransport is supported.
*/
ConfigurationBuilder transportFactory(Class<? extends TransportFactory> transportFactory);
/**
* This hint allows sizing of byte buffers when serializing and deserializing values, to minimize
* array resizing. It defaults to 512
*/
ConfigurationBuilder valueSizeEstimate(int valueSizeEstimate);
/**
* 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.
*/
ConfigurationBuilder maxRetries(int maxRetries);
/**
* Configures this builder using the specified properties
*/
ConfigurationBuilder withProperties(Properties properties);
/**
* Builds a configuration object
*/
Configuration build();
}