com.datastax.dse.driver.api.core.metadata

Class DseNodeProperties

java.lang.Object

com.datastax.dse.driver.api.core.metadata.DseNodeProperties

public class DseNodeProperties
extends Object

The keys for the additional DSE-specific properties stored in Node.getExtras().

Field Summary

Fields

Modifier and Type	Field and Description
static String	DSE_VERSION The DSE version that the node is running.
static String	DSE_WORKLOADS The DSE workloads that the node is running.
static String	JMX_PORT The JMX port used by this node.
static String	NATIVE_TRANSPORT_PORT The port for the native transport connections on the DSE node.
static String	NATIVE_TRANSPORT_PORT_SSL The port for the encrypted native transport connections on the DSE node.
static String	SERVER_ID The value of the server_id field in the peers system table for this node.
static String	STORAGE_PORT The storage port used by the DSE node.
static String	STORAGE_PORT_SSL The encrypted storage port used by the DSE node.

Constructor Summary

Constructors

Constructor and Description
DseNodeProperties()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

DSE_VERSION

public static final String DSE_VERSION

The DSE version that the node is running.

The associated value in Node.getExtras() is a Version).

See Also:

Constant Field Values

SERVER_ID

public static final String SERVER_ID

The value of the server_id field in the peers system table for this node.

This is the single identifier of the machine running a DSE instance. If DSE has been configured with Multi-Instance, the server_id helps identifying the single physical machine that runs the multiple DSE instances. If DSE is not configured with DSE Multi-Instance, the server_id will be automatically set and be unique for each node.

This information is only available if connecting to a DSE 6.0+ node.

The associated value in Node.getExtras() is a String).

See Also:

DSE Multi-Instance (DSE Administrator Guide), server_id (DSE Administrator Guide), Constant Field Values

DSE_WORKLOADS

public static final String DSE_WORKLOADS

The DSE workloads that the node is running.

This is based on the workload or workloads columns in system.local and system.peers.

Workload labels may vary depending on the DSE version in use; e.g. DSE 5.1 may report two distinct workloads: Search and Analytics, while DSE 5.0 would report a single SearchAnalytics workload instead. It is up to users to deal with such discrepancies; the driver simply returns the workload labels as reported by DSE, without any form of pre-processing (with the exception of Graph in DSE 5.0, which is stored in a separate column, but will be reported as Graph here).

The associated value in Node.getExtras() is an immutable Set<String>.

See Also:

Constant Field Values

NATIVE_TRANSPORT_PORT

public static final String NATIVE_TRANSPORT_PORT

The port for the native transport connections on the DSE node.

The native transport port is 9042 by default but can be changed on instances requiring specific firewall configurations. This can be configured in the cassandra.yaml configuration file under the native_transport_port property.

This information is only available if connecting the driver to a DSE 6.0+ node.

The associated value in Node.getExtras() is an Integer.

See Also:

Constant Field Values

NATIVE_TRANSPORT_PORT_SSL

public static final String NATIVE_TRANSPORT_PORT_SSL

The port for the encrypted native transport connections on the DSE node.

In most scenarios enabling client communications in DSE will result in using a single port that will only accept encrypted connections (by default the port 9042 is reused since unencrypted connections are not allowed).

However, it is possible to configure DSE to use both encrypted and a non-encrypted communication ports with clients. In that case the port accepting encrypted connections will differ from the non-encrypted one (see NATIVE_TRANSPORT_PORT) and will be exposed via this method.

This information is only available if connecting the driver to a DSE 6.0+ node.

The associated value in Node.getExtras() is an Integer.

See Also:

Constant Field Values

STORAGE_PORT

public static final String STORAGE_PORT

The storage port used by the DSE node.

The storage port is used for internal communication between the DSE server nodes. This port is never used by the driver.

This information is only available if connecting the driver to a DSE 6.0+ node.

The associated value in Node.getExtras() is an Integer.

See Also:

Constant Field Values

STORAGE_PORT_SSL

public static final String STORAGE_PORT_SSL

The encrypted storage port used by the DSE node.

If inter-node encryption is enabled on the DSE cluster, nodes will communicate securely between each other via this port. This port is never used by the driver.

This information is only available if connecting the driver to a DSE 6.0+ node.

The associated value in Node.getExtras() is an Integer.

See Also:

Constant Field Values

JMX_PORT

public static final String JMX_PORT

The JMX port used by this node.

The JMX port can be configured in the cassandra-env.sh configuration file separately on each node.

This information is only available if connecting the driver to a DSE 6.0+ node.

The associated value in Node.getExtras() is an Integer.

See Also:

Constant Field Values

Constructor Detail

DseNodeProperties

public DseNodeProperties()