CassandraNode (Apache Brooklyn)

All Superinterfaces:

BrooklynObject, Configurable, DatastoreMixins.CanExecuteScript, DatastoreMixins.CanGiveCreationScript, DatastoreMixins.DatastoreCommon, DatastoreMixins.HasDatastoreUrl, Entity, Identifiable, SoftwareProcess, Startable, UsesJava, UsesJavaMXBeans, UsesJmx

All Known Implementing Classes:

CassandraNodeImpl
```
public interface CassandraNode
extends DatastoreMixins.DatastoreCommon, SoftwareProcess, UsesJmx, UsesJavaMXBeans, DatastoreMixins.HasDatastoreUrl, DatastoreMixins.CanExecuteScript
```
An Entity that represents a Cassandra node in a CassandraDatacenter.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess
  SoftwareProcess.ChildStartableMode, SoftwareProcess.RestartSoftwareParameters, SoftwareProcess.StopSoftwareParameters
- Nested classes/interfaces inherited from interface org.apache.brooklyn.api.entity.Entity
  Entity.SensorSupport
- Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject
  BrooklynObject.TagSupport
- Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable
  Configurable.ConfigurationSupport
- Nested classes/interfaces inherited from interface org.apache.brooklyn.core.entity.trait.Startable
  Startable.RestartEffectorBody, Startable.StartEffectorBody, Startable.StopEffectorBody
- Nested classes/interfaces inherited from interface org.apache.brooklyn.entity.java.UsesJmx
  UsesJmx.JmxAgentModes

Field Summary

Fields
Modifier and Type	Field and Description
`static ConfigKey<java.lang.String>`	`BROADCAST_ADDRESS_SENSOR`
`static ConfigKey<java.lang.String>`	`CASSANDRA_CONFIG_FILE_NAME`
`static ConfigKey<java.lang.String>`	`CASSANDRA_CONFIG_TEMPLATE_URL`
`static ConfigKey<java.lang.String>`	`CASSANDRA_RACKDC_CONFIG_FILE_NAME`
`static ConfigKey<java.lang.String>`	`CASSANDRA_RACKDC_CONFIG_TEMPLATE_URL`
`static BasicAttributeSensorAndConfigKey<java.lang.String>`	`CLUSTER_NAME`
`static ConfigKey<java.lang.String>`	`CUSTOM_SNITCH_JAR_URL`
`static BasicAttributeSensorAndConfigKey<java.lang.String>`	`DATACENTER_NAME`
`static BasicAttributeSensorAndConfigKey<java.lang.String>`	`DOWNLOAD_URL`
`static ConfigKey<java.lang.String>`	`ENDPOINT_SNITCH_NAME`
`static Effector<java.lang.String>`	`EXECUTE_SCRIPT`
`static PortAttributeSensorAndConfigKey`	`GOSSIP_PORT`
`static ConfigKey<java.util.Set<Entity>>`	`INITIAL_SEEDS`
`static ConfigKey<UsesJmx.JmxAgentModes>`	`JMX_AGENT_MODE`
`static ConfigKey<java.lang.String>`	`LISTEN_ADDRESS_SENSOR`
`static AttributeSensor<java.lang.Integer>`	`LIVE_NODE_COUNT`
`static ConfigKey<java.lang.String>`	`MIRROR_URL` download mirror, if desired
`static PortAttributeSensorAndConfigKey`	`NATIVE_TRANSPORT_PORT`
`static ConfigKey<java.lang.Integer>`	`NUM_TOKENS_PER_NODE`
`static AttributeSensor<java.lang.Integer>`	`PEERS`
`static BasicAttributeSensorAndConfigKey<java.lang.String>`	`RACK_NAME`
`static AttributeSensor<java.lang.Integer>`	`READ_ACTIVE`
`static AttributeSensor<java.lang.Long>`	`READ_COMPLETED`
`static AttributeSensor<java.lang.Long>`	`READ_PENDING`
`static AttributeSensor<java.lang.Double>`	`READS_PER_SECOND_IN_WINDOW`
`static AttributeSensor<java.lang.Double>`	`READS_PER_SECOND_LAST`
`static PortAttributeSensorAndConfigKey`	`RMI_REGISTRY_PORT`
`static ConfigKey<java.lang.String>`	`RPC_ADDRESS_SENSOR`
`static AttributeSensor<java.lang.Boolean>`	`SERVICE_UP_JMX`
`static PortAttributeSensorAndConfigKey`	`SSL_GOSSIP_PORT`
`static ConfigKey<Duration>`	`START_TIMEOUT`
`static ConfigKey<java.lang.String>`	`SUGGESTED_VERSION`
`static ConfigKey<java.lang.String>`	`TGZ_URL`
`static PortAttributeSensorAndConfigKey`	`THRIFT_PORT`
`static AttributeSensor<java.lang.Long>`	`THRIFT_PORT_LATENCY`
`static AttributeSensor<java.lang.Double>`	`THRIFT_PORT_LATENCY_IN_WINDOW`
`static BasicAttributeSensorAndConfigKey<java.math.BigInteger>`	`TOKEN` Deprecated. since 0.7; use `TOKENS`
`static BasicAttributeSensorAndConfigKey<java.util.Set<java.math.BigInteger>>`	`TOKENS`
`static AttributeSensor<java.lang.Integer>`	`WRITE_ACTIVE`
`static AttributeSensor<java.lang.Long>`	`WRITE_COMPLETED`
`static AttributeSensor<java.lang.Long>`	`WRITE_PENDING`
`static AttributeSensor<java.lang.Double>`	`WRITES_PER_SECOND_IN_WINDOW`
`static AttributeSensor<java.lang.Double>`	`WRITES_PER_SECOND_LAST`

