org.apache.brooklyn.entity.software.base

Class VanillaSoftwareProcessSshDriver

java.lang.Object

org.apache.brooklyn.entity.software.base.AbstractSoftwareProcessDriver

org.apache.brooklyn.entity.software.base.AbstractSoftwareProcessSshDriver

org.apache.brooklyn.entity.software.base.VanillaSoftwareProcessSshDriver

All Implemented Interfaces:

EntityDriver, NaiveScriptRunner, SoftwareProcessDriver, VanillaSoftwareProcessDriver

Direct Known Subclasses:

SimulatedVanillaSoftwareProcessImpl.SimulatedVanillaSoftwareProcessSshDriver

public class VanillaSoftwareProcessSshDriver
extends AbstractSoftwareProcessSshDriver
implements VanillaSoftwareProcessDriver

Field Summary

Fields inherited from class org.apache.brooklyn.entity.software.base.AbstractSoftwareProcessSshDriver

CHECK_RUNNING, CUSTOMIZING, DEBUG, IGNORE_ENTITY_SSH_FLAGS, INSTALL_INCOMPLETE, INSTALLING, KILLING, LAUNCHING, log, logSsh, NON_STANDARD_LAYOUT, PID_FILENAME, PROCESS_OWNER, RESTARTING, STOPPING, USE_PID_FILE, VALID_FLAGS

Constructor Summary

Constructors

Constructor and Description
VanillaSoftwareProcessSshDriver(EntityLocal entity, SshMachineLocation machine)

Method Summary

Modifier and Type	Method and Description
void	customize() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
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).
void	install() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
boolean	isRunning() Whether the entity components have started.
void	launch() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
void	stop() Performs software stop (or queues tasks to do this)

Methods inherited from class org.apache.brooklyn.entity.software.base.AbstractSoftwareProcessSshDriver

checkNoHostnameBug, copyCustomizeResources, copyInstallResources, copyPreInstallResources, copyResource, copyResource, execute, execute, execute, getAddress, getHostname, getLocation, getMachine, getPortsUsed, getSubnetAddress, getSubnetHostname, prepare, runPostCustomizeCommand, runPostInstallCommand, runPostLaunchCommand, runPreCustomizeCommand, runPreInstallCommand, runPreLaunchCommand, setup

Methods inherited from class org.apache.brooklyn.entity.software.base.AbstractSoftwareProcessDriver

copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyRuntimeResources, copyTemplate, copyTemplate, copyTemplate, getArchiveNameFormat, getEntity, getExpandedInstallDir, getInstallDir, getResource, getResourceAsString, getRunDir, getVersion, kill, postLaunch, preInstall, processTemplate, processTemplate, processTemplate, processTemplate, processTemplateContents, processTemplateContents, rebind, restart, setExpandedInstallDir, start

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcessDriver

getEntity, kill, rebind, restart, start

Methods inherited from interface org.apache.brooklyn.api.entity.drivers.EntityDriver

getLocation

Constructor Detail

VanillaSoftwareProcessSshDriver

public VanillaSoftwareProcessSshDriver(EntityLocal entity,
                                       SshMachineLocation machine)

Method Detail

install

public void install()

Description copied from class: AbstractSoftwareProcessDriver

Implementations should fail if the return code is non-zero, by throwing some appropriate exception.

Specified by:

install in class AbstractSoftwareProcessDriver

customize

public void customize()

Description copied from class: AbstractSoftwareProcessDriver

Implementations should fail if the return code is non-zero, by throwing some appropriate exception.

Specified by:

customize in class AbstractSoftwareProcessDriver

getShellEnvironment

public java.util.Map<java.lang.String,java.lang.String> getShellEnvironment()

Description copied from class: AbstractSoftwareProcessDriver

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

Overrides:

getShellEnvironment in class AbstractSoftwareProcessDriver

See Also:

SoftwareProcess.SHELL_ENVIRONMENT

getPidFile

public java.lang.String getPidFile()

launch

public void launch()

Description copied from class: AbstractSoftwareProcessDriver

Implementations should fail if the return code is non-zero, by throwing some appropriate exception.

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