CassandraNodeSshDriver (Apache Brooklyn)

java.lang.Object
- brooklyn.entity.basic.AbstractSoftwareProcessDriver
- - brooklyn.entity.basic.AbstractSoftwareProcessSshDriver
  - - brooklyn.entity.java.JavaSoftwareProcessSshDriver
    - - brooklyn.entity.nosql.cassandra.CassandraNodeSshDriver

All Implemented Interfaces:

NaiveScriptRunner, SoftwareProcessDriver, EntityDriver, JavaSoftwareProcessDriver, CassandraNodeDriver
```
public class CassandraNodeSshDriver
extends JavaSoftwareProcessSshDriver
implements CassandraNodeDriver
```
Start a CassandraNode in a Location accessible over ssh.

Field Summary
- Fields inherited from class brooklyn.entity.java.JavaSoftwareProcessSshDriver
  KEY_VAL_OPT_PREFIXES, MUTUALLY_EXCLUSIVE_OPTS
- Fields inherited from class brooklyn.entity.basic.AbstractSoftwareProcessSshDriver
  CHECK_RUNNING, CUSTOMIZING, DEBUG, IGNORE_ENTITY_SSH_FLAGS, INSTALL_INCOMPLETE, INSTALLING, KILLING, LAUNCHING, logSsh, NON_STANDARD_LAYOUT, PID_FILENAME, PROCESS_OWNER, RESTARTING, STOPPING, USE_PID_FILE, VALID_FLAGS

Constructor Summary

Constructors
Constructor and Description

CassandraNodeSshDriver(CassandraNodeImpl entity, SshMachineLocation machine)

Constructors
Constructor and Description
`CassandraNodeSshDriver(CassandraNodeImpl entity, SshMachineLocation machine)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`customize()`
`ProcessTaskWrapper<java.lang.Integer>`	`executeScriptAsync(java.lang.String commands)`
`ProcessTaskWrapper<java.lang.Integer>`	`executeScriptFromInstalledFileAsync(java.lang.String fileToRun)`
`java.lang.String`	`getCassandraConfigFileName()`
`java.lang.String`	`getCassandraConfigTemplateUrl()`
`java.lang.String`	`getCassandraRackdcConfigFileName()`
`java.lang.String`	`getCassandraRackdcConfigTemplateUrl()`
`java.lang.String`	`getClusterName()`
`java.lang.String`	`getEndpointSnitchName()`
`java.lang.Integer`	`getGossipPort()`
`java.lang.String`	`getMirrorUrl()`
`java.lang.Integer`	`getNativeTransportPort()`
`java.lang.String`	`getPidFile()`
`java.util.Set<java.lang.Integer>`	`getPortsUsed()`
`java.lang.String`	`getResolvedAddress(java.lang.String hostname)` returns the address that the given hostname resolves to at the target
`java.util.Map<java.lang.String,java.lang.String>`	`getShellEnvironment()` Sets all JVM options (-X..
`java.lang.Integer`	`getSslGossipPort()`
`java.lang.Integer`	`getThriftPort()`
`void`	`install()`
`boolean`	`installJava()` Checks for Java 6 or 7, installing Java 7 if neither are found.
`boolean`	`isClustered()`
`boolean`	`isRunning()` Whether the entity components have started.
`void`	`launch()`
`void`	`preInstall()` Implement this method in child classes to add some pre-install behavior
`void`	`stop()` Performs software stop (or queues tasks to do this)

Methods inherited from class brooklyn.entity.java.JavaSoftwareProcessSshDriver
checkJavaHostnameBug, copyRuntimeResources, getJavaOpts, getJmxContext, getJmxPort, getRmiRegistryPort, installJmxSupport, isJmxEnabled, isJmxSslEnabled, setup

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessSshDriver
checkNoHostnameBug, copyInstallResources, copyResource, copyResource, execute, execute, execute, getAddress, getExpandedInstallDir, getHostname, getInstallDir, getLocation, getMachine, getRunDir, getSubnetAddress, getSubnetHostname, runPostInstallCommand, runPostLaunchCommand, runPreInstallCommand, runPreLaunchCommand, setExpandedInstallDir

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessDriver
copyPreInstallResources, copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyTemplate, copyTemplate, copyTemplate, getEntity, getResource, getResourceAsString, getVersion, kill, postLaunch, processTemplate, processTemplate, processTemplate, processTemplate, processTemplateContents, processTemplateContents, rebind, restart, start

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface brooklyn.entity.java.JavaSoftwareProcessDriver
isJmxEnabled

Methods inherited from interface brooklyn.entity.basic.SoftwareProcessDriver
getEntity, kill, rebind, restart, start

Methods inherited from interface brooklyn.entity.drivers.EntityDriver
getLocation

- Constructor Detail
  - CassandraNodeSshDriver
```
public CassandraNodeSshDriver(CassandraNodeImpl entity,
                      SshMachineLocation machine)
