ClientConfig (VoltDB Client APIs)

java.lang.Object
- org.voltdb.client.ClientConfig

public class ClientConfig
extends java.lang.Object

Container for configuration settings for a Client

Field Summary

Fields
Modifier and Type Field and Description

static boolean ENABLE_SSL_FOR_TEST

Fields
Modifier and Type	Field and Description
`static boolean`	`ENABLE_SSL_FOR_TEST`

Constructor Summary

Constructors
Constructor and Description
`ClientConfig()` Configuration for a client with no authentication credentials that will work with a server with security disabled.
`ClientConfig(java.lang.String username, java.lang.String password)` Configuration for a client that specifies authentication credentials.
`ClientConfig(java.lang.String username, java.lang.String password, boolean cleartext, ClientStatusListenerExt listener)` Configuration for a client that specifies authentication credentials.
`ClientConfig(java.lang.String username, java.lang.String password, boolean cleartext, ClientStatusListenerExt listener, org.voltdb.client.ClientAuthScheme scheme)` Configuration for a client that specifies authentication credentials.
`ClientConfig(java.lang.String username, java.lang.String password, ClientStatusListener listener, org.voltdb.client.ClientAuthScheme scheme)` Deprecated. `ClientStatusListener` deprecated in favor of `ClientStatusListenerExt`
`ClientConfig(java.lang.String username, java.lang.String password, ClientStatusListenerExt listener)` Configuration for a client that specifies authentication credentials.
`ClientConfig(java.lang.String username, java.lang.String password, ClientStatusListenerExt listener, org.voltdb.client.ClientAuthScheme scheme)` Configuration for a client that specifies authentication credentials.
`ClientConfig(javax.security.auth.Subject subject, ClientStatusListenerExt listener)` Configuration for a client that specifies an already authenticated `Subject`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`enableAutoTune()` Deprecated.
`void`	`enableKerberosAuthentication(java.lang.String loginContextEntryKey)` Use the provided JAAS login context entry key to get the authentication credentials held by the caller
`void`	`enableKerberosAuthentication(javax.security.auth.Subject subject)` Enable Kerberos authentication with the provided subject credentials
`void`	`enableSSL()` Configure ssl from the provided properties file.
`void`	`setAutoTuneTargetInternalLatency(int targetLatency)` Deprecated.
`void`	`setClientAffinity(boolean on)` Deprecated. client affinity is always `true`: transactions are always routed to the correct master partition improving latency and throughput.
`void`	`setConnectionResponseTimeout(long ms)` Set the timeout for reading from a connection.
`void`	`setExpectedOutgoingMessageSize(int size)` Deprecated. Has no effect.
`void`	`setHeavyweight(boolean heavyweight)` By default a single network thread is created and used to do IO and invoke callbacks.
`void`	`setInitialConnectionRetryInterval(long ms)` Set the initial connection retry interval.
`void`	`setMaxArenaSizes(int[] maxArenaSizes)` Deprecated. Deprecated because memory pooling no longer uses arenas. Has no effect.
`void`	`setMaxConnectionRetryInterval(long ms)` Set the max connection retry interval.
`void`	`setMaxOutstandingTxns(int maxOutstanding)` Set the maximum number of outstanding requests that will be submitted before blocking.
`void`	`setMaxTransactionsPerSecond(int maxTxnsPerSecond)` Set the maximum number of transactions that can be run in 1 second.
`void`	`setProcedureCallTimeout(long ms)` Set the timeout for procedure call.
`void`	`setReconnectOnConnectionLoss(boolean on)` Attempts to reconnect to a node with retry after connection loss.
`static void`	`setRoundingConfig(boolean isEnabled, java.math.RoundingMode mode)` Enable or disable the rounding mode in the client.
`void`	`setSendReadsToReplicasByDefault(boolean on)` Deprecated. no longer meaningful: reads are always sent to the leader; sending to a replica would not have resulted in better performance.
`void`	`setTopologyChangeAware(boolean enabled)` Attempts to connect to all nodes in the cluster
`void`	`setTrustStore(java.lang.String pathToTrustStore, java.lang.String trustStorePassword)` Configure trust store
`void`	`setTrustStoreConfigFromDefault()`
`void`	`setTrustStoreConfigFromPropertyFile(java.lang.String propFN)` Configure trust store

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ENABLE_SSL_FOR_TEST
```
public static final boolean ENABLE_SSL_FOR_TEST
```
- Constructor Detail
  - ClientConfig