Fields inherited from interface org.apache.brooklyn.entity.database.DatastoreMixins.HasDatastoreUrl
DATASTORE_URL

Fields inherited from interface org.apache.brooklyn.entity.database.DatastoreMixins.CanGiveCreationScript
CREATION_SCRIPT_CONTENTS, CREATION_SCRIPT_URL

Fields inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess
ADDRESS, CHILDREN_STARTABLE_MODE, CUSTOMIZE_LATCH, DONT_REQUIRE_TTY_FOR_SUDO, DOWNLOAD_ADDON_URLS, ENTITY_STARTED, EXPANDED_INSTALL_DIR, HOSTNAME, INSTALL_DIR, INSTALL_FILES, INSTALL_LATCH, INSTALL_RESOURCES_LATCH, INSTALL_TEMPLATES, INSTALL_UNIQUE_LABEL, LAUNCH_LATCH, LIFECYCLE_EFFECTOR_TASKS, MAXIMUM_REBIND_SENSOR_CONNECT_DELAY, OPEN_IPTABLES, PID_FILE, POST_INSTALL_COMMAND, POST_LAUNCH_COMMAND, PRE_INSTALL_COMMAND, PRE_INSTALL_FILES, PRE_INSTALL_TEMPLATES, PRE_LAUNCH_COMMAND, PROVISIONING_LOCATION, PROVISIONING_PROPERTIES, REQUIRED_OPEN_LOGIN_PORTS, RETRIEVE_USAGE_METRICS, RUN_DIR, RUNTIME_FILES, RUNTIME_RESOURCES_LATCH, RUNTIME_TEMPLATES, SERVICE_PROCESS_IS_RUNNING, SERVICE_STATE_ACTUAL, SERVICE_STATE_EXPECTED, SETUP_LATCH, SHELL_ENVIRONMENT, SKIP_ENTITY_START_IF_RUNNING, SKIP_INSTALLATION, START_LATCH, STOP_IPTABLES, SUBNET_ADDRESS, SUBNET_HOSTNAME, SUGGESTED_INSTALL_DIR, SUGGESTED_RUN_DIR

Fields inherited from interface org.apache.brooklyn.core.entity.trait.Startable
RESTART, SERVICE_UP, START, STOP

Fields inherited from interface org.apache.brooklyn.entity.java.UsesJmx
DEFAULT_JMX_PORT, JMX_AGENT_LOCAL_PATH, JMX_CONTEXT, JMX_PASSWORD, JMX_PORT, JMX_PORT_LEGACY, JMX_SSL_ACCESS_CERT, JMX_SSL_ACCESS_KEY, JMX_SSL_ENABLED, JMX_URL, JMX_USER, USE_JMX

