AbstractSoftwareProcessSshDriver (Apache Brooklyn)

java.lang.Object
- brooklyn.entity.basic.AbstractSoftwareProcessDriver
- - brooklyn.entity.basic.AbstractSoftwareProcessSshDriver

All Implemented Interfaces:

NaiveScriptRunner, SoftwareProcessDriver, EntityDriver

Direct Known Subclasses:

AbstractMongoDBSshDriver, BindDnsServerSshDriver, ChefSoloDriver, CouchbaseNodeSshDriver, CouchbaseSyncGatewaySshDriver, CouchDBNodeSshDriver, ElasticSearchNodeSshDriver, EmptySoftwareProcessSshDriver, JavaSoftwareProcessSshDriver, MariaDbSshDriver, MonitSshDriver, MySqlSshDriver, NginxSshDriver, NodeJsWebAppSshDriver, PostgreSqlSshDriver, RabbitSshDriver, RedisStoreSshDriver, RiakNodeSshDriver, RubyRepSshDriver, VanillaSoftwareProcessSshDriver
```
public abstract class AbstractSoftwareProcessSshDriver
extends AbstractSoftwareProcessDriver
implements NaiveScriptRunner
```
An abstract SSH implementation of the AbstractSoftwareProcessDriver. This provides conveniences for clients implementing the install/customize/launch/isRunning/stop lifecycle over SSH. These conveniences include checking whether software is already installed, creating/using a PID file for some operations, and reading ssh-specific config from the entity to override/augment ssh flags on the session.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CHECK_RUNNING`
`static java.lang.String`	`CUSTOMIZING`
`static java.lang.String`	`DEBUG` Enable shell debugging output via `set -x` prepended to the command header.
`static java.lang.String`	`IGNORE_ENTITY_SSH_FLAGS` include this flag in newScript creation to prevent entity-level flags from being included; any SSH-specific flags passed to newScript override flags from the entity, and flags from the entity override flags on the location (where there aren't conflicts, flags from all three are used however)
`static java.lang.String`	`INSTALL_INCOMPLETE` Prevents creation of the `$INSTALL_DIR/BROOKLYN` marker file after installing phase finishes, to allow further installation phases to execute.
`static java.lang.String`	`INSTALLING`
`static java.lang.String`	`KILLING`
`static java.lang.String`	`LAUNCHING`
`static org.slf4j.Logger`	`log`
`static org.slf4j.Logger`	`logSsh`
`static java.lang.String`	`NON_STANDARD_LAYOUT` Marks the script as having a customised setup, to prevent the default headers and footers being added to the list of commands.
`static java.lang.String`	`PID_FILENAME`
`static java.lang.String`	`PROCESS_OWNER` Define the process owner if not the same as the brooklyn user.
`static java.lang.String`	`RESTARTING`
`static java.lang.String`	`STOPPING`
`static java.lang.String`	`USE_PID_FILE` Use a PID file, created by launching, and reading it for check-running, stopping and killing.
`static java.util.List<java.lang.String>`	`VALID_FLAGS` Permitted flags for `newScript(Map, String)`.

Constructor Summary

Constructors
Constructor and Description

AbstractSoftwareProcessSshDriver(EntityLocal entity, SshMachineLocation machine)

Constructors
Constructor and Description
`AbstractSoftwareProcessSshDriver(EntityLocal entity, SshMachineLocation machine)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`checkNoHostnameBug()`
`void`	`copyInstallResources()` Files and templates to be copied to the server before installation.
`int`	`copyResource(java.util.Map<java.lang.Object,java.lang.Object> sshFlags, java.io.InputStream source, java.lang.String target, boolean createParentDir)` Input stream will be closed automatically.
`int`	`copyResource(java.util.Map<java.lang.Object,java.lang.Object> sshFlags, java.lang.String source, java.lang.String target, boolean createParentDir)`
`int`	`execute(java.util.List<java.lang.String> script, java.lang.String summaryForLogging)` Runs a script and returns the result code
`int`	`execute(java.util.Map flags2, java.util.List<java.lang.String> script, java.lang.String summaryForLogging)` Runs a script and returns the result code, supporting flags including: out, err as output/error streams; logPrefix, prefix string to put in log output; env, map of environment vars to pass to shell environment
`int`	`execute(java.lang.String command, java.lang.String summaryForLogging)`
`java.lang.String`	`getAddress()`
`java.lang.String`	`getExpandedInstallDir()`
`java.lang.String`	`getHostname()`
`java.lang.String`	`getInstallDir()`
`SshMachineLocation`	`getLocation()` returns location (tighten type, since we know it is an ssh machine location here)
`SshMachineLocation`	`getMachine()`
`java.util.Set<java.lang.Integer>`	`getPortsUsed()`
`java.lang.String`	`getRunDir()`
`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`	`getSubnetAddress()`
`java.lang.String`	`getSubnetHostname()`
`void`	`runPostInstallCommand(java.lang.String command)`
`void`	`runPostLaunchCommand(java.lang.String command)`
`void`	`runPreInstallCommand(java.lang.String command)`
`void`	`runPreLaunchCommand(java.lang.String command)`
`void`	`setExpandedInstallDir(java.lang.String val)`
`void`	`setup()`

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

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