```
public ClientConfig()
```
    Configuration for a client with no authentication credentials that will work with a server with security disabled. Also specifies no status listener.
  - ClientConfig
```
public ClientConfig(java.lang.String username,
                    java.lang.String password)
```
    Configuration for a client that specifies authentication credentials. The username and password can be null or the empty string.
    
    Parameters:
    
    username - Cleartext username.
    
    password - Cleartext password.
  - ClientConfig
```
@Deprecated
public ClientConfig(java.lang.String username,
                                java.lang.String password,
                                ClientStatusListener listener,
                                org.voltdb.client.ClientAuthScheme scheme)
```
    Deprecated. ClientStatusListener deprecated in favor of ClientStatusListenerExt
    
    Configuration for a client that specifies authentication credentials. The username and password can be null or the empty string. Also specifies a status listener.
    
    Parameters:
    
    username - Cleartext username.
    
    password - Cleartext password.
    
    scheme - Client password hash scheme
    
    listener - ClientStatusListener implementation to receive callbacks.
  - ClientConfig
```
public ClientConfig(java.lang.String username,
                    java.lang.String password,
                    ClientStatusListenerExt listener)
```
    Configuration for a client that specifies authentication credentials. The username and password can be null or the empty string. Also specifies a status listener.
    
    Parameters:
    
    username - Cleartext username.
    
    password - Cleartext password.
    
    listener - ClientStatusListenerExt implementation to receive callbacks.
  - ClientConfig
```
public ClientConfig(java.lang.String username,
                    java.lang.String password,
                    ClientStatusListenerExt listener,
                    org.voltdb.client.ClientAuthScheme scheme)
```
    Configuration for a client that specifies authentication credentials. The username and password can be null or the empty string. Also specifies a status listener.
    
    Parameters:
    
    username - Cleartext username.
    
    password - Cleartext password.
    
    listener - ClientStatusListenerExt implementation to receive callbacks.
    
    scheme - Client password hash scheme
  - ClientConfig
```
public ClientConfig(java.lang.String username,
                    java.lang.String password,
                    boolean cleartext,
                    ClientStatusListenerExt listener)
```
    Configuration for a client that specifies authentication credentials. The username and password can be null or the empty string. Also specifies a status listener.
    
    Parameters:
    
    username - Cleartext username.
    
    password - A cleartext or hashed passowrd.
    
    listener - ClientStatusListenerExt implementation to receive callbacks.
    
    cleartext - Whether the password is hashed.
  - ClientConfig
```
public ClientConfig(javax.security.auth.Subject subject,
                    ClientStatusListenerExt listener)
```
    Configuration for a client that specifies an already authenticated Subject. Also specifies a status listener.
    
    Parameters:
    
    subject - an authenticated Subject
    
    listener - ClientStatusListenerExt implementation to receive callbacks.
  - ClientConfig
```
public ClientConfig(java.lang.String username,
                    java.lang.String password,
                    boolean cleartext,
                    ClientStatusListenerExt listener,
                    org.voltdb.client.ClientAuthScheme scheme)
```
    Configuration for a client that specifies authentication credentials. The username and password can be null or the empty string. Also specifies a status listener.
    
    Parameters:
    
    username - Cleartext username.
    
    password - A cleartext or hashed passowrd.
    
    listener - ClientStatusListenerExt implementation to receive callbacks.
    
    cleartext - Whether the password is hashed.
    
    scheme - Client password hash scheme
- Method Detail
  - setProcedureCallTimeout
