org.apache.brooklyn.entity.cm.salt

Class SaltEntitySshDriver

java.lang.Object

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

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

org.apache.brooklyn.entity.cm.salt.SaltEntitySshDriver

All Implemented Interfaces:

EntityDriver, SaltEntityDriver, NaiveScriptRunner, SoftwareProcessDriver

public class SaltEntitySshDriver
extends AbstractSoftwareProcessSshDriver
implements SaltEntityDriver

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
SaltEntitySshDriver(SaltEntityImpl 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.
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	restart() Performs software restart (or queues tasks to do this).
void	runPostLaunchCommand() Only run if launch is run (if start is not skipped).
ProcessTaskWrapper<java.lang.Integer>	saltCall(java.lang.String spec)
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, 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, getShellEnvironment, getVersion, kill, postLaunch, preInstall, processTemplate, processTemplate, processTemplate, processTemplate, processTemplateContents, processTemplateContents, rebind, 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, start

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

getLocation

Constructor Detail

SaltEntitySshDriver

public SaltEntitySshDriver(SaltEntityImpl 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

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

runPostLaunchCommand

public void runPostLaunchCommand()

Description copied from class: AbstractSoftwareProcessDriver

Only run if launch is run (if start is not skipped). Implementations should fail if the return code is non-zero, by throwing some appropriate exception.

Overrides:

runPostLaunchCommand in class AbstractSoftwareProcessSshDriver

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

restart

public void restart()

Description copied from interface: SoftwareProcessDriver

Performs software restart (or queues tasks to do this). Unlike stop/start implementations here are expected to update SERVICE_STATE for STOPPING and STARTING as appropriate (but framework will set RUNNING afterwards, after detecting it is running).

Specified by:

restart in interface SoftwareProcessDriver

Overrides:

restart in class AbstractSoftwareProcessDriver

See Also:

Startable.restart()

saltCall

public ProcessTaskWrapper<java.lang.Integer> saltCall(java.lang.String spec)

Specified by:

saltCall in interface SaltEntityDriver