org.apache.brooklyn.entity.messaging.rabbit

Class RabbitSshDriver

java.lang.Object

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

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

org.apache.brooklyn.entity.messaging.rabbit.RabbitSshDriver

All Implemented Interfaces:

EntityDriver, RabbitDriver, NaiveScriptRunner, SoftwareProcessDriver

public class RabbitSshDriver
extends AbstractSoftwareProcessSshDriver
implements RabbitDriver

TODO javadoc

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
RabbitSshDriver(RabbitBrokerImpl entity, SshMachineLocation machine)

Method Summary

Modifier and Type	Method and Description
void	configure()
void	customize() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
java.lang.Integer	getAmqpPort()
RabbitBrokerImpl	getEntity() The entity whose components we are controlling.
java.lang.String	getErlangVersion()
java.lang.String	getPidFile()
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).
java.lang.String	getVirtualHost()
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	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	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, 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, getVersion, postLaunch, 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.messaging.rabbit.RabbitDriver

getRunDir

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

rebind, restart, start

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

getLocation

Constructor Detail

RabbitSshDriver

public RabbitSshDriver(RabbitBrokerImpl entity,
                       SshMachineLocation machine)

Method Detail

getAmqpPort

public java.lang.Integer getAmqpPort()

getVirtualHost

public java.lang.String getVirtualHost()

getErlangVersion

public java.lang.String getErlangVersion()

getEntity

public RabbitBrokerImpl 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

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

configure

public void configure()

Specified by:

configure in interface RabbitDriver

getPidFile

public java.lang.String getPidFile()

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

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

Specified by:

getShellEnvironment in interface RabbitDriver

Overrides:

getShellEnvironment in class AbstractSoftwareProcessDriver

See Also:

SoftwareProcess.SHELL_ENVIRONMENT