org.apache.brooklyn.entity.java

Class JavaSoftwareProcessSshDriver

java.lang.Object

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

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

org.apache.brooklyn.entity.java.JavaSoftwareProcessSshDriver

All Implemented Interfaces:

EntityDriver, JavaSoftwareProcessDriver, NaiveScriptRunner, SoftwareProcessDriver

Direct Known Subclasses:

AbstractfKafkaSshDriver, ActiveMQSshDriver, BrooklynNodeSshDriver, CassandraNodeSshDriver, CrateNodeSshDriver, DerbyDatabaseSshDriver, ElasticSearchNodeSshDriver, HazelcastNodeSshDriver, Infinispan5SshDriver, JavaWebAppSshDriver, KarafSshDriver, QpidSshDriver, RiakNodeSshDriver, SolrServerSshDriver, StormSshDriver, VanillaJavaAppSshDriver, ZooKeeperSshDriver

public abstract class JavaSoftwareProcessSshDriver
extends AbstractSoftwareProcessSshDriver
implements JavaSoftwareProcessDriver

The SSH implementation of the JavaSoftwareProcessDriver.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<java.lang.String>	KEY_VAL_OPT_PREFIXES
static org.slf4j.Logger	log
static java.util.List<java.util.List<java.lang.String>>	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
JavaSoftwareProcessSshDriver(EntityLocal entity, SshMachineLocation machine)

Method Summary

Modifier and Type	Method and Description
void	checkJavaHostnameBug()
void	copyRuntimeResources() Files and templates to be copied to the server after customisation.
java.util.List<java.lang.String>	getJavaOpts() arguments to pass to the JVM; this is the config options (e.g.
java.lang.String	getJmxContext() Deprecated. since 0.6.0, the config key is always used instead of this
java.lang.Integer	getJmxPort() Deprecated. since 0.6.0, the config key is always used instead of this
java.lang.Integer	getRmiRegistryPort() Deprecated. since 0.6.0, the config key is always used instead of this
java.util.Map<java.lang.String,java.lang.String>	getShellEnvironment() Sets all JVM options (-X..
boolean	installJava() Checks for Java 6 or 7, installing Java 7 if neither are found.
void	installJmxSupport()
boolean	isJmxEnabled()
boolean	isJmxSslEnabled()
void	setup() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.

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, customize, getArchiveNameFormat, getEntity, getExpandedInstallDir, getInstallDir, getResource, getResourceAsString, getRunDir, getVersion, install, kill, launch, postLaunch, preInstall, processTemplate, processTemplate, processTemplate, processTemplate, processTemplateContents, processTemplateContents, rebind, restart, setExpandedInstallDir, start, stop

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getEntity, isRunning, kill, rebind, restart, start, stop

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

getLocation

Field Detail

log

public static final org.slf4j.Logger log

MUTUALLY_EXCLUSIVE_OPTS

public static final java.util.List<java.util.List<java.lang.String>> MUTUALLY_EXCLUSIVE_OPTS

KEY_VAL_OPT_PREFIXES

public static final java.util.List<java.lang.String> KEY_VAL_OPT_PREFIXES

Constructor Detail

JavaSoftwareProcessSshDriver

public JavaSoftwareProcessSshDriver(EntityLocal entity,
                                    SshMachineLocation machine)

Method Detail

isJmxEnabled

public boolean isJmxEnabled()

Specified by:

isJmxEnabled in interface JavaSoftwareProcessDriver

isJmxSslEnabled

public boolean isJmxSslEnabled()

getShellEnvironment

public java.util.Map<java.lang.String,java.lang.String> getShellEnvironment()

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

That variable is constructed from 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 AbstractSoftwareProcessDriver

See Also:

SoftwareProcess.SHELL_ENVIRONMENT

getJavaOpts

public java.util.List<java.lang.String> getJavaOpts()

arguments to pass to the JVM; this is the config options (e.g. -Xmx1024; only the contents of getCustomJavaConfigOptions() by default) and java system properties (-Dk=v; add custom properties in getCustomJavaSystemProperties())

See getShellEnvironment() for discussion of quoting/escaping strategy.

getJmxPort

@Deprecated
public java.lang.Integer getJmxPort()

Deprecated. since 0.6.0, the config key is always used instead of this

getRmiRegistryPort

@Deprecated
public java.lang.Integer getRmiRegistryPort()

Deprecated. since 0.6.0, the config key is always used instead of this

getJmxContext

@Deprecated
public java.lang.String getJmxContext()

Deprecated. since 0.6.0, the config key is always used instead of this

installJava

public boolean installJava()

Checks for Java 6 or 7, installing Java 7 if neither are found. Override this method to check for and install specific versions of Java.

See Also:

checkForAndInstallJava(String)

installJmxSupport

public void installJmxSupport()

checkJavaHostnameBug

public void checkJavaHostnameBug()

setup

public void setup()

Description copied from class: AbstractSoftwareProcessDriver

Implementations should fail if the return code is non-zero, by throwing some appropriate exception.

Overrides:

setup in class AbstractSoftwareProcessSshDriver

copyRuntimeResources

public void copyRuntimeResources()

Description copied from class: AbstractSoftwareProcessDriver

Files and templates to be copied to the server after customisation. This allows overwriting of existing files such as entity configuration which may be copied from the installation directory during the AbstractSoftwareProcessDriver.customize() process.

Will be prefixed with the entity's run directory if relative.

Overrides:

copyRuntimeResources in class AbstractSoftwareProcessDriver

See Also:

SoftwareProcess.RUNTIME_FILES, SoftwareProcess.RUNTIME_TEMPLATES, AbstractSoftwareProcessDriver.copyInstallResources()