Overview  Package   Class  Deprecated  Index  Help 
Brooklyn
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

brooklyn.entity.basic
[Java] Class AbstractSoftwareProcessSshDriver

java.lang.Object
  brooklyn.entity.basic.AbstractSoftwareProcessDriver
      brooklyn.entity.basic.AbstractSoftwareProcessSshDriver
All Implemented Interfaces:
ScriptRunner
public abstract class AbstractSoftwareProcessSshDriver
extends AbstractSoftwareProcessDriver

An abstract SSH implementation of the AbstractSoftwareProcessDriver.

Field Summary
static java.lang.String BROOKLYN_HOME_DIR

protected static java.lang.String CHECK_RUNNING

protected static java.lang.String CUSTOMIZING

static java.lang.String DEFAULT_INSTALL_BASEDIR

static java.lang.String DEFAULT_RUN_BASEDIR

protected static java.lang.String INSTALLING

protected static java.lang.String KILLING

protected static java.lang.String LAUNCHING

static java.lang.String NO_VERSION_INFO

static java.lang.String PID_FILENAME

protected static java.lang.String RESTARTING

protected static java.lang.String STOPPING

static Logger log

static Logger logSsh

 
Fields inherited from class AbstractSoftwareProcessDriver
entity
 
Constructor Summary
AbstractSoftwareProcessSshDriver(EntityLocal entity, SshMachineLocation machine)

 
Method Summary
void copyFile(java.io.File src, java.lang.String destination)

void copyFile(java.io.File src, java.io.File destination)

int execute(java.util.List script, java.lang.String summaryForLogging)

int execute(java.util.Map flags2, java.util.List script, java.lang.String summaryForLogging)

protected java.lang.String getDefaultVersion()

deprecated:
will be deleted in 0.5.
protected java.lang.String getEntityVersionLabel()

protected java.lang.String getEntityVersionLabel(java.lang.String separator)

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 getPortsUsed()

java.lang.String getRunDir()

java.util.Map getShellEnvironment()

The environment variables to be set when executing the commands (for install, run, check running, etc).
protected java.lang.String getVersion()

protected ScriptHelper newScript(java.lang.String phase)

sets up a script for the given phase, including default wrapper commands (e.g.

protected ScriptHelper newScript(java.util.Map flags, java.lang.String phase)

 
Methods inherited from class AbstractSoftwareProcessDriver
customize, getEntity, getLocation, getResource, install, kill, launch, postLaunch, restart, start, stop, waitForConfigKey
 

Field Detail

BROOKLYN_HOME_DIR

public static final java.lang.String BROOKLYN_HOME_DIR

CHECK_RUNNING

protected static final java.lang.String CHECK_RUNNING

CUSTOMIZING

protected static final java.lang.String CUSTOMIZING

DEFAULT_INSTALL_BASEDIR

public static final java.lang.String DEFAULT_INSTALL_BASEDIR

DEFAULT_RUN_BASEDIR

public static final java.lang.String DEFAULT_RUN_BASEDIR

INSTALLING

protected static final java.lang.String INSTALLING

KILLING

protected static final java.lang.String KILLING

LAUNCHING

protected static final java.lang.String LAUNCHING

NO_VERSION_INFO

public static final java.lang.String NO_VERSION_INFO

PID_FILENAME

public static final java.lang.String PID_FILENAME

RESTARTING

protected static final java.lang.String RESTARTING

STOPPING

protected static final java.lang.String STOPPING

log

public static final Logger log

logSsh

public static final Logger logSsh

 
Constructor Detail

AbstractSoftwareProcessSshDriver

public AbstractSoftwareProcessSshDriver(EntityLocal entity, SshMachineLocation machine)

 
Method Detail

copyFile

public void copyFile(java.io.File src, java.lang.String destination)

copyFile

public void copyFile(java.io.File src, java.io.File destination)

execute

public int execute(java.util.List script, java.lang.String summaryForLogging)

execute

@Override
public int execute(java.util.Map flags2, java.util.List script, java.lang.String summaryForLogging)

getDefaultVersion

@Deprecated
protected java.lang.String getDefaultVersion()
deprecated:
will be deleted in 0.5. Set default on ConfigKey in entity? Rather than overriding it here and not telling the entity what value was chosen!

getEntityVersionLabel

protected java.lang.String getEntityVersionLabel()

getEntityVersionLabel

protected java.lang.String getEntityVersionLabel(java.lang.String separator)

getHostname

public java.lang.String getHostname()

getInstallDir

public java.lang.String getInstallDir()

getLocation

public SshMachineLocation getLocation()
returns location (tighten type, since we know it is an ssh machine location here)

getMachine

public SshMachineLocation getMachine()

getPortsUsed

public java.util.Set getPortsUsed()

getRunDir

public java.lang.String getRunDir()

getShellEnvironment

public java.util.Map getShellEnvironment()
The environment variables to be set when executing the commands (for install, run, check running, etc).

getVersion

protected java.lang.String getVersion()

newScript

protected ScriptHelper newScript(java.lang.String phase)
sets up a script for the given phase, including default wrapper commands (e.g. INSTALLING, LAUNCHING, etc)

flags supported include: - usePidFile: true, or a filename, meaning to create (for launching) that pid

Parameters:
phase
Returns:

newScript

protected ScriptHelper newScript(java.util.Map flags, java.lang.String phase)

 

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.