Package org.apache.cassandra.config

Enum 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 Detail

      • 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.

      • 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

      • SUN_RMI_TRANSPORT_TCP_THREADKEEPALIVETIME

        public static final CassandraRelevantProperties SUN_RMI_TRANSPORT_TCP_THREADKEEPALIVETIME
        Controls the JMX server threadpool keap-alive time. Should only be set by in-jvm dtests.

      • JAVA_RMI_DGC_LEASE_VALUE_IN_JVM_DTEST

        public static final CassandraRelevantProperties JAVA_RMI_DGC_LEASE_VALUE_IN_JVM_DTEST
        Controls the distributed garbage collector lease time for JMX objects. Should only be set by in-jvm dtests.

      • 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 and local 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

      • 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.

      • 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.

      • LOG_DIR

        public static final CassandraRelevantProperties LOG_DIR
        Directory where Cassandra puts its logs, defaults to "." which is current directory.

      • LOG_DIR_AUDIT

        public static final CassandraRelevantProperties LOG_DIR_AUDIT
        Directory where Cassandra persists logs from audit logging. If this property is not set, the audit log framework will set it automatically to LOG_DIR + "/audit".

      • 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

      • ORG_APACHE_CASSANDRA_DISABLE_MBEAN_REGISTRATION

        public static final CassandraRelevantProperties ORG_APACHE_CASSANDRA_DISABLE_MBEAN_REGISTRATION

      • IS_DISABLED_MBEAN_REGISTRATION

        public static final CassandraRelevantProperties IS_DISABLED_MBEAN_REGISTRATION
        This property indicates whether disable_mbean_registration is true

      • SNAPSHOT_CLEANUP_PERIOD_SECONDS

        public static final CassandraRelevantProperties SNAPSHOT_CLEANUP_PERIOD_SECONDS
        snapshots ttl cleanup period in seconds

      • SNAPSHOT_CLEANUP_INITIAL_DELAY_SECONDS

        public static final CassandraRelevantProperties SNAPSHOT_CLEANUP_INITIAL_DELAY_SECONDS
        snapshots ttl cleanup initial delay in seconds

      • SNAPSHOT_MIN_ALLOWED_TTL_SECONDS

        public static final CassandraRelevantProperties SNAPSHOT_MIN_ALLOWED_TTL_SECONDS
        minimum allowed TTL for snapshots

      • MBEAN_REGISTRATION_CLASS

        public static final CassandraRelevantProperties MBEAN_REGISTRATION_CLASS
        what class to use for mbean registeration

      • DTEST_IS_IN_JVM_DTEST

        public static final CassandraRelevantProperties DTEST_IS_IN_JVM_DTEST
        This property indicates if the code is running under the in-jvm dtest framework

      • SCHEMA_PULL_INTERVAL_MS

        public static final CassandraRelevantProperties SCHEMA_PULL_INTERVAL_MS
        Defines how often schema definitions are pulled from the other nodes

      • ALLOW_DUPLICATE_CONFIG_KEYS

        public static final CassandraRelevantProperties ALLOW_DUPLICATE_CONFIG_KEYS
        If we should allow having duplicate keys in the config file, default to true for legacy reasons

      • ALLOW_NEW_OLD_CONFIG_KEYS

        public static final CassandraRelevantProperties ALLOW_NEW_OLD_CONFIG_KEYS
        If we should allow having both new (post CASSANDRA-15234) and old config keys for the same config item in the yaml

      • FILE_SYSTEM_CHECK_OWNERSHIP_FILENAME

        @Deprecated
public static final CassandraRelevantProperties FILE_SYSTEM_CHECK_OWNERSHIP_FILENAME
        Deprecated.

      • FILE_SYSTEM_CHECK_OWNERSHIP_TOKEN

        @Deprecated
public static final CassandraRelevantProperties FILE_SYSTEM_CHECK_OWNERSHIP_TOKEN
        Deprecated.

      • DISK_USAGE_MONITOR_INTERVAL_MS

        public static final CassandraRelevantProperties DISK_USAGE_MONITOR_INTERVAL_MS
        property for the rate of the scheduled task that monitors disk usage

      • DISK_USAGE_NOTIFY_INTERVAL_MS

        public static final CassandraRelevantProperties DISK_USAGE_NOTIFY_INTERVAL_MS
        property for the interval on which the repeated client warnings and diagnostic events about disk usage are ignored

      • 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

      • FORCE_LOAD_LOCAL_KEYSPACES

        public static final CassandraRelevantProperties FORCE_LOAD_LOCAL_KEYSPACES
        Used when running in Client mode and the system and schema keyspaces need to be initialized outside of their normal initialization path

      • 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);.

      • GOSSIP_SETTLE_MIN_WAIT_MS

        public static final CassandraRelevantProperties GOSSIP_SETTLE_MIN_WAIT_MS
        Delay before checking if gossip is settled.

      • GOSSIP_SETTLE_POLL_INTERVAL_MS

        public static final CassandraRelevantProperties GOSSIP_SETTLE_POLL_INTERVAL_MS
        Interval delay between checking gossip is settled.

      • GOSSIP_SETTLE_POLL_SUCCESSES_REQUIRED

        public static final CassandraRelevantProperties GOSSIP_SETTLE_POLL_SUCCESSES_REQUIRED
        Number of polls without gossip state change to consider gossip as settled.

      • REQUIRED_BATCHLOG_REPLICA_COUNT

        public static final CassandraRelevantProperties REQUIRED_BATCHLOG_REPLICA_COUNT
        Number of replicas required to store batchlog for atomicity, only accepts values of 1 or 2.

      • SKIP_OPTIMAL_STREAMING_CANDIDATES_CALCULATION

        public static final CassandraRelevantProperties SKIP_OPTIMAL_STREAMING_CANDIDATES_CALCULATION
        Do not try to calculate optimal streaming candidates. This can take a lot of time in some configs specially with vnodes.

      • ROLE_PASSWORD_UPDATE_MIN_INTERVAL_MS

        public static final CassandraRelevantProperties ROLE_PASSWORD_UPDATE_MIN_INTERVAL_MS
        How often a role's password can be changed

    • 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.

      • getDefaultValue

        public java.lang.String getDefaultValue()
        Returns default value.
        Returns:
        default value, if any, otherwise null.

      • 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.

      • clearValue

        public void clearValue()
        Clears the value set in the system property.

      • 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.

      • getLong

        public long getLong()
        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

      • setLong

        public void setLong​(long value)
        Sets the value into system properties.
        Parameters:
        value - to set

      • isPresent

        public boolean isPresent()
        Returns:
        whether a system property is present or not.