```
public void setProcedureCallTimeout(long ms)
```
    Set the timeout for procedure call. If the timeout expires before the call returns, the procedure callback will be called with status ClientResponse.CONNECTION_TIMEOUT. Synchronous procedures will throw an exception. If a response comes back after the expiration has triggered, then a callback method ClientStatusListenerExt.lateProcedureResponse(ClientResponse, String, int) will be called.
    
    Default value is 2 minutes if not set. Value of 0 means forever.
    
    Note that while specified in MS, this timeout is only accurate to within a second or so.
    
    Parameters:
    
    ms - Timeout value in milliseconds.
  - setConnectionResponseTimeout
```
public void setConnectionResponseTimeout(long ms)
```
    Set the timeout for reading from a connection. If a connection receives no responses, either from procedure calls or &Pings, for the timeout time in milliseconds, then the connection will be assumed dead and the closed connection callback will be called.
    
    Default value is 2 minutes if not set. Value of 0 means forever.
    
    Note that while specified in MS, this timeout is only accurate to within a second or so.
    
    Parameters:
    
    ms - Timeout value in milliseconds.
  - setMaxArenaSizes
```
@Deprecated
public void setMaxArenaSizes(int[] maxArenaSizes)
```
    Deprecated. Deprecated because memory pooling no longer uses arenas. Has no effect.
    
    Set the maximum size of memory pool arenas before falling back to using heap byte buffers.
    
    Parameters:
    
    maxArenaSizes - Maximum size of each arena.
  - setHeavyweight
```
public void setHeavyweight(boolean heavyweight)
```
    By default a single network thread is created and used to do IO and invoke callbacks. When set to true, Runtime.getRuntime().availableProcessors() / 2 threads are created. Multiple server connections are required for more threads to be involved, a connection is assigned exclusively to a connection.
    
    Parameters:
    
    heavyweight - Whether to create additional threads for high IO or high processing workloads.
  - setExpectedOutgoingMessageSize
```
@Deprecated
public void setExpectedOutgoingMessageSize(int size)
```
    Deprecated. Has no effect.
    
    Provide a hint indicating how large messages will be once serialized. Ensures efficient message buffer allocation.
    
    Parameters:
    
    size - The expected size of the outgoing message.
  - setMaxOutstandingTxns
```
public void setMaxOutstandingTxns(int maxOutstanding)
```
    Set the maximum number of outstanding requests that will be submitted before blocking. Similar to the number of concurrent connections in a traditional synchronous API. Defaults to 2k.
    
    Parameters:
    
    maxOutstanding - The maximum outstanding transactions before calls to Client.callProcedure(ProcedureCallback, String, Object...) will block or return false (depending on settings).
  - setMaxTransactionsPerSecond
```
public void setMaxTransactionsPerSecond(int maxTxnsPerSecond)
```
    Set the maximum number of transactions that can be run in 1 second. Note this specifies a rate, not a ceiling. If the limit is set to 10, you can't send 10 in the first half of the second and 5 in the later half; the client will let you send about 1 transaction every 100ms. Default is {link Integer#MAX_VALUE}.
    
    Parameters:
    
    maxTxnsPerSecond - Requested ceiling on rate of call in transaction per second.
  - enableAutoTune
```
@Deprecated
public void enableAutoTune()
```
    Deprecated.
    
    Enable the Auto Tuning feature, which dynamically adjusts the maximum allowable transaction number with the goal of maintaining a target latency. The latency value used is the internal latency as reported by the servers. The internal latency is a good measure of system saturation.
    
    See setAutoTuneTargetInternalLatency(int).
    
    @deprecated in V10.2.5; functionality to be removed in V11.
  - setClientAffinity
```
@Deprecated
public void setClientAffinity(boolean on)
```
    Deprecated. client affinity is always true: transactions are always routed to the correct master partition improving latency and throughput.
    
    Parameters:
    
    on - unused
  - setTopologyChangeAware
```
public void setTopologyChangeAware(boolean enabled)
```
    Attempts to connect to all nodes in the cluster
    
    Defaults to false.
    
    Parameters:
    
    enabled - Enable or disable the topology awareness feature.
  - setSendReadsToReplicasByDefault
```
@Deprecated
public void setSendReadsToReplicasByDefault(boolean on)
```
    Deprecated. no longer meaningful: reads are always sent to the leader; sending to a replica would not have resulted in better performance.
    
    Parameters:
    
    on - unused
  - setReconnectOnConnectionLoss