```
- Method Detail
  - getGossipPort
```
public java.lang.Integer getGossipPort()
```
    Specified by:
    
    getGossipPort in interface CassandraNodeDriver
  - getSslGossipPort
```
public java.lang.Integer getSslGossipPort()
```
    Specified by:
    
    getSslGossipPort in interface CassandraNodeDriver
  - getThriftPort
```
public java.lang.Integer getThriftPort()
```
    Specified by:
    
    getThriftPort in interface CassandraNodeDriver
  - getNativeTransportPort
```
public java.lang.Integer getNativeTransportPort()
```
    Specified by:
    
    getNativeTransportPort in interface CassandraNodeDriver
  - getClusterName
```
public java.lang.String getClusterName()
```
    Specified by:
    
    getClusterName in interface CassandraNodeDriver
  - getCassandraConfigTemplateUrl
```
public java.lang.String getCassandraConfigTemplateUrl()
```
    Specified by:
    
    getCassandraConfigTemplateUrl in interface CassandraNodeDriver
  - getCassandraConfigFileName
```
public java.lang.String getCassandraConfigFileName()
```
    Specified by:
    
    getCassandraConfigFileName in interface CassandraNodeDriver
  - getEndpointSnitchName
```
public java.lang.String getEndpointSnitchName()
```
  - getCassandraRackdcConfigTemplateUrl
```
public java.lang.String getCassandraRackdcConfigTemplateUrl()
```
  - getCassandraRackdcConfigFileName
```
public java.lang.String getCassandraRackdcConfigFileName()
```
  - getMirrorUrl
```
public java.lang.String getMirrorUrl()
```
  - installJava
```
public boolean installJava()
```
    Description copied from class: JavaSoftwareProcessSshDriver
    
    Checks for Java 6 or 7, installing Java 7 if neither are found. Override this method to check for and install specific versions of Java.
    
    Overrides:
    
    installJava in class JavaSoftwareProcessSshDriver
    
    See Also:
    JavaSoftwareProcessSshDriver.checkForAndInstallJava(String)
  - preInstall
```
public void preInstall()
```
    Description copied from class: AbstractSoftwareProcessDriver
    
    Implement this method in child classes to add some pre-install behavior
    
    Overrides:
    
    preInstall in class AbstractSoftwareProcessDriver
  - install
```
public void install()
```
    Specified by:
    
    install in class AbstractSoftwareProcessDriver
  - getPortsUsed
```
public java.util.Set<java.lang.Integer> getPortsUsed()
```
    Overrides:
    
    getPortsUsed in class AbstractSoftwareProcessSshDriver
  - customize
```
public void customize()
```
    Specified by:
    
    customize in class AbstractSoftwareProcessDriver
  - isClustered
```
public boolean isClustered()
```
    Specified by:
    
    isClustered in interface CassandraNodeDriver
  - launch
```
public void launch()
```
    Specified by:
    
    launch in class AbstractSoftwareProcessDriver
  - getPidFile
```
public java.lang.String getPidFile()
```
  - isRunning
```
public boolean isRunning()
```
    Description copied from interface: SoftwareProcessDriver
    
    Whether the entity components have started.
    
    Specified by:
    
    isRunning in interface SoftwareProcessDriver
  - stop
```
public void stop()
```
    Description copied from interface: SoftwareProcessDriver
    
    Performs software stop (or queues tasks to do this)
    
    Specified by:
    
    stop in interface SoftwareProcessDriver
    
    Specified by:
    
    stop in class AbstractSoftwareProcessDriver
    
    See Also:
    Startable.stop()
  - getShellEnvironment
```
public java.util.Map<java.lang.String,java.lang.String> getShellEnvironment()
```
    Description copied from class: JavaSoftwareProcessSshDriver
    
    Sets all JVM options (-X.. -D..) in an environment var JAVA_OPTS.
    That variable is constructed from JavaSoftwareProcessSshDriver.getJavaOpts(), then wrapped _unescaped_ in double quotes. An error is thrown if there is an unescaped double quote in the string. All other unescaped characters are permitted, but unless $var expansion or `command` execution is desired (although this is not confirmed as supported) the generally caller should escape any such characters, for example using StringEscapes.BashStringEscapes.escapeLiteralForDoubleQuotedBash(String).
    
    Overrides:
    
    getShellEnvironment in class JavaSoftwareProcessSshDriver
    
    See Also:
    SoftwareProcess.SHELL_ENVIRONMENT
  - executeScriptAsync
```
public ProcessTaskWrapper<java.lang.Integer> executeScriptAsync(java.lang.String commands)
```
    Specified by:
    
    executeScriptAsync in interface CassandraNodeDriver
  - executeScriptFromInstalledFileAsync
```
public ProcessTaskWrapper<java.lang.Integer> executeScriptFromInstalledFileAsync(java.lang.String fileToRun)
```
  - getResolvedAddress
```
public java.lang.String getResolvedAddress(java.lang.String hostname)
```
    Description copied from interface: CassandraNodeDriver
    
    returns the address that the given hostname resolves to at the target
    
    Specified by:
    
    getResolvedAddress in interface CassandraNodeDriver

Class CassandraNodeSshDriver

Field Summary

Fields inherited from class brooklyn.entity.java.JavaSoftwareProcessSshDriver

Fields inherited from class brooklyn.entity.basic.AbstractSoftwareProcessSshDriver

Constructor Summary

Method Summary

Methods inherited from class brooklyn.entity.java.JavaSoftwareProcessSshDriver

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessSshDriver

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessDriver

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.entity.java.JavaSoftwareProcessDriver

Methods inherited from interface brooklyn.entity.basic.SoftwareProcessDriver

Methods inherited from interface brooklyn.entity.drivers.EntityDriver

Constructor Detail

CassandraNodeSshDriver

Method Detail

getGossipPort

getSslGossipPort

getThriftPort

getNativeTransportPort

getClusterName

getCassandraConfigTemplateUrl

getCassandraConfigFileName

getEndpointSnitchName

getCassandraRackdcConfigTemplateUrl

getCassandraRackdcConfigFileName

getMirrorUrl

installJava

preInstall

install

getPortsUsed

customize

isClustered

launch

getPidFile

isRunning

stop

getShellEnvironment

executeScriptAsync

executeScriptFromInstalledFileAsync

getResolvedAddress