org.apache.brooklyn.entity.webapp.jboss

Class JBoss7SshDriver

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.webapp.JavaWebAppSshDriver

org.apache.brooklyn.entity.webapp.jboss.JBoss7SshDriver

All Implemented Interfaces:

EntityDriver, JavaSoftwareProcessDriver, NaiveScriptRunner, SoftwareProcessDriver, JavaWebAppDriver, JBoss7Driver

Direct Known Subclasses:

SimulatedJBoss7ServerImpl.SimulatedJBoss7SshDriver

Deprecated.

since 1.0.0; JBoss 7 is EOF

@Deprecated
public class JBoss7SshDriver
extends JavaWebAppSshDriver
implements JBoss7Driver

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_FILE Deprecated.
static java.lang.String	KEYSTORE_FILE Deprecated.
static java.lang.String	MANAGEMENT_REALM Deprecated.
static java.lang.String	SERVER_TYPE Deprecated.

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

KEY_VAL_OPT_PREFIXES, log, 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
JBoss7SshDriver(JBoss7ServerImpl entity, SshMachineLocation machine) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	customize() Deprecated. AS7 config notes and TODOs: We're using the http management interface on port managementPort We're not using any JMX.
JBoss7ServerImpl	getEntity() Deprecated. The entity whose components we are controlling.
java.lang.String	getSslKeystoreFile() Deprecated. The path to the keystore file on the AS7 server machine.
static java.lang.String	hashPassword(java.lang.String username, java.lang.String password, java.lang.String realm) Deprecated. Creates a hash of a username, password and security realm that is suitable for use with AS7 and Wildfire.
void	install() Deprecated. Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
boolean	installJava() Deprecated. Checks for Java 6 or 7, installing Java 7 if neither are found.
boolean	isRunning() Deprecated. Whether the entity components have started.
void	kill() Deprecated. Kills the process, ungracefully and immediately where possible (e.g.
void	launch() Deprecated. Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
void	prepare() Deprecated. Prepare the entity instance before running any commands.
void	stop() Deprecated. Performs software stop (or queues tasks to do this)

Methods inherited from class org.apache.brooklyn.entity.webapp.JavaWebAppSshDriver

deploy, deploy, deploy, getEnabledProtocols, getFilenameContextMapper, getHttpPort, getHttpsPort, getHttpsSslConfig, postLaunch, undeploy

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

checkJavaHostnameBug, copyRuntimeResources, getJavaOpts, getJmxContext, getJmxPort, getRmiRegistryPort, getShellEnvironment, 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, 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, getArchiveNameFormat, getExpandedInstallDir, getInstallDir, getResource, getResourceAsString, getRunDir, getVersion, 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.webapp.JavaWebAppDriver

deploy, deploy, deploy, getEnabledProtocols, getFilenameContextMapper, getHttpPort, getHttpsPort, getHttpsSslConfig, undeploy

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

Field Detail

SERVER_TYPE

public static final java.lang.String SERVER_TYPE

Deprecated.

See Also:

Constant Field Values

CONFIG_FILE

public static final java.lang.String CONFIG_FILE

Deprecated.

See Also:

Constant Field Values

KEYSTORE_FILE

public static final java.lang.String KEYSTORE_FILE

Deprecated.

See Also:

Constant Field Values

MANAGEMENT_REALM

public static final java.lang.String MANAGEMENT_REALM

Deprecated.

See Also:

Constant Field Values

Constructor Detail

JBoss7SshDriver

public JBoss7SshDriver(JBoss7ServerImpl entity,
                       SshMachineLocation machine)

Deprecated.

Method Detail

getEntity

public JBoss7ServerImpl getEntity()

Deprecated.

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 JavaWebAppSshDriver

getSslKeystoreFile

public java.lang.String getSslKeystoreFile()

Deprecated.

Description copied from interface: JBoss7Driver

The path to the keystore file on the AS7 server machine. Result is undefined if SSL is not enabled/configured.

Specified by:

getSslKeystoreFile in interface JBoss7Driver

prepare

public void prepare()

Deprecated.

Description copied from class: AbstractSoftwareProcessDriver

Prepare the entity instance before running any commands. Always executed during AbstractSoftwareProcessDriver.start().

Overrides:

prepare in class AbstractSoftwareProcessSshDriver

installJava

public boolean installJava()

Deprecated.

Description copied from class: JavaSoftwareProcessSshDriver

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.

Overrides:

installJava in class JavaSoftwareProcessSshDriver

See Also:

JavaSoftwareProcessSshDriver.checkForAndInstallJava(String)

install

public void install()

Deprecated.

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

Deprecated.

AS7 config notes and TODOs: We're using the http management interface on port managementPort We're not using any JMX. - AS 7 simply doesn't boot with Sun JMX enabled (https://issues.jboss.org/browse/JBAS-7427) - 7.1 onwards uses Remoting 3, which we haven't configured - We have generic support for jmxmp, which one could configure We're completely disabling security on the management interface. - In the future we probably want to use the as7/bin/add-user.sh script using config keys for user and password - Or we could create our own security realm and use that. We disable the root welcome page, since we can't deploy our own root otherwise We bind all interfaces to entity.hostname, rather than 127.0.0.1.

Specified by:

customize in class AbstractSoftwareProcessDriver

launch

public void launch()

Deprecated.

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

Deprecated.

Description copied from interface: SoftwareProcessDriver

Whether the entity components have started.

Specified by:

isRunning in interface SoftwareProcessDriver

stop

public void stop()

Deprecated.

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

Deprecated.

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

hashPassword

public static java.lang.String hashPassword(java.lang.String username,
                                            java.lang.String password,
                                            java.lang.String realm)

Deprecated.

Creates a hash of a username, password and security realm that is suitable for use with AS7 and Wildfire.

Although AS7 has an add-user.sh script it is unsuitable for use in non-interactive modes. (See AS7-5061 for details.) Versions 7.1.2+ (EAP) accept a --silent flag. When this entity is updated past 7.1.1 we should probably use that instead.

This method mirrors AS7 and Wildfire's method of hashing user's passwords. Refer to its class UsernamePasswordHashUtil.generateHashedURP for their implementation.

Returns:

HEX(MD5(username ':' realm ':' password))

See Also:

AS7-5061, UsernamePasswordHashUtil.generateHashedURP