BrooklynNodeSshDriver (Apache Brooklyn)

java.lang.Object
- brooklyn.entity.basic.AbstractSoftwareProcessDriver
- - brooklyn.entity.basic.AbstractSoftwareProcessSshDriver
  - - brooklyn.entity.java.JavaSoftwareProcessSshDriver
    - - brooklyn.entity.brooklynnode.BrooklynNodeSshDriver

All Implemented Interfaces:

NaiveScriptRunner, SoftwareProcessDriver, BrooklynNodeDriver, EntityDriver, JavaSoftwareProcessDriver
```
public class BrooklynNodeSshDriver
extends JavaSoftwareProcessSshDriver
implements BrooklynNodeDriver
```

Field Summary
- Fields inherited from class brooklyn.entity.java.JavaSoftwareProcessSshDriver
  KEY_VAL_OPT_PREFIXES, log, 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

BrooklynNodeSshDriver(BrooklynNodeImpl entity, SshMachineLocation machine)

Constructors
Constructor and Description
`BrooklynNodeSshDriver(BrooklynNodeImpl entity, SshMachineLocation machine)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearInstallDir()`
`void`	`customize()`
`java.lang.String`	`getBrooklynHome()`
`BrooklynNodeImpl`	`getEntity()` The entity whose components we are controlling.
`java.util.Map<java.lang.String,java.lang.String>`	`getShellEnvironment()` Sets all JVM options (-X..
`void`	`install()`
`boolean`	`isRunning()` Whether the entity components have started.
`void`	`kill()` Kills the process, ungracefully and immediately where possible (e.g.
`void`	`launch()`
`void`	`preInstall()` Implement this method in child classes to add some post-launch 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, installJava, installJmxSupport, isJmxEnabled, isJmxSslEnabled, setup

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessDriver
getResource, getResourceAsString, 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
rebind, restart, start

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

- Constructor Detail
  - BrooklynNodeSshDriver
```
public BrooklynNodeSshDriver(BrooklynNodeImpl entity,
                     SshMachineLocation machine)
```
- Method Detail
  - getEntity
```
public BrooklynNodeImpl getEntity()
```
    Description copied from interface: SoftwareProcessDriver
    
    The entity whose components we are controlling.
    
    Specified by:
    
    getEntity in interface SoftwareProcessDriver
    
    Specified by:
    
    getEntity in interface EntityDriver
    
    Overrides:
    
    getEntity in class AbstractSoftwareProcessDriver
  - getBrooklynHome
```
public java.lang.String getBrooklynHome()
```
  - preInstall
```
public void preInstall()
```
    Description copied from class: AbstractSoftwareProcessDriver
    
    Implement this method in child classes to add some post-launch behavior
    
    Overrides:
    
    preInstall in class AbstractSoftwareProcessDriver
  - clearInstallDir
```
public void clearInstallDir()
```
    Specified by:
    
    clearInstallDir in interface BrooklynNodeDriver
  - install
```
public void install()
```
    Specified by:
    
    install in class AbstractSoftwareProcessDriver
  - customize
```
public void customize()
```
    Specified by:
    
    customize in class AbstractSoftwareProcessDriver
  - launch
```
public void launch()
```
    Specified by:
    
    launch in class AbstractSoftwareProcessDriver
  - 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()
  - kill
```
public void kill()
```
    Description copied from interface: SoftwareProcessDriver
    
    Kills the process, ungracefully and immediately where possible (e.g. with `kill -9`).
    
    Specified by:
    
    kill in interface SoftwareProcessDriver
    
    Overrides:
    
    kill in class AbstractSoftwareProcessDriver
  - 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

Class BrooklynNodeSshDriver

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

BrooklynNodeSshDriver

Method Detail

getEntity

getBrooklynHome

preInstall

clearInstallDir

install

customize

launch

isRunning

stop

kill

getShellEnvironment