NodeJsWebAppSshDriver (Apache Brooklyn)

java.lang.Object
- brooklyn.entity.basic.AbstractSoftwareProcessDriver
- - brooklyn.entity.basic.AbstractSoftwareProcessSshDriver
  - - brooklyn.entity.webapp.nodejs.NodeJsWebAppSshDriver

All Implemented Interfaces:: NaiveScriptRunner, SoftwareProcessDriver, EntityDriver, NodeJsWebAppDriver

public class NodeJsWebAppSshDriver
extends AbstractSoftwareProcessSshDriver
implements NodeJsWebAppDriver

Field Summary
- Fields inherited from class brooklyn.entity.basic.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)

Constructors
Constructor and Description
`NodeJsWebAppSshDriver(NodeJsWebAppServiceImpl entity, SshMachineLocation machine)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`customize()`
`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()`
`boolean`	`isRunning()` Whether the entity components have started.
`void`	`launch()`
`void`	`postLaunch()` Implement this method in child classes to add some post-launch behavior
`void`	`preInstall()` Implement this method in child classes to add some post-launch behavior
`void`	`stop()` Performs software stop (or queues tasks to do this)

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessDriver
getResource, getResourceAsString, kill, processTemplate, processTemplate, processTemplate, processTemplate, processTemplateContents, processTemplateContents, rebind, restart, start

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface brooklyn.entity.basic.SoftwareProcessDriver
kill, rebind, restart, start

Methods inherited from interface brooklyn.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 SoftwareProcessDriver
    
    Specified by:
    
    getEntity in interface EntityDriver
    
    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
    
    Overrides:
    
    postLaunch in class AbstractSoftwareProcessDriver
  - getPortsUsed
```
public java.util.Set<java.lang.Integer> getPortsUsed()
```
    Overrides:
    
    getPortsUsed in class AbstractSoftwareProcessSshDriver
  - preInstall
```
public void preInstall()
```
    Description copied from class: AbstractSoftwareProcessDriver
    
    Implement this method in child classes to add some post-launch behavior
    
    Overrides:
    
    preInstall in class AbstractSoftwareProcessDriver
  - install
```
public void install()
```
    Specified by:
    
    install in class AbstractSoftwareProcessDriver
  - customize
```
public void customize()
```
    Specified by:
    
    customize in class AbstractSoftwareProcessDriver
  - launch
```
public void launch()
```
    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: AbstractSoftwareProcessSshDriver
    
    The environment variables to be set when executing the commands (for install, run, check running, etc).
    
    Overrides:
    
    getShellEnvironment in class AbstractSoftwareProcessSshDriver
    
    See Also:
    SoftwareProcess.SHELL_ENVIRONMENT

Class NodeJsWebAppSshDriver

Field Summary

Fields inherited from class brooklyn.entity.basic.AbstractSoftwareProcessSshDriver

Constructor Summary

Method Summary

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessSshDriver

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessDriver

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.entity.basic.SoftwareProcessDriver

Methods inherited from interface brooklyn.entity.drivers.EntityDriver

Constructor Detail

NodeJsWebAppSshDriver

Method Detail

getEntity

getHttpPort

getAppDir

postLaunch

getPortsUsed

preInstall

install

customize

launch

isRunning

stop

getShellEnvironment