ClientPolicy (aerospike-client 4.2.1 API)

java.lang.Object
- com.aerospike.client.policy.ClientPolicy

Direct Known Subclasses:

AsyncClientPolicy
```
public class ClientPolicy
extends Object
```
Container object for client policy Command.

Field Summary

Fields
Modifier and Type	Field and Description
`AuthMode`	`authMode` Authentication mode used when user/password is defined.
`BatchPolicy`	`batchPolicyDefault` Default batch policy that is used when batch command's policy is null.
`String`	`clusterName` Expected cluster name.
`int`	`connPoolsPerNode` Number of synchronous connection pools used for each node.
`EventLoops`	`eventLoops` Optional event loops to use in asynchronous commands.
`boolean`	`failIfNotConnected` Throw exception if all seed connections fail on cluster instantiation.
`boolean`	`forceSingleNode` For testing purposes only.
`InfoPolicy`	`infoPolicyDefault` Default info policy that is used when info command's policy is null.
`Map<String,String>`	`ipMap` A IP translation table is used in cases where different clients use different server IP addresses.
`int`	`loginTimeout` Login timeout in milliseconds.
`int`	`maxConnsPerNode` Maximum number of connections allowed per server node.
`int`	`maxSocketIdle` Maximum socket idle in seconds.
`String`	`password` Password authentication to cluster.
`QueryPolicy`	`queryPolicyDefault` Default query policy that is used when query command's policy is null.
`Policy`	`readPolicyDefault` Default read policy that is used when read command's policy is null.
`boolean`	`requestProleReplicas` Should prole replicas be requested from each server node in the cluster tend thread.
`ScanPolicy`	`scanPolicyDefault` Default scan policy that is used when scan command's policy is null.
`boolean`	`sharedThreadPool` Is threadPool shared between other client instances or classes.
`int`	`tendInterval` Interval in milliseconds between cluster tends by maintenance thread.
`ExecutorService`	`threadPool` Underlying thread pool used in synchronous batch, scan, and query commands.
`int`	`timeout` Initial host connection timeout in milliseconds.
`TlsPolicy`	`tlsPolicy` TLS secure connection policy for TLS enabled servers.
`String`	`user` User authentication to cluster.
`boolean`	`useServicesAlternate` Should use "services-alternate" instead of "services" in info request during cluster tending.
`WritePolicy`	`writePolicyDefault` Default write policy that is used when write command's policy is null.

Constructor Summary

Constructors
Constructor and Description

ClientPolicy()
Default constructor.

ClientPolicy(ClientPolicy other)
Copy client policy from another client policy.

Constructors
Constructor and Description
`ClientPolicy()` Default constructor.
`ClientPolicy(ClientPolicy other)` Copy client policy from another client policy.

Method Summary
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - eventLoops
```
public EventLoops eventLoops
```
    Optional event loops to use in asynchronous commands.
  - user
```
public String user
```
    User authentication to cluster. Leave null for clusters running without restricted access.
  - password
```
public String password
```
    Password authentication to cluster. The password will be stored by the client and sent to server in hashed format. Leave null for clusters running without restricted access.
  - clusterName
```
public String clusterName
```
    Expected cluster name. If not null, server nodes must return this cluster name in order to join the client's view of the cluster. Should only be set when connecting to servers that support the "cluster-name" info command.
  - authMode
```
public AuthMode authMode
```
    Authentication mode used when user/password is defined.
    Default: INTERNAL
  - timeout
```
public int timeout
```
    Initial host connection timeout in milliseconds. The timeout when opening a connection to the server host for the first time.
    Default: 1000ms
  - loginTimeout
```
public int loginTimeout
```
    Login timeout in milliseconds. The timeout is used when user authentication is enabled and a node login is being performed.
    Default: 5000ms
  - maxConnsPerNode
```
public int maxConnsPerNode
```
    Maximum number of connections allowed per server node. Transactions will go through retry logic and potentially fail with "ResultCode.NO_MORE_CONNECTIONS" if the maximum number of connections would be exceeded.
    The number of connections used per node depends on concurrent commands in progress plus sub-commands used for parallel multi-node commands (batch, scan, and query). One connection will be used for each command.
    Default: 300
  - connPoolsPerNode
```
public int connPoolsPerNode
```
    Number of synchronous connection pools used for each node. Machines with 8 cpu cores or less usually need just one connection pool per node. Machines with a large number of cpu cores may have their synchronous performance limited by contention for pooled connections. Contention for pooled connections can be reduced by creating multiple mini connection pools per node.
    Default: 1
  - maxSocketIdle
