org.apache.brooklyn.entity.proxy.nginx

Class NginxSshDriver

java.lang.Object

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

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

org.apache.brooklyn.entity.proxy.nginx.NginxSshDriver

All Implemented Interfaces:

EntityDriver, NginxDriver, NaiveScriptRunner, SoftwareProcessDriver

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 org.apache.brooklyn.entity.software.base.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

Constructor Summary

Constructors

Constructor and Description
NginxSshDriver(NginxControllerImpl 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	getAccessLogLocation()
NginxControllerImpl	getEntity() The entity whose components we are controlling.
java.lang.String	getErrorLogLocation()
java.lang.Integer	getHttpPort() Deprecated.
java.lang.String	getLogFileLocation()
java.lang.String	getPidFile() By default Nginx writes the pid of the master process to logs/nginx.pid
java.lang.Integer	getPort()
void	install() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
boolean	isCustomizationCompleted()
boolean	isRunning() Whether the entity components have started.
void	kill() Kills the process, ungracefully and immediately where possible (e.g.
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	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 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, 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, getShellEnvironment, getVersion, 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.proxy.nginx.NginxDriver

getRunDir

Methods inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcessDriver

restart, start

Methods inherited from interface org.apache.brooklyn.api.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 EntityDriver

Specified by:

getEntity in interface SoftwareProcessDriver

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

@Deprecated
public java.lang.Integer getHttpPort()

Deprecated.

getPort

public java.lang.Integer getPort()

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. This is run even if start is skipped and launch is not run.

Overrides:

postLaunch in class AbstractSoftwareProcessDriver

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

isCustomizationCompleted

public boolean isCustomizationCompleted()

Specified by:

isCustomizationCompleted in interface NginxDriver

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

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