com.datastax.driver.core

Class Configuration

java.lang.Object

com.datastax.driver.core.Configuration

public class Configuration
extends Object

The configuration of the cluster. It configures the following:

• Cassandra protocol level configuration (compression).
• Connection pooling configurations.
• low-level TCP configuration options (tcpNoDelay, keepAlive, ...).
• Metrics related options.
• Query related options (default consistency level, fetchSize, ...).
• Netty layer customization options.

This is also where you get the configured policies, though those cannot be changed (they are set during the built of the Cluster object).

Constructor Summary

Constructors

Constructor and Description
Configuration()
Configuration(Policies policies, ProtocolOptions protocolOptions, PoolingOptions poolingOptions, SocketOptions socketOptions, MetricsOptions metricsOptions, QueryOptions queryOptions) Deprecated. this constructor is provided for backward compatibility.
Configuration(Policies policies, ProtocolOptions protocolOptions, PoolingOptions poolingOptions, SocketOptions socketOptions, MetricsOptions metricsOptions, QueryOptions queryOptions, NettyOptions nettyOptions) Creates a configuration with the specified parameters.

Method Summary

Modifier and Type	Method and Description
MetricsOptions	getMetricsOptions() Returns the metrics configuration, if metrics are enabled.
NettyOptions	getNettyOptions() Returns the NettyOptions instance for this configuration.
Policies	getPolicies() Returns the policies set for the cluster.
PoolingOptions	getPoolingOptions() Returns the connection pooling configuration.
ProtocolOptions	getProtocolOptions() Returns the Cassandra binary protocol level configuration (compression).
QueryOptions	getQueryOptions() Returns the queries configuration.
SocketOptions	getSocketOptions() Returns the low-level TCP configuration options used (tcpNoDelay, keepAlive, ...).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Configuration

public Configuration()

Configuration

public Configuration(Policies policies,
                     ProtocolOptions protocolOptions,
                     PoolingOptions poolingOptions,
                     SocketOptions socketOptions,
                     MetricsOptions metricsOptions,
                     QueryOptions queryOptions,
                     NettyOptions nettyOptions)

Creates a configuration with the specified parameters.

Parameters:

policies - the policies to use

protocolOptions - the protocol options to use

poolingOptions - the pooling options to use

socketOptions - the socket options to use

metricsOptions - the metrics options, or null to disable metrics.

queryOptions - defaults related to queries.

nettyOptions - the NettyOptions instance to use

Configuration

@Deprecated
public Configuration(Policies policies,
                                 ProtocolOptions protocolOptions,
                                 PoolingOptions poolingOptions,
                                 SocketOptions socketOptions,
                                 MetricsOptions metricsOptions,
                                 QueryOptions queryOptions)

Deprecated. this constructor is provided for backward compatibility.

Method Detail

getPolicies

public Policies getPolicies()

Returns the policies set for the cluster.

Returns:

the policies set for the cluster.

getSocketOptions

public SocketOptions getSocketOptions()

Returns the low-level TCP configuration options used (tcpNoDelay, keepAlive, ...).

Returns:

the socket options.

getProtocolOptions

public ProtocolOptions getProtocolOptions()

Returns the Cassandra binary protocol level configuration (compression).

Returns:

the protocol options.

getPoolingOptions

public PoolingOptions getPoolingOptions()

Returns the connection pooling configuration.

Returns:

the pooling options.

getMetricsOptions

public MetricsOptions getMetricsOptions()

Returns the metrics configuration, if metrics are enabled.

Metrics collection is enabled by default but can be disabled at cluster construction time through Cluster.Builder.withoutMetrics().

Returns:

the metrics options or null if metrics are not enabled.

getQueryOptions

public QueryOptions getQueryOptions()

Returns the queries configuration.

Returns:

the queries options.

getNettyOptions

public NettyOptions getNettyOptions()

Returns the NettyOptions instance for this configuration.

Returns:

the NettyOptions instance for this configuration.