```
public int maxSocketIdle
```
    Maximum socket idle in seconds. Socket connection pools will discard sockets that have been idle longer than the maximum. The value is limited to 24 hours (86400).
    It's important to set this value to a few seconds less than the server's proto-fd-idle-ms (default 60000 milliseconds or 1 minute), so the client does not attempt to use a socket that has already been reaped by the server.
    This field is ignored by asynchronous transactions since these transactions use a non-blocking read to determine if the socket is active and empty.
    Default: 55 seconds
  - tendInterval
```
public int tendInterval
```
    Interval in milliseconds between cluster tends by maintenance thread. Default: 1 second
  - failIfNotConnected
```
public boolean failIfNotConnected
```
    Throw exception if all seed connections fail on cluster instantiation. Default: true
  - readPolicyDefault
```
public Policy readPolicyDefault
```
    Default read policy that is used when read command's policy is null.
  - writePolicyDefault
```
public WritePolicy writePolicyDefault
```
    Default write policy that is used when write command's policy is null.
  - scanPolicyDefault
```
public ScanPolicy scanPolicyDefault
```
    Default scan policy that is used when scan command's policy is null.
  - queryPolicyDefault
```
public QueryPolicy queryPolicyDefault
```
    Default query policy that is used when query command's policy is null.
  - batchPolicyDefault
```
public BatchPolicy batchPolicyDefault
```
    Default batch policy that is used when batch command's policy is null.
  - infoPolicyDefault
```
public InfoPolicy infoPolicyDefault
```
    Default info policy that is used when info command's policy is null.
  - tlsPolicy
```
public TlsPolicy tlsPolicy
```
    TLS secure connection policy for TLS enabled servers. TLS connections are only supported for AerospikeClient synchronous commands. Default: null (Use normal sockets)
  - ipMap
```
public Map<String,String> ipMap
```
    A IP translation table is used in cases where different clients use different server IP addresses. This may be necessary when using clients from both inside and outside a local area network. Default is no translation.
    The key is the IP address returned from friend info requests to other servers. The value is the real IP address used to connect to the server.
  - threadPool
```
public ExecutorService threadPool
```
    Underlying thread pool used in synchronous batch, scan, and query commands. These commands are often sent to multiple server nodes in parallel threads. A thread pool improves performance because threads do not have to be created/destroyed for each command. The default, null, indicates that the following daemon thread pool will be used:
```
 threadPool = Executors.newCachedThreadPool(new ThreadFactory() {
     public final Thread newThread(Runnable runnable) {
                        Thread thread = new Thread(runnable);
                        thread.setDaemon(true);
                        return thread;
                }
        });
 
```
    Daemon threads automatically terminate when the program terminates.
  - sharedThreadPool
```
public boolean sharedThreadPool
```
    Is threadPool shared between other client instances or classes. If threadPool is not shared (default), threadPool will be shutdown when the client instance is closed.
    If threadPool is shared, threadPool will not be shutdown when the client instance is closed. This shared threadPool should be shutdown manually before the program terminates. Shutdown is recommended, but not absolutely required if threadPool is constructed to use daemon threads.
  - requestProleReplicas
```
public boolean requestProleReplicas
```
    Should prole replicas be requested from each server node in the cluster tend thread. This option is required if there is a need to distribute reads across proles (Policy.replica == Replica.MASTER_PROLES or Replica.SEQUENCE).
    If requestProleReplicas is enabled, all prole partition maps will be cached on the client which results in extra storage multiplied by the replication factor.
    Default: true (request all master and prole replicas).
  - useServicesAlternate
```
public boolean useServicesAlternate
```
    Should use "services-alternate" instead of "services" in info request during cluster tending. "services-alternate" returns server configured external IP addresses that client uses to talk to nodes. "services-alternate" can be used in place of providing a client "ipMap". Default: false (use original "services" info request).
    "services-alternate" is available with Aerospike Server versions >= 3.7.1.
  - forceSingleNode
```
public boolean forceSingleNode
```
    For testing purposes only. Do not modify.
    Should the AerospikeClient instance communicate with the first seed node only instead of using the data partition map to determine which node to send the database command.
    Default: false
- Constructor Detail
  - ClientPolicy
```
public ClientPolicy(ClientPolicy other)
```
    Copy client policy from another client policy.
  - ClientPolicy
```
public ClientPolicy()
```
    Default constructor.

Class ClientPolicy

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

eventLoops

user

password

clusterName

authMode

timeout

loginTimeout

maxConnsPerNode

connPoolsPerNode

maxSocketIdle

tendInterval

failIfNotConnected

readPolicyDefault

writePolicyDefault

scanPolicyDefault

queryPolicyDefault

batchPolicyDefault

infoPolicyDefault

tlsPolicy

ipMap

threadPool

sharedThreadPool

requestProleReplicas

useServicesAlternate

forceSingleNode

Constructor Detail

ClientPolicy

ClientPolicy