Fields inherited from interface org.apache.brooklyn.entity.java.UsesJava
CHECK_JAVA_HOSTNAME_BUG, JAVA_OPTS, JAVA_SYSPROPS, JAVA_VERSION_REQUIRED

Fields inherited from interface org.apache.brooklyn.entity.java.UsesJavaMXBeans
AVAILABLE_PROCESSORS, COMMITTED_HEAP_MEMORY, CURRENT_THREAD_COUNT, FREE_PHYSICAL_MEMORY_SIZE, GARBAGE_COLLECTION_TIME, INIT_HEAP_MEMORY, MAX_HEAP_MEMORY, MXBEAN_STATS_ENABLED, NON_HEAP_MEMORY_USAGE, PEAK_THREAD_COUNT, PROCESS_CPU_TIME, PROCESS_CPU_TIME_FRACTION_IN_WINDOW, PROCESS_CPU_TIME_FRACTION_LAST, START_TIME, SYSTEM_LOAD_AVERAGE, TOTAL_PHYSICAL_MEMORY_SIZE, UP_TIME, USED_HEAP_MEMORY

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`executeScript(java.lang.String commands)`
`java.lang.String`	`getBroadcastAddress()`
`java.lang.String`	`getClusterName()`
`java.lang.Integer`	`getGossipPort()`
`java.lang.String`	`getListenAddress()`
`java.lang.String`	`getMajorMinorVersion()`
`java.lang.Integer`	`getNativeTransportPort()`
`int`	`getNumTokensPerNode()`
`java.lang.String`	`getPrivateIp()`
`java.lang.String`	`getPublicIp()`
`java.lang.String`	`getRpcAddress()`
`java.lang.String`	`getSeeds()`
`java.lang.Integer`	`getSslGossipPort()`
`java.lang.Integer`	`getThriftPort()`
`java.math.BigInteger`	`getToken()` Deprecated. since 0.7; see `getTokens()`
`java.lang.String`	`getTokenAsString()` Deprecated. since 0.7; use `getTokensAsString()`
`java.util.Set<java.math.BigInteger>`	`getTokens()`
`java.lang.String`	`getTokensAsString()` string value of comma-separated tokens; or blank if none
`void`	`setToken(java.lang.String token)`

Methods inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess
populateServiceNotUpDiagnostics

Methods inherited from interface org.apache.brooklyn.api.entity.Entity
addChild, addChild, addEnricher, addEnricher, addFeed, addGroup, addPolicy, addPolicy, clearParent, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getConfig, getConfigRaw, getConfigRaw, getCreationTime, getDisplayName, getEnrichers, getEntityType, getGroups, getIconUrl, getId, getLocations, getParent, getPolicies, invoke, removeChild, removeEnricher, removeGroup, removePolicy, sensors, setParent

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject
getCatalogItemId, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable
config, setConfig

Methods inherited from interface org.apache.brooklyn.core.entity.trait.Startable
restart, start, stop

Field Detail

SUGGESTED_VERSION

static final ConfigKey<java.lang.String> SUGGESTED_VERSION

DOWNLOAD_URL

static final BasicAttributeSensorAndConfigKey<java.lang.String> DOWNLOAD_URL

MIRROR_URL

static final ConfigKey<java.lang.String> MIRROR_URL

download mirror, if desired

TGZ_URL

static final ConfigKey<java.lang.String> TGZ_URL

CLUSTER_NAME

static final BasicAttributeSensorAndConfigKey<java.lang.String> CLUSTER_NAME

ENDPOINT_SNITCH_NAME

static final ConfigKey<java.lang.String> ENDPOINT_SNITCH_NAME

GOSSIP_PORT

static final PortAttributeSensorAndConfigKey GOSSIP_PORT

SSL_GOSSIP_PORT

static final PortAttributeSensorAndConfigKey SSL_GOSSIP_PORT

THRIFT_PORT

static final PortAttributeSensorAndConfigKey THRIFT_PORT

NATIVE_TRANSPORT_PORT

static final PortAttributeSensorAndConfigKey NATIVE_TRANSPORT_PORT

RMI_REGISTRY_PORT

static final PortAttributeSensorAndConfigKey RMI_REGISTRY_PORT

JMX_AGENT_MODE

