org.apache.brooklyn.entity.webapp.nodejs

Class NodeJsWebAppSshDriver

java.lang.Object

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

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

org.apache.brooklyn.entity.webapp.nodejs.NodeJsWebAppSshDriver

All Implemented Interfaces:

EntityDriver, NaiveScriptRunner, SoftwareProcessDriver, NodeJsWebAppDriver

public class NodeJsWebAppSshDriver
extends AbstractSoftwareProcessSshDriver
implements NodeJsWebAppDriver

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
NodeJsWebAppSshDriver(NodeJsWebAppServiceImpl 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	getAppDir()
NodeJsWebAppServiceImpl	getEntity() The entity whose components we are controlling.
java.lang.Integer	getHttpPort()
java.util.Set<java.lang.Integer>	getPortsUsed()
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	postLaunch() Implement this method in child classes to add some post-launch behavior.
void	prepare() Prepare the entity instance before running any commands.
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, getSubnetAddress, getSubnetHostname, 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, getExpandedInstallDir, getInstallDir, getResource, getResourceAsString, getRunDir, getVersion, kill, 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

kill, rebind, restart, start

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

getLocation

Constructor Detail

NodeJsWebAppSshDriver

public NodeJsWebAppSshDriver(NodeJsWebAppServiceImpl entity,
                             SshMachineLocation machine)

Method Detail

getEntity

public NodeJsWebAppServiceImpl getEntity()

Description copied from interface: SoftwareProcessDriver

The entity whose components we are controlling.

Specified by:

getEntity in interface EntityDriver

Specified by:

getEntity in interface SoftwareProcessDriver

Overrides:

getEntity in class AbstractSoftwareProcessDriver

getHttpPort

public java.lang.Integer getHttpPort()

Specified by:

getHttpPort in interface NodeJsWebAppDriver

getAppDir

public java.lang.String getAppDir()

Specified by:

getAppDir in interface NodeJsWebAppDriver

postLaunch

public void postLaunch()

Description copied from class: AbstractSoftwareProcessDriver

Implement this method in child classes to add some post-launch behavior. This is run even if start is skipped and launch is not run.

Overrides:

postLaunch in class AbstractSoftwareProcessDriver

getPortsUsed

public java.util.Set<java.lang.Integer> getPortsUsed()

Overrides:

getPortsUsed in class AbstractSoftwareProcessSshDriver

prepare

public void prepare()

Description copied from class: AbstractSoftwareProcessDriver

Prepare the entity instance before running any commands. Always executed during AbstractSoftwareProcessDriver.start().

Overrides:

prepare in class AbstractSoftwareProcessSshDriver

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

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

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