JavaWebAppSshDriver (Apache Brooklyn)

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

All Implemented Interfaces:

NaiveScriptRunner, SoftwareProcessDriver, EntityDriver, JavaSoftwareProcessDriver, JavaWebAppDriver

Direct Known Subclasses:

JBoss6SshDriver, JBoss7SshDriver, Jetty6SshDriver, TomcatSshDriver
```
public abstract class JavaWebAppSshDriver
extends JavaSoftwareProcessSshDriver
implements JavaWebAppDriver
```

Field Summary
- 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

JavaWebAppSshDriver(JavaWebAppSoftwareProcessImpl entity, SshMachineLocation machine)

Constructors
Constructor and Description
`JavaWebAppSshDriver(JavaWebAppSoftwareProcessImpl entity, SshMachineLocation machine)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`deploy(java.io.File file)`
`void`	`deploy(java.io.File f, java.lang.String targetName)`
`java.lang.String`	`deploy(java.lang.String url, java.lang.String targetName)` Deploys a URL as a webapp at the appserver.
`java.util.Set<java.lang.String>`	`getEnabledProtocols()`
`JavaWebAppSoftwareProcessImpl`	`getEntity()` The entity whose components we are controlling.
`FilenameToWebContextMapper`	`getFilenameContextMapper()`
`java.lang.Integer`	`getHttpPort()`
`java.lang.Integer`	`getHttpsPort()`
`HttpsSslConfig`	`getHttpsSslConfig()`
`void`	`postLaunch()` Implement this method in child classes to add some post-launch behavior
`void`	`undeploy(java.lang.String targetName)`

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, customize, getResource, getResourceAsString, getVersion, install, kill, launch, preInstall, processTemplate, processTemplate, processTemplate, processTemplate, processTemplateContents, processTemplateContents, rebind, restart, start, stop

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

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

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

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

- Constructor Detail
  - JavaWebAppSshDriver
```
public JavaWebAppSshDriver(JavaWebAppSoftwareProcessImpl entity,
                   SshMachineLocation machine)
```
- Method Detail
  - getEntity
```
public JavaWebAppSoftwareProcessImpl 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 AbstractSoftwareProcessDriver
  - getEnabledProtocols
```
public java.util.Set<java.lang.String> getEnabledProtocols()
```
    Specified by:
    
    getEnabledProtocols in interface JavaWebAppDriver
  - getHttpPort
```
public java.lang.Integer getHttpPort()
```
    Specified by:
    
    getHttpPort in interface JavaWebAppDriver
  - getHttpsPort
```
public java.lang.Integer getHttpsPort()
```
    Specified by:
    
    getHttpsPort in interface JavaWebAppDriver
  - getHttpsSslConfig
```
public HttpsSslConfig getHttpsSslConfig()
```
    Specified by:
    
    getHttpsSslConfig in interface JavaWebAppDriver
  - 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 AbstractSoftwareProcessDriver
  - deploy
```
public void deploy(java.io.File file)
```
    Specified by:
    
    deploy in interface JavaWebAppDriver
  - deploy
```
public void deploy(java.io.File f,
          java.lang.String targetName)
```
    Specified by:
    
    deploy in interface JavaWebAppDriver
  - deploy
```
public java.lang.String deploy(java.lang.String url,
                      java.lang.String targetName)
```
    Deploys a URL as a webapp at the appserver. Returns a token which can be used as an argument to undeploy, typically the web context with leading slash where the app can be reached (just "/" for ROOT)
    
    Specified by:
    
    deploy in interface JavaWebAppDriver
    
    Returns:
    A token which can be used as an argument to undeploy. Typically the web context with leading slash where the app can be reached (just "/" for ROOT)
    See Also:
    for details of how input filenames are handled
  - undeploy
```
public void undeploy(java.lang.String targetName)
```
    Specified by:
    
    undeploy in interface JavaWebAppDriver
  - getFilenameContextMapper
```
public FilenameToWebContextMapper getFilenameContextMapper()
```
    Specified by:
    
    getFilenameContextMapper in interface JavaWebAppDriver

Class JavaWebAppSshDriver

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.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.java.JavaSoftwareProcessDriver

Methods inherited from interface brooklyn.entity.basic.SoftwareProcessDriver

Methods inherited from interface brooklyn.entity.drivers.EntityDriver

Constructor Detail

JavaWebAppSshDriver

Method Detail

getEntity

getEnabledProtocols

getHttpPort

getHttpsPort

getHttpsSslConfig

postLaunch

deploy

deploy

deploy

undeploy

getFilenameContextMapper