org.apache.brooklyn.entity.brooklynnode

Class BrooklynNodeSshDriver

java.lang.Object

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

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

org.apache.brooklyn.entity.java.JavaSoftwareProcessSshDriver

org.apache.brooklyn.entity.brooklynnode.BrooklynNodeSshDriver

All Implemented Interfaces:

EntityDriver, BrooklynNodeDriver, JavaSoftwareProcessDriver, NaiveScriptRunner, SoftwareProcessDriver

public class BrooklynNodeSshDriver
extends JavaSoftwareProcessSshDriver
implements BrooklynNodeDriver

Field Summary

Fields inherited from class org.apache.brooklyn.entity.java.JavaSoftwareProcessSshDriver

KEY_VAL_OPT_PREFIXES, MUTUALLY_EXCLUSIVE_OPTS

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
BrooklynNodeSshDriver(BrooklynNodeImpl entity, SshMachineLocation machine)

Method Summary

Modifier and Type	Method and Description
void	clearInstallDir()
void	customize() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
java.lang.String	getArchiveNameFormat()
java.lang.String	getBrooklynHome()
BrooklynNodeImpl	getEntity() The entity whose components we are controlling.
java.util.Map<java.lang.String,java.lang.String>	getShellEnvironment() Sets all JVM options (-X..
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.java.JavaSoftwareProcessSshDriver

checkJavaHostnameBug, copyRuntimeResources, getJavaOpts, getJmxContext, getJmxPort, getRmiRegistryPort, installJava, installJmxSupport, isJmxEnabled, isJmxSslEnabled, setup

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

Methods inherited from class org.apache.brooklyn.entity.software.base.AbstractSoftwareProcessDriver

copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyTemplate, copyTemplate, copyTemplate, 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.java.JavaSoftwareProcessDriver

isJmxEnabled

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

BrooklynNodeSshDriver

public BrooklynNodeSshDriver(BrooklynNodeImpl entity,
                             SshMachineLocation machine)

Method Detail

getEntity

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

getBrooklynHome

public java.lang.String getBrooklynHome()

getArchiveNameFormat

public java.lang.String getArchiveNameFormat()

Overrides:

getArchiveNameFormat in class AbstractSoftwareProcessDriver

clearInstallDir

public void clearInstallDir()

Specified by:

clearInstallDir in interface BrooklynNodeDriver

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

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: JavaSoftwareProcessSshDriver

Sets all JVM options (-X.. -D..) in an environment var JAVA_OPTS.

That variable is constructed from JavaSoftwareProcessSshDriver.getJavaOpts(), then wrapped _unescaped_ in double quotes. An error is thrown if there is an unescaped double quote in the string. All other unescaped characters are permitted, but unless $var expansion or `command` execution is desired (although this is not confirmed as supported) the generally caller should escape any such characters, for example using StringEscapes.BashStringEscapes.escapeLiteralForDoubleQuotedBash(String).

Overrides:

getShellEnvironment in class JavaSoftwareProcessSshDriver

See Also:

SoftwareProcess.SHELL_ENVIRONMENT