AbstractSoftwareProcessDriver (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.entity.software.base.AbstractSoftwareProcessDriver

All Implemented Interfaces:

EntityDriver, SoftwareProcessDriver

Direct Known Subclasses:

AbstractSoftwareProcessSshDriver, AbstractSoftwareProcessWinRmDriver
```
public abstract class AbstractSoftwareProcessDriver
extends java.lang.Object
implements SoftwareProcessDriver
```
An abstract implementation of the SoftwareProcessDriver.

Constructor Summary

Constructors
Constructor and Description

AbstractSoftwareProcessDriver(EntityLocal entity, Location location)

Constructors
Constructor and Description
`AbstractSoftwareProcessDriver(EntityLocal entity, Location location)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`copyCustomizeResources()` Files and templates to be copied to the server before customize.
`void`	`copyInstallResources()` Files and templates to be copied to the server before installation.
`void`	`copyPreInstallResources()` Files and templates to be copied to the server before pre-install.
`int`	`copyResource(java.io.File file, java.lang.String target)`
`int`	`copyResource(java.io.InputStream source, java.lang.String target)`
`abstract int`	`copyResource(java.util.Map<java.lang.Object,java.lang.Object> sshFlags, java.io.InputStream source, java.lang.String target, boolean createParentDir)`
`int`	`copyResource(java.util.Map<java.lang.Object,java.lang.Object> sshFlags, java.io.Reader source, java.lang.String target, boolean createParent)`
`abstract int`	`copyResource(java.util.Map<java.lang.Object,java.lang.Object> sshFlags, java.lang.String sourceUrl, java.lang.String target, boolean createParentDir)`
`int`	`copyResource(java.util.Map sshFlags, java.lang.String source, java.lang.String target)`
`int`	`copyResource(java.io.Reader source, java.lang.String target)`
`int`	`copyResource(java.lang.String resource, java.lang.String target)`
`int`	`copyResource(java.lang.String resourceUrl, java.lang.String target, boolean createParentDir)`
`void`	`copyRuntimeResources()` Files and templates to be copied to the server after customisation.
`int`	`copyTemplate(java.io.File template, java.lang.String target)`
`int`	`copyTemplate(java.lang.String template, java.lang.String target)`
`int`	`copyTemplate(java.lang.String templateUrl, java.lang.String target, boolean createParent, java.util.Map<java.lang.String,?> extraSubstitutions)`
`abstract void`	`customize()` Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
`java.lang.String`	`getArchiveNameFormat()`
`EntityLocal`	`getEntity()` The entity whose components we are controlling.
`java.lang.String`	`getExpandedInstallDir()`
`java.lang.String`	`getInstallDir()`
`Location`	`getLocation()` The location the entity is running in.
`java.io.InputStream`	`getResource(java.lang.String url)`
`java.lang.String`	`getResourceAsString(java.lang.String url)`
`java.lang.String`	`getRunDir()`
`java.util.Map<java.lang.String,java.lang.String>`	`getShellEnvironment()` The environment variables to be set when executing the commands (for install, run, check running, etc).
`java.lang.String`	`getVersion()`
`abstract void`	`install()` Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
`void`	`kill()` Kills the process, ungracefully and immediately where possible (e.g.
`abstract void`	`launch()` Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
`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`	`prepare()` Prepare the entity instance before running any commands.
`java.lang.String`	`processTemplate(java.io.File templateConfigFile)`
`java.lang.String`	`processTemplate(java.io.File templateConfigFile, java.util.Map<java.lang.String,java.lang.Object> extraSubstitutions)`
`java.lang.String`	`processTemplate(java.lang.String templateConfigUrl)` Takes the contents of a template file from the given URL (often a classpath://com/myco/myprod/myfile.conf or .sh) and replaces "${entity.xxx}" with the result of entity.getXxx() and similar for other driver, location; as well as replacing config keys on the management context
`java.lang.String`	`processTemplate(java.lang.String templateConfigUrl, java.util.Map<java.lang.String,? extends java.lang.Object> extraSubstitutions)`
`java.lang.String`	`processTemplateContents(java.lang.String templateContents)`
`java.lang.String`	`processTemplateContents(java.lang.String templateContents, java.util.Map<java.lang.String,? extends java.lang.Object> extraSubstitutions)`
`void`	`rebind()` Rebinds the driver to a pre-existing software process.
`void`	`restart()` Performs software restart (or queues tasks to do this).
`abstract void`	`runPostCustomizeCommand()` Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
`abstract void`	`runPostInstallCommand()` Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
`abstract void`	`runPostLaunchCommand()` Only run if launch is run (if start is not skipped).
`abstract void`	`runPreCustomizeCommand()` Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
`abstract void`	`runPreInstallCommand()` Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
`abstract void`	`runPreLaunchCommand()` Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
`void`	`setExpandedInstallDir(java.lang.String val)`
`abstract void`	`setup()` Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
`void`	`start()` Start the entity.
`abstract void`	`stop()` Performs software stop (or queues tasks to do this)

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
isRunning

- Constructor Detail
  - AbstractSoftwareProcessDriver
```
public AbstractSoftwareProcessDriver(EntityLocal entity,
                                     Location location)
```
- Method Detail
  - rebind
```
public void rebind()
```
    Description copied from interface: SoftwareProcessDriver
    
    Rebinds the driver to a pre-existing software process.
    
    Specified by:
    
    rebind in interface SoftwareProcessDriver
  - start
```
public void start()
```
    Start the entity.
    This installs, configures and launches the application process. However, users can also call the install(), customize() and launch() steps independently. The postLaunch() will be called after the launch() metheod is executed, but the process may not be completely initialised at this stage, so care is required when implementing these stages.
    The BrooklynConfigKeys.SKIP_ENTITY_START_IF_RUNNING key can be set on the location or the entity to skip the startup process if the entity is already running, according to the SoftwareProcessDriver.isRunning() method. To force the startup to be skipped, BrooklynConfigKeys.SKIP_ENTITY_START can be set on the entity. The BrooklynConfigKeys.SKIP_ENTITY_INSTALLATION key can also be used to skip the setup(), copyInstallResources() and install() methods if set on the entity or location.
    
    Specified by:
    
    start in interface SoftwareProcessDriver
    
    See Also:
    
    stop()
  - stop
```
public abstract void stop()
```
    Description copied from interface: SoftwareProcessDriver
    
    Performs software stop (or queues tasks to do this)
    
    Specified by:
    
    stop in interface SoftwareProcessDriver
    
    See Also:
    
    Startable.stop()
  - prepare
```
public void prepare()
```
    Prepare the entity instance before running any commands. Always executed during start().
  - preInstall
```
public void preInstall()
```
    Implement this method in child classes to add some pre-install behavior
  - runPreInstallCommand
```
public abstract void runPreInstallCommand()
```
    Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
  - setup
```
public abstract void setup()
```
    Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
  - install
```
public abstract void install()
```
    Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
  - runPostInstallCommand
```
public abstract void runPostInstallCommand()
```
    Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
  - runPreCustomizeCommand
```
public abstract void runPreCustomizeCommand()
```
    Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
  - customize
```
public abstract void customize()
```
    Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
  - runPostCustomizeCommand
```
public abstract void runPostCustomizeCommand()
```
    Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
  - runPreLaunchCommand
```
public abstract void runPreLaunchCommand()
```
    Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
  - launch
```
public abstract void launch()
```
    Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
  - runPostLaunchCommand
```
public abstract void runPostLaunchCommand()
```
    Only run if launch is run (if start is not skipped). Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
  - 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
  - postLaunch
```
public void postLaunch()
```
    Implement this method in child classes to add some post-launch behavior. This is run even if start is skipped and launch is not run.
  - restart
```
public void restart()
```
    Description copied from interface: SoftwareProcessDriver
    
    Performs software restart (or queues tasks to do this). Unlike stop/start implementations here are expected to update SERVICE_STATE for STOPPING and STARTING as appropriate (but framework will set RUNNING afterwards, after detecting it is running).
    
    Specified by:
    
    restart in interface SoftwareProcessDriver
    
    See Also:
    
    Startable.restart()
  - getEntity
```
public EntityLocal getEntity()
```
    Description copied from interface: SoftwareProcessDriver
    
    The entity whose components we are controlling.
    
    Specified by:
    
    getEntity in interface EntityDriver
    
    Specified by:
    
    getEntity in interface SoftwareProcessDriver
  - getLocation
```
public Location getLocation()
```
    Description copied from interface: EntityDriver
    
    The location the entity is running in.
    
    Specified by:
    
    getLocation in interface EntityDriver
  - getResource
```
public java.io.InputStream getResource(java.lang.String url)
```
  - copyPreInstallResources
```
public void copyPreInstallResources()
```
    Files and templates to be copied to the server before pre-install. This allows the preInstall() process to have access to all required resources.
    Will be prefixed with the entity's install directory if relative.
    
    See Also:
    
    SoftwareProcess.PRE_INSTALL_FILES, SoftwareProcess.PRE_INSTALL_TEMPLATES, copyRuntimeResources()
  - copyInstallResources
```
public void copyInstallResources()
```
    Files and templates to be copied to the server before installation. This allows the install() process to have access to all required resources.
    Will be prefixed with the entity's install directory if relative.
    
    See Also:
    
    SoftwareProcess.INSTALL_FILES, SoftwareProcess.INSTALL_TEMPLATES, copyRuntimeResources()
  - copyCustomizeResources
```
public void copyCustomizeResources()
```
    Files and templates to be copied to the server before customize. This allows the customize() process to have access to all required resources.
    Will be prefixed with the entity's install directory if relative.
    
    See Also:
    
    SoftwareProcess.INSTALL_FILES, SoftwareProcess.INSTALL_TEMPLATES, copyRuntimeResources()
  - copyRuntimeResources
```
public void copyRuntimeResources()
```
    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 customize() process.
    Will be prefixed with the entity's run directory if relative.
    
    See Also:
    
    SoftwareProcess.RUNTIME_FILES, SoftwareProcess.RUNTIME_TEMPLATES, copyInstallResources()
  - copyTemplate
```
public int copyTemplate(java.io.File template,
                        java.lang.String target)
```
    Parameters:
    
    template - File to template and copy.
    
    target - Destination on server.
    
    Returns:
    
    The exit code the SSH command run.
  - copyTemplate
```
public int copyTemplate(java.lang.String template,
                        java.lang.String target)
```
    Parameters:
    
    template - URI of file to template and copy, e.g. file://.., http://.., classpath://..
    
    target - Destination on server.
    
    Returns:
    
    The exit code of the SSH command run.
  - copyTemplate
```
public int copyTemplate(java.lang.String templateUrl,
                        java.lang.String target,
                        boolean createParent,
                        java.util.Map<java.lang.String,?> extraSubstitutions)
```
    Parameters:
    
    templateUrl - URI of file to template and copy, e.g. file://.., http://.., classpath://..
    
    target - Destination on server.
    
    extraSubstitutions - Extra substitutions for the templater to use, for example "foo" -> "bar", and in a template ${foo}.
    
    Returns:
    
    The exit code of the SSH command run.
  - copyResource
```
public abstract int copyResource(java.util.Map<java.lang.Object,java.lang.Object> sshFlags,
                                 java.lang.String sourceUrl,
                                 java.lang.String target,
                                 boolean createParentDir)
```
  - copyResource
```
public abstract int copyResource(java.util.Map<java.lang.Object,java.lang.Object> sshFlags,
                                 java.io.InputStream source,
                                 java.lang.String target,
                                 boolean createParentDir)
```
  - copyResource
```
public int copyResource(java.io.File file,
                        java.lang.String target)
```
    Parameters:
    
    file - File to copy.
    
    target - Destination on server.
    
    Returns:
    
    The exit code the SSH command run.
  - copyResource
```
public int copyResource(java.lang.String resource,
                        java.lang.String target)
```
    Parameters:
    
    resource - URI of file to copy, e.g. file://.., http://.., classpath://..
    
    target - Destination on server.
    
    Returns:
    
    The exit code of the SSH command run
  - copyResource
```
public int copyResource(java.lang.String resourceUrl,
                        java.lang.String target,
                        boolean createParentDir)
```
  - copyResource
```
public int copyResource(java.util.Map sshFlags,
                        java.lang.String source,
                        java.lang.String target)
```
  - copyResource
```
public int copyResource(java.io.Reader source,
                        java.lang.String target)
```
    See Also:
    
    copyResource(Map, InputStream, String, boolean)
  - copyResource
```
public int copyResource(java.util.Map<java.lang.Object,java.lang.Object> sshFlags,
                        java.io.Reader source,
                        java.lang.String target,
                        boolean createParent)
```
    See Also:
    
    copyResource(Map, InputStream, String, boolean)
  - copyResource
```
public int copyResource(java.io.InputStream source,
                        java.lang.String target)
```
    See Also:
    
    copyResource(Map, InputStream, String, boolean)
  - getResourceAsString
```
public java.lang.String getResourceAsString(java.lang.String url)
```
  - processTemplate
```
public java.lang.String processTemplate(java.io.File templateConfigFile,
                                        java.util.Map<java.lang.String,java.lang.Object> extraSubstitutions)
```
  - processTemplate
```
public java.lang.String processTemplate(java.io.File templateConfigFile)
```
  - processTemplate
```
public java.lang.String processTemplate(java.lang.String templateConfigUrl)
```
    Takes the contents of a template file from the given URL (often a classpath://com/myco/myprod/myfile.conf or .sh) and replaces "${entity.xxx}" with the result of entity.getXxx() and similar for other driver, location; as well as replacing config keys on the management context
    uses Freemarker templates under the covers
  - processTemplate
```
public java.lang.String processTemplate(java.lang.String templateConfigUrl,
                                        java.util.Map<java.lang.String,? extends java.lang.Object> extraSubstitutions)
```
  - processTemplateContents
```
public java.lang.String processTemplateContents(java.lang.String templateContents)
```
  - processTemplateContents
```
public java.lang.String processTemplateContents(java.lang.String templateContents,
                                                java.util.Map<java.lang.String,? extends java.lang.Object> extraSubstitutions)
```
  - getArchiveNameFormat
```
public java.lang.String getArchiveNameFormat()
```
  - getVersion
```
public java.lang.String getVersion()
```
  - getShellEnvironment
```
public java.util.Map<java.lang.String,java.lang.String> getShellEnvironment()
```
    The environment variables to be set when executing the commands (for install, run, check running, etc).
    
    See Also:
    
    SoftwareProcess.SHELL_ENVIRONMENT
  - getInstallDir
```
public java.lang.String getInstallDir()
```
  - getRunDir
```
public java.lang.String getRunDir()
```
  - setExpandedInstallDir
```
public void setExpandedInstallDir(java.lang.String val)
```
  - getExpandedInstallDir
```
public java.lang.String getExpandedInstallDir()
```

Class AbstractSoftwareProcessDriver

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSoftwareProcessDriver

Method Detail

rebind

start

stop

prepare

preInstall

runPreInstallCommand

setup

install

runPostInstallCommand

runPreCustomizeCommand

customize

runPostCustomizeCommand

runPreLaunchCommand

launch

runPostLaunchCommand

kill

postLaunch

restart

getEntity

getLocation

getResource

copyPreInstallResources

copyInstallResources

copyCustomizeResources

copyRuntimeResources

copyTemplate

copyTemplate

copyTemplate

copyResource

copyResource

copyResource

copyResource

copyResource

copyResource

copyResource

copyResource

copyResource

getResourceAsString

processTemplate

processTemplate

processTemplate

processTemplate

processTemplateContents

processTemplateContents

getArchiveNameFormat

getVersion

getShellEnvironment

getInstallDir

getRunDir

setExpandedInstallDir

getExpandedInstallDir