Methods inherited from interface brooklyn.entity.basic.SoftwareProcessDriver
isRunning

- Field Detail
  - log
```
public static final org.slf4j.Logger log
```
  - logSsh
```
public static final org.slf4j.Logger logSsh
```
  - IGNORE_ENTITY_SSH_FLAGS
```
public static final java.lang.String IGNORE_ENTITY_SSH_FLAGS
```
    include this flag in newScript creation to prevent entity-level flags from being included; any SSH-specific flags passed to newScript override flags from the entity, and flags from the entity override flags on the location (where there aren't conflicts, flags from all three are used however)
  - INSTALLING
```
public static final java.lang.String INSTALLING
```
    See Also:
    Constant Field Values
  - CUSTOMIZING
```
public static final java.lang.String CUSTOMIZING
```
    See Also:
    Constant Field Values
  - LAUNCHING
```
public static final java.lang.String LAUNCHING
```
    See Also:
    Constant Field Values
  - CHECK_RUNNING
```
public static final java.lang.String CHECK_RUNNING
```
    See Also:
    Constant Field Values
  - STOPPING
```
public static final java.lang.String STOPPING
```
    See Also:
    Constant Field Values
  - KILLING
```
public static final java.lang.String KILLING
```
    See Also:
    Constant Field Values
  - RESTARTING
```
public static final java.lang.String RESTARTING
```
    See Also:
    Constant Field Values
  - PID_FILENAME
```
public static final java.lang.String PID_FILENAME
```
    See Also:
    Constant Field Values
  - USE_PID_FILE
```
public static final java.lang.String USE_PID_FILE
```
    Use a PID file, created by launching, and reading it for check-running, stopping and killing. The value can be true or a path to a file to use; either relative to RUN_DIR or an absolute path.
    
    See Also:
    Constant Field Values
  - PROCESS_OWNER
```
public static final java.lang.String PROCESS_OWNER
```
    Define the process owner if not the same as the brooklyn user. Both stopping and killing will sudo to this user before issuing the kill command. Only valid if USE_PID_FILE is also set.
    
    See Also:
    Constant Field Values
  - NON_STANDARD_LAYOUT
```
public static final java.lang.String NON_STANDARD_LAYOUT
```
    Marks the script as having a customised setup, to prevent the default headers and footers being added to the list of commands.
    
    See Also:
    Constant Field Values
  - INSTALL_INCOMPLETE
```
public static final java.lang.String INSTALL_INCOMPLETE
```
    Prevents creation of the $INSTALL_DIR/BROOKLYN marker file after installing phase finishes, to allow further installation phases to execute.
    
    See Also:
    Constant Field Values
  - DEBUG
```
public static final java.lang.String DEBUG
```
    Enable shell debugging output via set -x prepended to the command header.
    
    See Also:
    Constant Field Values
  - VALID_FLAGS
```
public static final java.util.List<java.lang.String> VALID_FLAGS
```
    Permitted flags for newScript(Map, String).
- Constructor Detail
  - AbstractSoftwareProcessSshDriver
```
public AbstractSoftwareProcessSshDriver(EntityLocal entity,
                                SshMachineLocation machine)
```
- Method Detail
  - getLocation
```
public SshMachineLocation getLocation()
```
    returns location (tighten type, since we know it is an ssh machine location here)
    
    Specified by:
    
    getLocation in interface EntityDriver
    
    Overrides:
    
    getLocation in class AbstractSoftwareProcessDriver
  - getInstallDir
```
public java.lang.String getInstallDir()
```
    Specified by:
    
    getInstallDir in class AbstractSoftwareProcessDriver
  - getRunDir
```
public java.lang.String getRunDir()
```
    Specified by:
    
    getRunDir in class AbstractSoftwareProcessDriver
  - setExpandedInstallDir
```
public void setExpandedInstallDir(java.lang.String val)
```
  - getExpandedInstallDir
```
public java.lang.String getExpandedInstallDir()
```
  - getMachine
```
public SshMachineLocation getMachine()
```
  - getHostname
```
public java.lang.String getHostname()
```
  - getAddress
```
public java.lang.String getAddress()
```
  - getSubnetHostname
```
public java.lang.String getSubnetHostname()
```
  - getSubnetAddress
```
public java.lang.String getSubnetAddress()
```
  - execute
```
public int execute(java.lang.String command,
          java.lang.String summaryForLogging)
```
  - execute
```
public int execute(java.util.List<java.lang.String> script,
          java.lang.String summaryForLogging)
```
    Description copied from interface: NaiveScriptRunner
    
    Runs a script and returns the result code
    
    Specified by:
    
    execute in interface NaiveScriptRunner
  - execute
```
public int execute(java.util.Map flags2,
          java.util.List<java.lang.String> script,
          java.lang.String summaryForLogging)
```
    Description copied from interface: NaiveScriptRunner
    
    Runs a script and returns the result code, supporting flags including: out, err as output/error streams; logPrefix, prefix string to put in log output; env, map of environment vars to pass to shell environment
    
    Specified by:
    
    execute in interface NaiveScriptRunner
  - copyInstallResources
```
public void copyInstallResources()
```
    Description copied from class: AbstractSoftwareProcessDriver
    
    Files and templates to be copied to the server before installation. This allows the AbstractSoftwareProcessDriver.install() process to have access to all required resources.
    Will be prefixed with the entity's install directory if relative.
    
    Overrides:
    
    copyInstallResources in class AbstractSoftwareProcessDriver
    
    See Also:
    SoftwareProcess.INSTALL_FILES, SoftwareProcess.INSTALL_TEMPLATES, AbstractSoftwareProcessDriver.copyRuntimeResources()
  - runPreInstallCommand
```
public void runPreInstallCommand(java.lang.String command)
```
    Specified by:
    
    runPreInstallCommand in class AbstractSoftwareProcessDriver
  - runPostInstallCommand
```
public void runPostInstallCommand(java.lang.String command)
```
    Specified by:
    
    runPostInstallCommand in class AbstractSoftwareProcessDriver
  - runPreLaunchCommand
```
public void runPreLaunchCommand(java.lang.String command)
```
    Specified by:
    
    runPreLaunchCommand in class AbstractSoftwareProcessDriver
  - runPostLaunchCommand
```
public void runPostLaunchCommand(java.lang.String command)
```
    Specified by:
    
    runPostLaunchCommand in class AbstractSoftwareProcessDriver
  - getShellEnvironment
```
public 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).
    
    See Also:
    SoftwareProcess.SHELL_ENVIRONMENT
  - copyResource
```
public int copyResource(java.util.Map<java.lang.Object,java.lang.Object> sshFlags,
               java.lang.String source,
               java.lang.String target,
               boolean createParentDir)
```
    Specified by:
    
    copyResource in class AbstractSoftwareProcessDriver
    
    Parameters:
    sshFlags - Extra flags to be used when making an SSH connection to the entity's machine. If the map contains the key IGNORE_ENTITY_SSH_FLAGS then only the given flags are used. Otherwise, the given flags are combined with (and take precendence over) the flags returned by getSshFlags().
    source - URI of file to copy, e.g. file://.., http://.., classpath://..
    target - Destination on server, relative to getRunDir() if not absolute path
    createParentDir - Whether to create the parent target directory, if it doesn't already exist
    
    Returns:
    The exit code of the SSH command run
  - copyResource
```
public int copyResource(java.util.Map<java.lang.Object,java.lang.Object> sshFlags,
               java.io.InputStream source,
               java.lang.String target,
               boolean createParentDir)
```
    Input stream will be closed automatically.
    If using SshjTool usage, consider using KnownSizeInputStream to avoid having to write out stream once to find its size!
    
    Specified by:
    
    copyResource in class AbstractSoftwareProcessDriver
    
    See Also:
    for parameter descriptions.
  - checkNoHostnameBug
```
public void checkNoHostnameBug()
```
  - getPortsUsed
```
public java.util.Set<java.lang.Integer> getPortsUsed()
```
  - setup
```
public void setup()
```
    Specified by:
    
    setup in class AbstractSoftwareProcessDriver

Class AbstractSoftwareProcessSshDriver

Field Summary

Constructor Summary

Method Summary

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessDriver

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.entity.basic.SoftwareProcessDriver

Field Detail

log

logSsh

IGNORE_ENTITY_SSH_FLAGS

INSTALLING

CUSTOMIZING

LAUNCHING

CHECK_RUNNING

STOPPING

KILLING

RESTARTING

PID_FILENAME

USE_PID_FILE

PROCESS_OWNER

NON_STANDARD_LAYOUT

INSTALL_INCOMPLETE

DEBUG

VALID_FLAGS

Constructor Detail

AbstractSoftwareProcessSshDriver

Method Detail

getLocation

getInstallDir

getRunDir

setExpandedInstallDir

getExpandedInstallDir

getMachine

getHostname

getAddress

getSubnetHostname

getSubnetAddress

execute

execute

execute

copyInstallResources

runPreInstallCommand

runPostInstallCommand

runPreLaunchCommand

runPostLaunchCommand

getShellEnvironment

copyResource

copyResource

checkNoHostnameBug

getPortsUsed

setup