```
public void setReconnectOnConnectionLoss(boolean on)
```
    Attempts to reconnect to a node with retry after connection loss. See the ReconnectStatusListener.
    
    Parameters:
    
    on - Enable or disable the reconnection feature. Default is off.
  - setInitialConnectionRetryInterval
```
public void setInitialConnectionRetryInterval(long ms)
```
    Set the initial connection retry interval. Only takes effect if m_reconnectOnConnectionLoss is turned on.
    
    Parameters:
    
    ms - initial connection retry interval in milliseconds.
  - setMaxConnectionRetryInterval
```
public void setMaxConnectionRetryInterval(long ms)
```
    Set the max connection retry interval. Only takes effect if m_reconnectOnConnectionLoss is turned on.
    
    Parameters:
    
    ms - max connection retry interval in milliseconds.
  - setAutoTuneTargetInternalLatency
```
@Deprecated
public void setAutoTuneTargetInternalLatency(int targetLatency)
```
    Deprecated.
    
    Set the target latency for the Auto Tune feature. Note this represents internal latency as reported by the server(s), not round-trip latency measured by the client. Default value is 5 if this is not called.
    
    @deprecated in V10.2.5; functionality to be removed in V11.
    
    Parameters:
    
    targetLatency - New target latency in milliseconds.
  - enableKerberosAuthentication
```
public void enableKerberosAuthentication(javax.security.auth.Subject subject)
```
    Enable Kerberos authentication with the provided subject credentials
    
    Parameters:
    
    subject - Identity of the authenticated user.
  - enableKerberosAuthentication
```
public void enableKerberosAuthentication(java.lang.String loginContextEntryKey)
```
    Use the provided JAAS login context entry key to get the authentication credentials held by the caller
    
    Parameters:
    
    loginContextEntryKey - JAAS login context config entry designation
  - setRoundingConfig
```
public static void setRoundingConfig(boolean isEnabled,
                                     java.math.RoundingMode mode)
```
    Enable or disable the rounding mode in the client. This must match the rounding mode set in the server, which is set using system properties.
    
    Parameters:
    
    isEnabled - True iff rounding is enabled.
    
    mode - The rounding mode, with values taken from java.math.RoundingMode.
  - setTrustStore
```
public void setTrustStore(java.lang.String pathToTrustStore,
                          java.lang.String trustStorePassword)
```
    Configure trust store
    
    Parameters:
    
    pathToTrustStore - file specification for the trust store
    
    trustStorePassword - trust store key file password
  - setTrustStoreConfigFromPropertyFile
```
public void setTrustStoreConfigFromPropertyFile(java.lang.String propFN)
```
    Configure trust store
    Parameters:
    propFN - property file name containing trust store properties:
    
    trustStore trust store file specification
    trustStorePassword trust store password
  - enableSSL
```
public void enableSSL()
```
    Configure ssl from the provided properties file. if file is not provided we configure without keystore and truststore manager.
  - setTrustStoreConfigFromDefault
```
public void setTrustStoreConfigFromDefault()
```

Class ClientConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENABLE_SSL_FOR_TEST

Constructor Detail

ClientConfig

ClientConfig

ClientConfig

ClientConfig

ClientConfig

ClientConfig

ClientConfig

ClientConfig

Method Detail

setProcedureCallTimeout

setConnectionResponseTimeout

setMaxArenaSizes

setHeavyweight

setExpectedOutgoingMessageSize

setMaxOutstandingTxns

setMaxTransactionsPerSecond

enableAutoTune

setClientAffinity

setTopologyChangeAware

setSendReadsToReplicasByDefault

setReconnectOnConnectionLoss

setInitialConnectionRetryInterval

setMaxConnectionRetryInterval

setAutoTuneTargetInternalLatency

enableKerberosAuthentication

enableKerberosAuthentication

setRoundingConfig

setTrustStore

setTrustStoreConfigFromPropertyFile

enableSSL

setTrustStoreConfigFromDefault