SoftwareProcessDriver (Apache Brooklyn)

All Superinterfaces:

EntityDriver

All Known Subinterfaces:

ActiveMQDriver, BindDnsServerDriver, BrooklynNodeDriver, CassandraNodeDriver, CouchbaseNodeDriver, CouchbaseSyncGatewayDriver, CouchDBNodeDriver, CrateNodeDriver, DerbyDatabaseDriver, ElasticSearchNodeDriver, EmptySoftwareProcessDriver, EmptyWindowsProcessDriver, HazelcastNodeDriver, JavaSoftwareProcessDriver, JavaWebAppDriver, JBoss6Driver, JBoss7Driver, Jetty6Driver, KafkaBrokerDriver, KafkaZooKeeperDriver, KarafDriver, MariaDbDriver, MongoDBClientDriver, MongoDBConfigServerDriver, MongoDBDriver, MongoDBRouterDriver, MonitDriver, MySqlDriver, NginxDriver, NodeJsWebAppDriver, PostgreSqlDriver, QpidDriver, RabbitDriver, RedisStoreDriver, RiakNodeDriver, RubyRepDriver, SaltEntityDriver, SolrServerDriver, StormDriver, Tomcat7Driver, TomcatDriver, VanillaJavaAppDriver, VanillaSoftwareProcessDriver, VanillaWindowsProcessDriver, ZooKeeperDriver

All Known Implementing Classes:

AbstractfKafkaSshDriver, AbstractMongoDBSshDriver, AbstractSoftwareProcessDriver, AbstractSoftwareProcessSshDriver, AbstractSoftwareProcessWinRmDriver, ActiveMQSshDriver, BindDnsServerSshDriver, BrooklynNodeSshDriver, CassandraNodeSshDriver, ChefSoloDriver, CouchbaseNodeSshDriver, CouchbaseSyncGatewaySshDriver, CouchDBNodeSshDriver, CrateNodeSshDriver, DerbyDatabaseSshDriver, ElasticSearchNodeSshDriver, EmptySoftwareProcessSshDriver, EmptyWindowsProcessWinRmDriver, HazelcastNodeSshDriver, Infinispan5SshDriver, JavaSoftwareProcessSshDriver, JavaWebAppSshDriver, JBoss6SshDriver, JBoss7SshDriver, Jetty6SshDriver, KafkaBrokerSshDriver, KafkaZooKeeperSshDriver, KarafSshDriver, MariaDbSshDriver, MongoDBClientSshDriver, MongoDBConfigServerSshDriver, MongoDBRouterSshDriver, MongoDBSshDriver, MonitSshDriver, MySqlSshDriver, NginxSshDriver, NodeJsWebAppSshDriver, PostgreSqlSshDriver, QpidSshDriver, RabbitSshDriver, RedisStoreSshDriver, RiakNodeSshDriver, RubyRepSshDriver, SaltEntitySshDriver, SimulatedJBoss7ServerImpl.SimulatedJBoss7SshDriver, SimulatedMySqlNodeImpl.SimulatedMySqlSshDriver, SimulatedNginxControllerImpl.SimulatedNginxSshDriver, SolrServerSshDriver, StormSshDriver, Tomcat7SshDriver, TomcatSshDriver, VanillaJavaAppSshDriver, VanillaSoftwareProcessSshDriver, VanillaWindowsProcessWinRmDriver, ZooKeeperSshDriver
```
public interface SoftwareProcessDriver
extends EntityDriver
```
The EntityDriver for a SoftwareProcess.
In many cases it is cleaner to store entity lifecycle effectors (and sometimes other implementations) in a class to which the entity delegates. Classes implementing this interface provide this delegate, often inheriting utilities specific to a particular transport (e.g. ssh) shared among many different entities.
In this way, it is also possible for entities to cleanly support multiple mechanisms for start/stop and other methods.

Method Summary

Methods
Modifier and Type	Method and Description
`EntityLocal`	`getEntity()` The entity whose components we are controlling.
`boolean`	`isRunning()` Whether the entity components have started.
`void`	`kill()` Kills the process, ungracefully and immediately where possible (e.g.
`void`	`rebind()` Rebinds the driver to a pre-existing software process.
`void`	`restart()` Performs software restart (or queues tasks to do this).
`void`	`start()` Performs software start (or queues tasks to do this)
`void`	`stop()` Performs software stop (or queues tasks to do this)

Methods inherited from interface org.apache.brooklyn.api.entity.drivers.EntityDriver
getLocation

- Method Detail
  - getEntity
```
EntityLocal getEntity()
```
    The entity whose components we are controlling.
    
    Specified by:
    
    getEntity in interface EntityDriver
  - isRunning
```
boolean isRunning()
```
    Whether the entity components have started.
  - rebind
```
void rebind()
```
    Rebinds the driver to a pre-existing software process.
  - start
```
void start()
```
    Performs software start (or queues tasks to do this)
  - restart
```
void restart()
```
    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).
    
    See Also:
    Startable.restart()
  - stop
```
void stop()
```
    Performs software stop (or queues tasks to do this)
    
    See Also:
    Startable.stop()
  - kill
```
void kill()
```
    Kills the process, ungracefully and immediately where possible (e.g. with `kill -9`).

Interface SoftwareProcessDriver

Method Summary

Methods inherited from interface org.apache.brooklyn.api.entity.drivers.EntityDriver

Method Detail

getEntity

isRunning

rebind

start

restart

stop

kill