JBoss7SshDriver (Apache Brooklyn)

java.lang.Object
- brooklyn.entity.basic.AbstractSoftwareProcessDriver
- - brooklyn.entity.basic.AbstractSoftwareProcessSshDriver
  - - brooklyn.entity.java.JavaSoftwareProcessSshDriver
    - - brooklyn.entity.webapp.JavaWebAppSshDriver
      - brooklyn.entity.webapp.jboss.JBoss7SshDriver

All Implemented Interfaces:

NaiveScriptRunner, SoftwareProcessDriver, EntityDriver, JavaSoftwareProcessDriver, JavaWebAppDriver, JBoss7Driver

Direct Known Subclasses:

SimulatedJBoss7ServerImpl.SimulatedJBoss7SshDriver
```
public class JBoss7SshDriver
extends JavaWebAppSshDriver
implements JBoss7Driver
```

Field Summary

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

Fields inherited from class brooklyn.entity.java.JavaSoftwareProcessSshDriver
KEY_VAL_OPT_PREFIXES, log, MUTUALLY_EXCLUSIVE_OPTS

Fields inherited from class brooklyn.entity.basic.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)

Constructors
Constructor and Description
`JBoss7SshDriver(JBoss7ServerImpl entity, SshMachineLocation machine)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`customize()` AS7 config notes and TODOs: We're using the http management interface on port managementPort We're not using any JMX.
`JBoss7ServerImpl`	`getEntity()` The entity whose components we are controlling.
`java.lang.String`	`getSslKeystoreFile()` 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)` Creates a hash of a username, password and security realm that is suitable for use with AS7 and Wildfire.
`void`	`install()`
`boolean`	`isRunning()` Whether the entity components have started.
`void`	`kill()` Kills the process, ungracefully and immediately where possible (e.g.
`void`	`launch()`
`void`	`preInstall()` Implement this method in child classes to add some pre-install behavior
`void`	`stop()` Performs software stop (or queues tasks to do this)

Methods inherited from class brooklyn.entity.webapp.JavaWebAppSshDriver
deploy, deploy, deploy, getEnabledProtocols, getFilenameContextMapper, getHttpPort, getHttpsPort, getHttpsSslConfig, postLaunch, undeploy

Methods inherited from class brooklyn.entity.java.JavaSoftwareProcessSshDriver
checkJavaHostnameBug, copyRuntimeResources, getJavaOpts, getJmxContext, getJmxPort, getRmiRegistryPort, getShellEnvironment, installJava, installJmxSupport, isJmxEnabled, isJmxSslEnabled, setup

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessSshDriver
checkNoHostnameBug, copyInstallResources, copyResource, copyResource, execute, execute, execute, getAddress, getExpandedInstallDir, getHostname, getInstallDir, getLocation, getMachine, getPortsUsed, getRunDir, getSubnetAddress, getSubnetHostname, runPostInstallCommand, runPostLaunchCommand, runPreInstallCommand, runPreLaunchCommand, setExpandedInstallDir

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessDriver
copyPreInstallResources, copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyTemplate, copyTemplate, copyTemplate, getResource, getResourceAsString, getVersion, processTemplate, processTemplate, processTemplate, processTemplate, processTemplateContents, processTemplateContents, rebind, restart, start

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface brooklyn.entity.webapp.JavaWebAppDriver
deploy, deploy, deploy, getEnabledProtocols, getFilenameContextMapper, getHttpPort, getHttpsPort, getHttpsSslConfig, undeploy

Methods inherited from interface brooklyn.entity.java.JavaSoftwareProcessDriver
isJmxEnabled

Methods inherited from interface brooklyn.entity.basic.SoftwareProcessDriver
rebind, restart, start

Methods inherited from interface brooklyn.entity.drivers.EntityDriver
getLocation

- Field Detail
  - SERVER_TYPE
```
public static final java.lang.String SERVER_TYPE
```
    See Also:
    Constant Field Values
  - CONFIG_FILE
```
public static final java.lang.String CONFIG_FILE
```
    See Also:
    Constant Field Values
  - KEYSTORE_FILE
```
public static final java.lang.String KEYSTORE_FILE
```
    See Also:
    Constant Field Values
  - MANAGEMENT_REALM
```
public static final java.lang.String MANAGEMENT_REALM
```
    See Also:
    Constant Field Values
- Constructor Detail
  - JBoss7SshDriver
```
public JBoss7SshDriver(JBoss7ServerImpl entity,
               SshMachineLocation machine)
```
- Method Detail
  - getEntity
```
public JBoss7ServerImpl getEntity()
```
    Description copied from interface: SoftwareProcessDriver
    
    The entity whose components we are controlling.
    
    Specified by:
    
    getEntity in interface SoftwareProcessDriver
    
    Specified by:
    
    getEntity in interface EntityDriver
    
    Overrides:
    
    getEntity in class JavaWebAppSshDriver
  - getSslKeystoreFile
```
public java.lang.String getSslKeystoreFile()
```
    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
  - preInstall
```
public void preInstall()
```
    Description copied from class: AbstractSoftwareProcessDriver
    
    Implement this method in child classes to add some pre-install behavior
    
    Overrides:
    
    preInstall in class AbstractSoftwareProcessDriver
  - install
```
public void install()
```
    Specified by:
    
    install in class AbstractSoftwareProcessDriver
  - customize
```
public void customize()
```
    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()
```
    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
  - hashPassword
```
public static java.lang.String hashPassword(java.lang.String username,
                            java.lang.String password,
                            java.lang.String realm)
```
    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

Class JBoss7SshDriver

Field Summary

Fields inherited from class brooklyn.entity.java.JavaSoftwareProcessSshDriver

Fields inherited from class brooklyn.entity.basic.AbstractSoftwareProcessSshDriver

Constructor Summary

Method Summary

Methods inherited from class brooklyn.entity.webapp.JavaWebAppSshDriver

Methods inherited from class brooklyn.entity.java.JavaSoftwareProcessSshDriver

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessSshDriver

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessDriver

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.entity.webapp.JavaWebAppDriver

Methods inherited from interface brooklyn.entity.java.JavaSoftwareProcessDriver

Methods inherited from interface brooklyn.entity.basic.SoftwareProcessDriver

Methods inherited from interface brooklyn.entity.drivers.EntityDriver

Field Detail

SERVER_TYPE

CONFIG_FILE

KEYSTORE_FILE

MANAGEMENT_REALM

Constructor Detail

JBoss7SshDriver

Method Detail

getEntity

getSslKeystoreFile

preInstall

install

customize

launch

isRunning

stop

kill

hashPassword