RabbitSshDriver (Apache Brooklyn)

java.lang.Object
- brooklyn.entity.basic.AbstractSoftwareProcessDriver
- - brooklyn.entity.basic.AbstractSoftwareProcessSshDriver
  - - brooklyn.entity.messaging.rabbit.RabbitSshDriver

All Implemented Interfaces:

NaiveScriptRunner, SoftwareProcessDriver, EntityDriver, RabbitDriver
```
public class RabbitSshDriver
extends AbstractSoftwareProcessSshDriver
implements RabbitDriver
```
TODO javadoc

Field Summary
- 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

RabbitSshDriver(RabbitBrokerImpl entity, SshMachineLocation machine)

Constructors
Constructor and Description
`RabbitSshDriver(RabbitBrokerImpl entity, SshMachineLocation machine)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`configure()`
`void`	`customize()`
`java.lang.Integer`	`getAmqpPort()`
`RabbitBrokerImpl`	`getEntity()` The entity whose components we are controlling.
`java.lang.String`	`getErlangVersion()`
`java.lang.String`	`getPidFile()`
`java.util.Map<java.lang.String,java.lang.String>`	`getShellEnvironment()` The environment variables to be set when executing the commands (for install, run, check running, etc).
`java.lang.String`	`getVirtualHost()`
`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 pre-install behavior
`void`	`stop()` Performs software stop (or queues tasks to do this)

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

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessDriver
copyPreInstallResources, copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyRuntimeResources, copyTemplate, copyTemplate, copyTemplate, getResource, getResourceAsString, getVersion, 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.messaging.rabbit.RabbitDriver
getRunDir

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

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

- Constructor Detail
  - RabbitSshDriver
```
public RabbitSshDriver(RabbitBrokerImpl entity,
               SshMachineLocation machine)
```
- Method Detail
  - getAmqpPort
```
public java.lang.Integer getAmqpPort()
```
  - getVirtualHost
```
public java.lang.String getVirtualHost()
```
  - getErlangVersion
```
public java.lang.String getErlangVersion()
```
  - getEntity
```
public RabbitBrokerImpl 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
  - 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
  - customize
```
public void customize()
```
    Specified by:
    
    customize in class AbstractSoftwareProcessDriver
  - launch
```
public void launch()
```
    Specified by:
    
    launch in class AbstractSoftwareProcessDriver
  - configure
```
public void configure()
```
    Specified by:
    
    configure in interface RabbitDriver
  - 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()
  - 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: AbstractSoftwareProcessSshDriver
    
    The environment variables to be set when executing the commands (for install, run, check running, etc).
    
    Specified by:
    
    getShellEnvironment in interface RabbitDriver
    
    Overrides:
    
    getShellEnvironment in class AbstractSoftwareProcessSshDriver
    
    See Also:
    SoftwareProcess.SHELL_ENVIRONMENT

Class RabbitSshDriver

Field Summary

Fields inherited from class brooklyn.entity.basic.AbstractSoftwareProcessSshDriver

Constructor Summary

Method Summary

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.messaging.rabbit.RabbitDriver

Methods inherited from interface brooklyn.entity.basic.SoftwareProcessDriver

Methods inherited from interface brooklyn.entity.drivers.EntityDriver

Constructor Detail

RabbitSshDriver

Method Detail

getAmqpPort

getVirtualHost

getErlangVersion

getEntity

preInstall

install

customize

launch

configure

getPidFile

isRunning

stop

kill

getShellEnvironment