EntityDriver (Apache Brooklyn)

All Known Subinterfaces:

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

All Known Implementing Classes:

AbstractfKafkaSshDriver, AbstractMongoDBSshDriver, AbstractSoftwareProcessDriver, AbstractSoftwareProcessSshDriver, ActiveMQSshDriver, BindDnsServerSshDriver, BrooklynNodeSshDriver, CassandraNodeSshDriver, ChefSoloDriver, CouchbaseNodeSshDriver, CouchbaseSyncGatewaySshDriver, CouchDBNodeSshDriver, ElasticSearchNodeSshDriver, EmptySoftwareProcessSshDriver, JavaSoftwareProcessSshDriver, JavaWebAppSshDriver, JBoss6SshDriver, JBoss7SshDriver, Jetty6SshDriver, KafkaBrokerSshDriver, KafkaZooKeeperSshDriver, KarafSshDriver, MariaDbSshDriver, MongoDBClientSshDriver, MongoDBConfigServerSshDriver, MongoDBRouterSshDriver, MongoDBSshDriver, MonitSshDriver, MySqlSshDriver, NginxSshDriver, NodeJsWebAppSshDriver, PostgreSqlSshDriver, QpidSshDriver, RabbitSshDriver, RedisStoreSshDriver, RiakNodeSshDriver, RubyRepSshDriver, SimulatedJBoss7ServerImpl.SimulatedJBoss7SshDriver, SimulatedMySqlNodeImpl.SimulatedMySqlSshDriver, SimulatedNginxControllerImpl.SimulatedNginxSshDriver, SolrServerSshDriver, StormSshDriver, Tomcat7SshDriver, VanillaJavaAppSshDriver, VanillaSoftwareProcessSshDriver, ZooKeeperSshDriver
```
public interface EntityDriver
```
The EntityDriver provides an abstraction between the Entity and the environment (the Location it is running in, so that an entity is not tightly coupled to a specific Location. E.g. you could have a TomcatEntity that uses a TomcatDriver (an interface) and you could have different driver implementations like the TomcatSshDriver/TomcatWindowsDriver and if in the future support for Puppet needs to be added, a TomcatPuppetDriver could be added.

See Also:
DriverDependentEntity, EntityDriverManager

- Method Summary
  
  Methods
  Modifier and Type Method and Description
  
  EntityLocal getEntity()
  The entity instance that this is a driver for.
  
  Location getLocation()
  The location the entity is running in.

Methods
Modifier and Type	Method and Description
`EntityLocal`	`getEntity()` The entity instance that this is a driver for.
`Location`	`getLocation()` The location the entity is running in.

- Method Detail
  - getEntity
```
@Beta
EntityLocal getEntity()
```
    The entity instance that this is a driver for. FIXME The signature of this will change to return Entity instead of EntityLocal. This is a temporary workaround for groovy not supporting covariant return types, see http://jira.codehaus.org/browse/GROOVY-5418. It is fixed in groovy 2.0.4 so we will need to upgrade from 1.8.6 first.
  - getLocation
```
Location getLocation()
```
    The location the entity is running in.

Interface EntityDriver

Method Summary

Method Detail

getEntity

getLocation