NginxSshDriver (Apache Brooklyn)

java.lang.Object
- brooklyn.entity.basic.AbstractSoftwareProcessDriver
- - brooklyn.entity.basic.AbstractSoftwareProcessSshDriver
  - - brooklyn.entity.proxy.nginx.NginxSshDriver

All Implemented Interfaces:

NaiveScriptRunner, SoftwareProcessDriver, EntityDriver, NginxDriver

Direct Known Subclasses:

SimulatedNginxControllerImpl.SimulatedNginxSshDriver
```
public class NginxSshDriver
extends AbstractSoftwareProcessSshDriver
implements NginxDriver
```
Start a NginxController in a Location accessible over ssh.

Field Summary

Fields
Modifier and Type Field and Description

static org.slf4j.Logger log

static java.lang.String NGINX_PID_FILE
- Fields inherited from class brooklyn.entity.basic.AbstractSoftwareProcessSshDriver
  CHECK_RUNNING, CUSTOMIZING, DEBUG, IGNORE_ENTITY_SSH_FLAGS, INSTALL_INCOMPLETE, INSTALLING, KILLING, LAUNCHING, logSsh, NON_STANDARD_LAYOUT, PID_FILENAME, PROCESS_OWNER, RESTARTING, STOPPING, USE_PID_FILE, VALID_FLAGS

Fields
Modifier and Type	Field and Description
`static org.slf4j.Logger`	`log`
`static java.lang.String`	`NGINX_PID_FILE`

Constructor Summary

Constructors
Constructor and Description

NginxSshDriver(NginxControllerImpl entity, SshMachineLocation machine)

Constructors
Constructor and Description
`NginxSshDriver(NginxControllerImpl entity, SshMachineLocation machine)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`customize()`
`java.lang.String`	`getAccessLogLocation()`
`NginxControllerImpl`	`getEntity()` The entity whose components we are controlling.
`java.lang.String`	`getErrorLogLocation()`
`java.lang.Integer`	`getHttpPort()`
`java.lang.String`	`getLogFileLocation()`
`java.lang.String`	`getPidFile()` By default Nginx writes the pid of the master process to `logs/nginx.pid`
`void`	`install()`
`boolean`	`isCustomizationCompleted()`
`boolean`	`isRunning()` Whether the entity components have started.
`void`	`kill()` Kills the process, ungracefully and immediately where possible (e.g.
`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`	`rebind()` Rebinds the driver to a pre-existing software process.
`void`	`reload()`
`void`	`stop()` Performs software stop (or queues tasks to do this)
`static java.lang.String`	`sudoBashCIfPrivilegedPort(int port, java.lang.String command)`
`static java.lang.String`	`sudoIfPrivilegedPort(int port, java.lang.String command)`

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

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

Methods inherited from interface brooklyn.entity.proxy.nginx.NginxDriver
getRunDir

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

Methods inherited from interface brooklyn.entity.drivers.EntityDriver
getLocation

- Field Detail
  - log
```
public static final org.slf4j.Logger log
```
  - NGINX_PID_FILE
```
public static final java.lang.String NGINX_PID_FILE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - NginxSshDriver
```
public NginxSshDriver(NginxControllerImpl entity,
              SshMachineLocation machine)
```
- Method Detail
  - getEntity
```
public NginxControllerImpl 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
  - getLogFileLocation
```
public java.lang.String getLogFileLocation()
```
  - getAccessLogLocation
```
public java.lang.String getAccessLogLocation()
```
  - getErrorLogLocation
```
public java.lang.String getErrorLogLocation()
```
  - getPidFile
```
public java.lang.String getPidFile()
```
    By default Nginx writes the pid of the master process to logs/nginx.pid
    
    Specified by:
    
    getPidFile in interface NginxDriver
  - getHttpPort
```
public java.lang.Integer getHttpPort()
```
  - 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
  - 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
  - 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
  - isCustomizationCompleted
```
public boolean isCustomizationCompleted()
```
    Specified by:
    
    isCustomizationCompleted in interface NginxDriver
  - launch
```
public void launch()
```
    Specified by:
    
    launch in class AbstractSoftwareProcessDriver
  - sudoIfPrivilegedPort
```
public static java.lang.String sudoIfPrivilegedPort(int port,
                                    java.lang.String command)
```
  - sudoBashCIfPrivilegedPort
```
public static java.lang.String sudoBashCIfPrivilegedPort(int port,
                                         java.lang.String command)
```
  - 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()
  - kill
```
public void kill()
```
    Description copied from interface: SoftwareProcessDriver
    
    Kills the process, ungracefully and immediately where possible (e.g. with `kill -9`).
    
    Specified by:
    
    kill in interface SoftwareProcessDriver
    
    Overrides:
    
    kill in class AbstractSoftwareProcessDriver
  - reload
```
public void reload()
```

Class NginxSshDriver

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.proxy.nginx.NginxDriver

Methods inherited from interface brooklyn.entity.basic.SoftwareProcessDriver

Methods inherited from interface brooklyn.entity.drivers.EntityDriver

Field Detail

log

NGINX_PID_FILE

Constructor Detail

NginxSshDriver

Method Detail

getEntity

getLogFileLocation

getAccessLogLocation

getErrorLogLocation

getPidFile

getHttpPort

rebind

postLaunch

preInstall

install

customize

isCustomizationCompleted

launch

sudoIfPrivilegedPort

sudoBashCIfPrivilegedPort

isRunning

stop

kill

reload