org.apache.brooklyn.entity.software.base

Class EmptySoftwareProcessSshDriver

java.lang.Object

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

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

org.apache.brooklyn.entity.software.base.EmptySoftwareProcessSshDriver

All Implemented Interfaces:

EntityDriver, EmptySoftwareProcessDriver, NaiveScriptRunner, SoftwareProcessDriver

public class EmptySoftwareProcessSshDriver
extends AbstractSoftwareProcessSshDriver
implements EmptySoftwareProcessDriver

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
EmptySoftwareProcessSshDriver(EmptySoftwareProcessImpl entity, SshMachineLocation machine)

Method Summary

Modifier and Type	Method and Description
void	copyCustomizeResources() Files and templates to be copied to the server before customize.
void	copyInstallResources() Files and templates to be copied to the server before installation.
void	copyRuntimeResources() Files and templates to be copied to the server after customisation.
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	rebind() Rebinds the driver to a pre-existing software process.
void	stop() Performs software stop (or queues tasks to do this)

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

checkNoHostnameBug, 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, copyTemplate, copyTemplate, copyTemplate, getArchiveNameFormat, getEntity, getExpandedInstallDir, getInstallDir, getResource, getResourceAsString, getRunDir, getShellEnvironment, getVersion, kill, postLaunch, preInstall, processTemplate, processTemplate, processTemplate, processTemplate, processTemplateContents, processTemplateContents, 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, restart, start

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

getLocation

Constructor Detail

EmptySoftwareProcessSshDriver

public EmptySoftwareProcessSshDriver(EmptySoftwareProcessImpl entity,
                                     SshMachineLocation machine)

Method Detail

isRunning

public boolean isRunning()

Description copied from interface: SoftwareProcessDriver

Whether the entity components have started.

Specified by:

isRunning in interface SoftwareProcessDriver

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

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 AbstractSoftwareProcessSshDriver

See Also:

SoftwareProcess.INSTALL_FILES, SoftwareProcess.INSTALL_TEMPLATES, AbstractSoftwareProcessDriver.copyRuntimeResources()

copyCustomizeResources

public void copyCustomizeResources()

Description copied from class: AbstractSoftwareProcessDriver

Files and templates to be copied to the server before customize. This allows the AbstractSoftwareProcessDriver.customize() process to have access to all required resources.

Will be prefixed with the entity's install directory if relative.

Overrides:

copyCustomizeResources in class AbstractSoftwareProcessSshDriver

See Also:

SoftwareProcess.INSTALL_FILES, SoftwareProcess.INSTALL_TEMPLATES, AbstractSoftwareProcessDriver.copyRuntimeResources()

copyRuntimeResources

public void copyRuntimeResources()

Description copied from class: AbstractSoftwareProcessDriver

Files and templates to be copied to the server after customisation. This allows overwriting of existing files such as entity configuration which may be copied from the installation directory during the AbstractSoftwareProcessDriver.customize() process.

Will be prefixed with the entity's run directory if relative.

Overrides:

copyRuntimeResources in class AbstractSoftwareProcessDriver

See Also:

SoftwareProcess.RUNTIME_FILES, SoftwareProcess.RUNTIME_TEMPLATES, AbstractSoftwareProcessDriver.copyInstallResources()

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

rebind

public void rebind()

Description copied from interface: SoftwareProcessDriver

Rebinds the driver to a pre-existing software process.

Specified by:

rebind in interface SoftwareProcessDriver

Overrides:

rebind in class AbstractSoftwareProcessDriver

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