static final ConfigKey<UsesJmx.JmxAgentModes> JMX_AGENT_MODE

CUSTOM_SNITCH_JAR_URL

static final ConfigKey<java.lang.String> CUSTOM_SNITCH_JAR_URL

CASSANDRA_CONFIG_TEMPLATE_URL

static final ConfigKey<java.lang.String> CASSANDRA_CONFIG_TEMPLATE_URL

CASSANDRA_CONFIG_FILE_NAME

static final ConfigKey<java.lang.String> CASSANDRA_CONFIG_FILE_NAME

CASSANDRA_RACKDC_CONFIG_TEMPLATE_URL

static final ConfigKey<java.lang.String> CASSANDRA_RACKDC_CONFIG_TEMPLATE_URL

CASSANDRA_RACKDC_CONFIG_FILE_NAME

static final ConfigKey<java.lang.String> CASSANDRA_RACKDC_CONFIG_FILE_NAME

DATACENTER_NAME

static final BasicAttributeSensorAndConfigKey<java.lang.String> DATACENTER_NAME

RACK_NAME

static final BasicAttributeSensorAndConfigKey<java.lang.String> RACK_NAME

NUM_TOKENS_PER_NODE

static final ConfigKey<java.lang.Integer> NUM_TOKENS_PER_NODE

TOKEN

@Deprecated
static final BasicAttributeSensorAndConfigKey<java.math.BigInteger> TOKEN

Deprecated. since 0.7; use TOKENS

TOKENS

static final BasicAttributeSensorAndConfigKey<java.util.Set<java.math.BigInteger>> TOKENS

PEERS

static final AttributeSensor<java.lang.Integer> PEERS

LIVE_NODE_COUNT

static final AttributeSensor<java.lang.Integer> LIVE_NODE_COUNT

READ_PENDING

static final AttributeSensor<java.lang.Long> READ_PENDING

READ_ACTIVE

static final AttributeSensor<java.lang.Integer> READ_ACTIVE

READ_COMPLETED

static final AttributeSensor<java.lang.Long> READ_COMPLETED

WRITE_PENDING

static final AttributeSensor<java.lang.Long> WRITE_PENDING

WRITE_ACTIVE

static final AttributeSensor<java.lang.Integer> WRITE_ACTIVE

WRITE_COMPLETED

static final AttributeSensor<java.lang.Long> WRITE_COMPLETED

SERVICE_UP_JMX

static final AttributeSensor<java.lang.Boolean> SERVICE_UP_JMX

THRIFT_PORT_LATENCY

static final AttributeSensor<java.lang.Long> THRIFT_PORT_LATENCY

READS_PER_SECOND_LAST

static final AttributeSensor<java.lang.Double> READS_PER_SECOND_LAST

WRITES_PER_SECOND_LAST

static final AttributeSensor<java.lang.Double> WRITES_PER_SECOND_LAST

THRIFT_PORT_LATENCY_IN_WINDOW

static final AttributeSensor<java.lang.Double> THRIFT_PORT_LATENCY_IN_WINDOW

READS_PER_SECOND_IN_WINDOW

static final AttributeSensor<java.lang.Double> READS_PER_SECOND_IN_WINDOW

WRITES_PER_SECOND_IN_WINDOW

static final AttributeSensor<java.lang.Double> WRITES_PER_SECOND_IN_WINDOW

INITIAL_SEEDS

static final ConfigKey<java.util.Set<Entity>> INITIAL_SEEDS

START_TIMEOUT

static final ConfigKey<Duration> START_TIMEOUT

LISTEN_ADDRESS_SENSOR

static final ConfigKey<java.lang.String> LISTEN_ADDRESS_SENSOR

BROADCAST_ADDRESS_SENSOR

static final ConfigKey<java.lang.String> BROADCAST_ADDRESS_SENSOR

RPC_ADDRESS_SENSOR

static final ConfigKey<java.lang.String> RPC_ADDRESS_SENSOR

EXECUTE_SCRIPT

static final Effector<java.lang.String> EXECUTE_SCRIPT

Method Detail

getMajorMinorVersion

java.lang.String getMajorMinorVersion()

getGossipPort
```
java.lang.Integer getGossipPort()
```

getSslGossipPort
```
java.lang.Integer getSslGossipPort()
```

