JBoss6SshDriver (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.JBoss6SshDriver

All Implemented Interfaces:

NaiveScriptRunner, SoftwareProcessDriver, EntityDriver, JavaSoftwareProcessDriver, JavaWebAppDriver, JBoss6Driver
```
public class JBoss6SshDriver
extends JavaWebAppSshDriver
implements JBoss6Driver
```

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_HTTP_PORT

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

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_HTTP_PORT`
`static java.lang.String`	`SERVER_TYPE`

Constructor Summary

Constructors
Constructor and Description

JBoss6SshDriver(JBoss6ServerImpl entity, SshMachineLocation machine)

Constructors
Constructor and Description
`JBoss6SshDriver(JBoss6ServerImpl entity, SshMachineLocation machine)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`customize()`
`JBoss6ServerImpl`	`getEntity()` The entity whose components we are controlling.
`java.lang.String`	`getExpandedInstallDir()`
`java.util.Map<java.lang.String,java.lang.String>`	`getShellEnvironment()` Sets all JVM options (-X..
`void`	`install()`
`boolean`	`isRunning()` Whether the entity components have started.
`void`	`launch()`
`void`	`postLaunch()` Implement this method in child classes to add some post-launch behavior
`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, undeploy

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

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessSshDriver
checkNoHostnameBug, copyInstallResources, copyResource, copyResource, execute, execute, execute, getAddress, 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, kill, 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
kill, 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
  - DEFAULT_HTTP_PORT
```
public static final int DEFAULT_HTTP_PORT
```
    See Also:
    Constant Field Values
- Constructor Detail
  - JBoss6SshDriver
```
public JBoss6SshDriver(JBoss6ServerImpl entity,
               SshMachineLocation machine)
```
- Method Detail
  - getEntity
```
public JBoss6ServerImpl 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
  - getExpandedInstallDir
```
public java.lang.String getExpandedInstallDir()
```
    Overrides:
    
    getExpandedInstallDir in class AbstractSoftwareProcessSshDriver
  - postLaunch
```
public void postLaunch()
```
    Description copied from class: AbstractSoftwareProcessDriver
    
    Implement this method in child classes to add some post-launch behavior
    
    Overrides:
    
    postLaunch in class JavaWebAppSshDriver
  - 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()
```
    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()
  - 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

Class JBoss6SshDriver

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

DEFAULT_HTTP_PORT

Constructor Detail

JBoss6SshDriver

Method Detail

getEntity

getExpandedInstallDir

postLaunch

preInstall

install

customize

launch

isRunning

stop

getShellEnvironment