org.apache.cassandra.config

Enum CassandraRelevantProperties

java.lang.Object

java.lang.Enum<CassandraRelevantProperties>

org.apache.cassandra.config.CassandraRelevantProperties

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CassandraRelevantProperties>

public enum CassandraRelevantProperties
extends java.lang.Enum<CassandraRelevantProperties>

A class that extracts system properties for the cassandra node it runs within.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOOTSTRAP_SCHEMA_DELAY_MS When bootstraping how long to wait for schema versions to be seen.
BOOTSTRAP_SKIP_SCHEMA_CHECK When bootstraping we wait for all schema versions found in gossip to be seen, and if not seen in time we fail the bootstrap; this property will avoid failing and allow bootstrap to continue if set to true.
CASSANDRA_FOREGROUND The cassandra-foreground option will tell CassandraDaemon whether to close stdout/stderr, but it's up to us not to background.
CASSANDRA_JMX_REMOTE_PORT Cassandra jmx remote port
CASSANDRA_PID_FILE
COM_SUN_MANAGEMENT_JMXREMOTE_ACCESS_FILE This property indicates the location for the access file.
COM_SUN_MANAGEMENT_JMXREMOTE_AUTHENTICATE This property indicates whether password authentication for remote monitoring is enabled.
COM_SUN_MANAGEMENT_JMXREMOTE_PASSWORD_FILE This property indicates the path to the password file - com.sun.management.jmxremote.password.file
COM_SUN_MANAGEMENT_JMXREMOTE_PORT Port number to enable JMX RMI connections - com.sun.management.jmxremote.port
COM_SUN_MANAGEMENT_JMXREMOTE_RMI_PORT The port number to which the RMI connector will be bound - com.sun.management.jmxremote.rmi.port.
COM_SUN_MANAGEMENT_JMXREMOTE_SSL This property indicates whether SSL is enabled for monitoring remotely.
COM_SUN_MANAGEMENT_JMXREMOTE_SSL_ENABLED_CIPHER_SUITES A comma-delimited list of SSL/TLS cipher suites to enable.
COM_SUN_MANAGEMENT_JMXREMOTE_SSL_ENABLED_PROTOCOLS A comma-delimited list of SSL/TLS protocol versions to enable.
COM_SUN_MANAGEMENT_JMXREMOTE_SSL_NEED_CLIENT_AUTH This property indicates whether SSL client authentication is enabled - com.sun.management.jmxremote.ssl.need.client.auth.
DEFAULT_PROVIDE_OVERLAPPING_TOMBSTONES
DRAIN_EXECUTOR_TIMEOUT_MS When draining, how long to wait for mutating executors to shutdown.
ENABLE_NODELOCAL_QUERIES Whether ConsistencyLevel.NODE_LOCAL should be allowed.
FLUSH_LOCAL_SCHEMA_CHANGES Flush changes of SchemaKeyspace after each schema modification.
GOSSIPER_QUARANTINE_DELAY Gossip quarantine delay is used while evaluating membership changes and should only be changed with extreme care.
IGNORED_SCHEMA_CHECK_ENDPOINTS
IGNORED_SCHEMA_CHECK_VERSIONS
IS_DISABLED_MBEAN_REGISTRATION This property indicates whether disable_mbean_registration is true
JAVA_CLASS_PATH Java class path.
JAVA_HOME
JAVA_IO_TMPDIR Indicates the temporary directory used by the Java Virtual Machine (JVM) to create and store temporary files.
JAVA_LIBRARY_PATH Path from which to load native libraries.
JAVA_RMI_SERVER_HOSTNAME The value of this property represents the host name string that should be associated with remote stubs for locally created remote objects, in order to allow clients to invoke methods on the remote object.
JAVA_RMI_SERVER_RANDOM_ID If this value is true, object identifiers for remote objects exported by this VM will be generated by using a cryptographically secure random number generator.
JAVA_SECURITY_EGD
JAVA_VERSION Java Runtime Environment version
JAVA_VM_NAME Java Virtual Machine implementation name
LINE_SEPARATOR Line separator ("\n" on UNIX).
MBEAN_REGISTRATION_CLASS what class to use for mbean registeration
MIGRATION_DELAY
MX4JADDRESS mx4jaddress
MX4JPORT mx4jport
NON_GRACEFUL_SHUTDOWN If set, MessagingService is shutdown abrtuptly without waiting for anything.
ORG_APACHE_CASSANDRA_CONF_CASSANDRA_RELEVANT_PROPERTIES_TEST
ORG_APACHE_CASSANDRA_DB_VIRTUAL_SYSTEM_PROPERTIES_TABLE_TEST
ORG_APACHE_CASSANDRA_DISABLE_MBEAN_REGISTRATION
OS_ARCH Operating system architecture.
OS_NAME Operating system name.
REPLACEMENT_ALLOW_EMPTY When doing a host replacement its possible that the gossip state is "empty" meaning that the endpoint is known but the current state isn't known.
SCHEMA_PULL_BACKOFF_DELAY_MS Minimum delay after a failed pull request before it is reattempted.
SCHEMA_PULL_INTERVAL_MS Defines how often schema definitions are pulled from the other nodes
SUN_ARCH_DATA_MODEL Platform word size sun.arch.data.model.
USE_NIX_RECURSIVE_DELETE When enabled, recursive directory deletion will be executed using a unix command `rm -rf` instead of traversing and removing individual files.
USER_HOME User's home directory.

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean() Gets the value of a system property as a boolean.
boolean	getBoolean(boolean overrideDefaultValue) Gets the value of a system property as a boolean.
int	getInt() Gets the value of a system property as a int.
int	getInt(int overrideDefaultValue) Gets the value of a system property as a int.
java.lang.String	getKey()
java.lang.String	getString() Gets the value of the indicated system property.
java.lang.String	getString(java.lang.String overrideDefaultValue) Gets the value of a system property as a String.
boolean	isPresent()
void	reset() Sets the property to its default value if a default value was specified.
void	setBoolean(boolean value) Sets the value into system properties.
void	setInt(int value) Sets the value into system properties.
void	setString(java.lang.String value) Sets the value into system properties.
static CassandraRelevantProperties	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CassandraRelevantProperties[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JAVA_HOME

public static final CassandraRelevantProperties JAVA_HOME

CASSANDRA_PID_FILE

public static final CassandraRelevantProperties CASSANDRA_PID_FILE

JAVA_IO_TMPDIR

public static final CassandraRelevantProperties JAVA_IO_TMPDIR

Indicates the temporary directory used by the Java Virtual Machine (JVM) to create and store temporary files.

JAVA_LIBRARY_PATH

public static final CassandraRelevantProperties JAVA_LIBRARY_PATH

Path from which to load native libraries. Default is absolute path to lib directory.

JAVA_SECURITY_EGD

public static final CassandraRelevantProperties JAVA_SECURITY_EGD

JAVA_VERSION

public static final CassandraRelevantProperties JAVA_VERSION

Java Runtime Environment version

JAVA_VM_NAME

public static final CassandraRelevantProperties JAVA_VM_NAME

Java Virtual Machine implementation name

LINE_SEPARATOR

public static final CassandraRelevantProperties LINE_SEPARATOR

Line separator ("\n" on UNIX).

JAVA_CLASS_PATH

public static final CassandraRelevantProperties JAVA_CLASS_PATH

Java class path.

OS_ARCH

public static final CassandraRelevantProperties OS_ARCH

Operating system architecture.

OS_NAME

public static final CassandraRelevantProperties OS_NAME

Operating system name.

USER_HOME

public static final CassandraRelevantProperties USER_HOME

User's home directory.

SUN_ARCH_DATA_MODEL

public static final CassandraRelevantProperties SUN_ARCH_DATA_MODEL

Platform word size sun.arch.data.model. Examples: "32", "64", "unknown"

JAVA_RMI_SERVER_HOSTNAME

public static final CassandraRelevantProperties JAVA_RMI_SERVER_HOSTNAME

The value of this property represents the host name string that should be associated with remote stubs for locally created remote objects, in order to allow clients to invoke methods on the remote object.

JAVA_RMI_SERVER_RANDOM_ID

public static final CassandraRelevantProperties JAVA_RMI_SERVER_RANDOM_ID

If this value is true, object identifiers for remote objects exported by this VM will be generated by using a cryptographically secure random number generator. The default value is false.

COM_SUN_MANAGEMENT_JMXREMOTE_AUTHENTICATE

public static final CassandraRelevantProperties COM_SUN_MANAGEMENT_JMXREMOTE_AUTHENTICATE

This property indicates whether password authentication for remote monitoring is enabled. By default it is disabled - com.sun.management.jmxremote.authenticate

COM_SUN_MANAGEMENT_JMXREMOTE_RMI_PORT

public static final CassandraRelevantProperties COM_SUN_MANAGEMENT_JMXREMOTE_RMI_PORT

The port number to which the RMI connector will be bound - com.sun.management.jmxremote.rmi.port. An Integer object that represents the value of the second argument is returned if there is no port specified, if the port does not have the correct numeric format, or if the specified name is empty or null.

CASSANDRA_JMX_REMOTE_PORT

public static final CassandraRelevantProperties CASSANDRA_JMX_REMOTE_PORT

Cassandra jmx remote port

COM_SUN_MANAGEMENT_JMXREMOTE_SSL

public static final CassandraRelevantProperties COM_SUN_MANAGEMENT_JMXREMOTE_SSL

This property indicates whether SSL is enabled for monitoring remotely. Default is set to false.

COM_SUN_MANAGEMENT_JMXREMOTE_SSL_NEED_CLIENT_AUTH

public static final CassandraRelevantProperties COM_SUN_MANAGEMENT_JMXREMOTE_SSL_NEED_CLIENT_AUTH

This property indicates whether SSL client authentication is enabled - com.sun.management.jmxremote.ssl.need.client.auth. Default is set to false.

COM_SUN_MANAGEMENT_JMXREMOTE_ACCESS_FILE

public static final CassandraRelevantProperties COM_SUN_MANAGEMENT_JMXREMOTE_ACCESS_FILE

This property indicates the location for the access file. If com.sun.management.jmxremote.authenticate is false, then this property and the password and access files, are ignored. Otherwise, the access file must exist and be in the valid format. If the access file is empty or nonexistent, then no access is allowed.

COM_SUN_MANAGEMENT_JMXREMOTE_PASSWORD_FILE

public static final CassandraRelevantProperties COM_SUN_MANAGEMENT_JMXREMOTE_PASSWORD_FILE

This property indicates the path to the password file - com.sun.management.jmxremote.password.file

COM_SUN_MANAGEMENT_JMXREMOTE_PORT

public static final CassandraRelevantProperties COM_SUN_MANAGEMENT_JMXREMOTE_PORT

Port number to enable JMX RMI connections - com.sun.management.jmxremote.port

COM_SUN_MANAGEMENT_JMXREMOTE_SSL_ENABLED_PROTOCOLS

public static final CassandraRelevantProperties COM_SUN_MANAGEMENT_JMXREMOTE_SSL_ENABLED_PROTOCOLS

A comma-delimited list of SSL/TLS protocol versions to enable. Used in conjunction with com.sun.management.jmxremote.ssl - com.sun.management.jmxremote.ssl.enabled.protocols

COM_SUN_MANAGEMENT_JMXREMOTE_SSL_ENABLED_CIPHER_SUITES

public static final CassandraRelevantProperties COM_SUN_MANAGEMENT_JMXREMOTE_SSL_ENABLED_CIPHER_SUITES

A comma-delimited list of SSL/TLS cipher suites to enable. Used in conjunction with com.sun.management.jmxremote.ssl - com.sun.management.jmxremote.ssl.enabled.cipher.suites

MX4JADDRESS

public static final CassandraRelevantProperties MX4JADDRESS

mx4jaddress

MX4JPORT

public static final CassandraRelevantProperties MX4JPORT

mx4jport

BOOTSTRAP_SKIP_SCHEMA_CHECK

public static final CassandraRelevantProperties BOOTSTRAP_SKIP_SCHEMA_CHECK

When bootstraping we wait for all schema versions found in gossip to be seen, and if not seen in time we fail the bootstrap; this property will avoid failing and allow bootstrap to continue if set to true.

BOOTSTRAP_SCHEMA_DELAY_MS

public static final CassandraRelevantProperties BOOTSTRAP_SCHEMA_DELAY_MS

When bootstraping how long to wait for schema versions to be seen.

DRAIN_EXECUTOR_TIMEOUT_MS

public static final CassandraRelevantProperties DRAIN_EXECUTOR_TIMEOUT_MS

When draining, how long to wait for mutating executors to shutdown.

GOSSIPER_QUARANTINE_DELAY

public static final CassandraRelevantProperties GOSSIPER_QUARANTINE_DELAY

Gossip quarantine delay is used while evaluating membership changes and should only be changed with extreme care.

IGNORED_SCHEMA_CHECK_VERSIONS

public static final CassandraRelevantProperties IGNORED_SCHEMA_CHECK_VERSIONS

IGNORED_SCHEMA_CHECK_ENDPOINTS

public static final CassandraRelevantProperties IGNORED_SCHEMA_CHECK_ENDPOINTS

REPLACEMENT_ALLOW_EMPTY

public static final CassandraRelevantProperties REPLACEMENT_ALLOW_EMPTY

When doing a host replacement its possible that the gossip state is "empty" meaning that the endpoint is known but the current state isn't known. If the host replacement is needed to repair this state, this property must be true.

ENABLE_NODELOCAL_QUERIES

public static final CassandraRelevantProperties ENABLE_NODELOCAL_QUERIES

Whether ConsistencyLevel.NODE_LOCAL should be allowed.

CASSANDRA_FOREGROUND

public static final CassandraRelevantProperties CASSANDRA_FOREGROUND

The cassandra-foreground option will tell CassandraDaemon whether to close stdout/stderr, but it's up to us not to background. yes/null

DEFAULT_PROVIDE_OVERLAPPING_TOMBSTONES

public static final CassandraRelevantProperties DEFAULT_PROVIDE_OVERLAPPING_TOMBSTONES

ORG_APACHE_CASSANDRA_DISABLE_MBEAN_REGISTRATION

public static final CassandraRelevantProperties ORG_APACHE_CASSANDRA_DISABLE_MBEAN_REGISTRATION

ORG_APACHE_CASSANDRA_CONF_CASSANDRA_RELEVANT_PROPERTIES_TEST

public static final CassandraRelevantProperties ORG_APACHE_CASSANDRA_CONF_CASSANDRA_RELEVANT_PROPERTIES_TEST

ORG_APACHE_CASSANDRA_DB_VIRTUAL_SYSTEM_PROPERTIES_TABLE_TEST

public static final CassandraRelevantProperties ORG_APACHE_CASSANDRA_DB_VIRTUAL_SYSTEM_PROPERTIES_TABLE_TEST

IS_DISABLED_MBEAN_REGISTRATION

public static final CassandraRelevantProperties IS_DISABLED_MBEAN_REGISTRATION

This property indicates whether disable_mbean_registration is true

MBEAN_REGISTRATION_CLASS

public static final CassandraRelevantProperties MBEAN_REGISTRATION_CLASS

what class to use for mbean registeration

MIGRATION_DELAY

public static final CassandraRelevantProperties MIGRATION_DELAY

SCHEMA_PULL_INTERVAL_MS

public static final CassandraRelevantProperties SCHEMA_PULL_INTERVAL_MS

Defines how often schema definitions are pulled from the other nodes

SCHEMA_PULL_BACKOFF_DELAY_MS

public static final CassandraRelevantProperties SCHEMA_PULL_BACKOFF_DELAY_MS

Minimum delay after a failed pull request before it is reattempted. It prevents reattempting failed requests immediately as it is high chance they will fail anyway. It is better to wait a bit instead of flooding logs and wasting resources.

USE_NIX_RECURSIVE_DELETE

public static final CassandraRelevantProperties USE_NIX_RECURSIVE_DELETE

When enabled, recursive directory deletion will be executed using a unix command `rm -rf` instead of traversing and removing individual files. This is now used only tests, but eventually we will make it true by default.

NON_GRACEFUL_SHUTDOWN

public static final CassandraRelevantProperties NON_GRACEFUL_SHUTDOWN

If set, MessagingService is shutdown abrtuptly without waiting for anything. This is an optimization used in unit tests becuase we never restart a node there. The only node is stopoped when the JVM terminates. Therefore, we can use such optimization and not wait unnecessarily.

FLUSH_LOCAL_SCHEMA_CHANGES

public static final CassandraRelevantProperties FLUSH_LOCAL_SCHEMA_CHANGES

Flush changes of SchemaKeyspace after each schema modification. In production, we always do that. However, tests which do not restart nodes may disable this functionality in order to run faster. Note that this is disabled for unit tests but if an individual test requires schema to be flushed, it can be also done manually for that particular case: flush(SchemaConstants.SCHEMA_KEYSPACE_NAME);.

Method Detail

values

public static CassandraRelevantProperties[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CassandraRelevantProperties c : CassandraRelevantProperties.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CassandraRelevantProperties valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getKey

public java.lang.String getKey()

getString

public java.lang.String getString()

Gets the value of the indicated system property.

Returns:

system property value if it exists, defaultValue otherwise.

reset

public void reset()

Sets the property to its default value if a default value was specified. Remove the property otherwise.

getString

public java.lang.String getString(java.lang.String overrideDefaultValue)

Gets the value of a system property as a String.

Returns:

system property String value if it exists, overrideDefaultValue otherwise.

setString

public void setString(java.lang.String value)

Sets the value into system properties.

Parameters:

value - to set

getBoolean

public boolean getBoolean()

Gets the value of a system property as a boolean.

Returns:

system property boolean value if it exists, false otherwise().

getBoolean

public boolean getBoolean(boolean overrideDefaultValue)

Gets the value of a system property as a boolean.

Returns:

system property boolean value if it exists, overrideDefaultValue otherwise.

setBoolean

public void setBoolean(boolean value)

Sets the value into system properties.

Parameters:

value - to set

getInt

public int getInt()

Gets the value of a system property as a int.

Returns:

system property int value if it exists, defaultValue otherwise.

getInt

public int getInt(int overrideDefaultValue)

Gets the value of a system property as a int.

Returns:

system property int value if it exists, overrideDefaultValue otherwise.

setInt

public void setInt(int value)

Sets the value into system properties.

Parameters:

value - to set

isPresent

public boolean isPresent()

Returns:

whether a system property is present or not.