getThriftPort
```
java.lang.Integer getThriftPort()
```

getNativeTransportPort

java.lang.Integer getNativeTransportPort()

getClusterName
```
java.lang.String getClusterName()
```

getListenAddress
```
java.lang.String getListenAddress()
```

getBroadcastAddress
```
java.lang.String getBroadcastAddress()
```

getRpcAddress
```
java.lang.String getRpcAddress()
```

getSeeds
```
java.lang.String getSeeds()
```

getPrivateIp
```
java.lang.String getPrivateIp()
```

getPublicIp
```
java.lang.String getPublicIp()
```

getToken
```
@Deprecated
java.math.BigInteger getToken()
```
Deprecated. since 0.7; see getTokens()

In range 0 to (2^127)-1; or null if not yet set or known. Returns the first token if more than one token.

getNumTokensPerNode
```
int getNumTokensPerNode()
```

getTokens

java.util.Set<java.math.BigInteger> getTokens()

getTokenAsString
```
@Deprecated
java.lang.String getTokenAsString()
```
Deprecated. since 0.7; use getTokensAsString()

string value of token (with no commas, which freemarker introduces!) or blank if none

getTokensAsString
```
java.lang.String getTokensAsString()
```
string value of comma-separated tokens; or blank if none

setToken
```
void setToken(java.lang.String token)
```

executeScript

java.lang.String executeScript(java.lang.String commands)

Interface CassandraNode

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.entity.Entity

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.entity.trait.Startable

Nested classes/interfaces inherited from interface org.apache.brooklyn.entity.java.UsesJmx

Field Summary

Fields inherited from interface org.apache.brooklyn.entity.database.DatastoreMixins.HasDatastoreUrl

Fields inherited from interface org.apache.brooklyn.entity.database.DatastoreMixins.CanGiveCreationScript

Fields inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

Fields inherited from interface org.apache.brooklyn.core.entity.trait.Startable

Fields inherited from interface org.apache.brooklyn.entity.java.UsesJmx

Fields inherited from interface org.apache.brooklyn.entity.java.UsesJava

Fields inherited from interface org.apache.brooklyn.entity.java.UsesJavaMXBeans

Method Summary

Methods inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

Methods inherited from interface org.apache.brooklyn.api.entity.Entity

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

Methods inherited from interface org.apache.brooklyn.core.entity.trait.Startable

Field Detail

SUGGESTED_VERSION

DOWNLOAD_URL

MIRROR_URL

TGZ_URL

CLUSTER_NAME

ENDPOINT_SNITCH_NAME

GOSSIP_PORT

SSL_GOSSIP_PORT

THRIFT_PORT

NATIVE_TRANSPORT_PORT

RMI_REGISTRY_PORT

JMX_AGENT_MODE

CUSTOM_SNITCH_JAR_URL

CASSANDRA_CONFIG_TEMPLATE_URL

CASSANDRA_CONFIG_FILE_NAME

CASSANDRA_RACKDC_CONFIG_TEMPLATE_URL

CASSANDRA_RACKDC_CONFIG_FILE_NAME

DATACENTER_NAME

RACK_NAME

NUM_TOKENS_PER_NODE

TOKEN

TOKENS

PEERS

LIVE_NODE_COUNT

READ_PENDING

READ_ACTIVE

READ_COMPLETED

WRITE_PENDING

WRITE_ACTIVE

WRITE_COMPLETED

SERVICE_UP_JMX

THRIFT_PORT_LATENCY

READS_PER_SECOND_LAST

WRITES_PER_SECOND_LAST

THRIFT_PORT_LATENCY_IN_WINDOW

READS_PER_SECOND_IN_WINDOW

WRITES_PER_SECOND_IN_WINDOW

INITIAL_SEEDS

START_TIMEOUT

LISTEN_ADDRESS_SENSOR

BROADCAST_ADDRESS_SENSOR

RPC_ADDRESS_SENSOR

EXECUTE_SCRIPT

Method Detail

getMajorMinorVersion

getGossipPort

getSslGossipPort

getThriftPort

getNativeTransportPort

getClusterName

getListenAddress

getBroadcastAddress

getRpcAddress

getSeeds

getPrivateIp

getPublicIp

getToken