org.apache.brooklyn.api.entity.drivers

Interface EntityDriver

All Known Subinterfaces:

ActiveMQDriver, AnsibleEntityDriver, 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, SoftwareProcessDriver, SolrServerDriver, StormDriver, Tomcat7Driver, TomcatDriver, VanillaJavaAppDriver, VanillaSoftwareProcessDriver, VanillaWindowsProcessDriver, ZooKeeperDriver

All Known Implementing Classes:

AbstractfKafkaSshDriver, AbstractMongoDBSshDriver, AbstractSoftwareProcessDriver, AbstractSoftwareProcessSshDriver, AbstractSoftwareProcessWinRmDriver, ActiveMQSshDriver, AnsibleEntitySshDriver, 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, SimulatedVanillaSoftwareProcessImpl.SimulatedVanillaSoftwareProcessSshDriver, SolrServerSshDriver, StormSshDriver, Tomcat7SshDriver, TomcatSshDriver, VanillaJavaAppSshDriver, VanillaSoftwareProcessSshDriver, VanillaWindowsProcessWinRmDriver, 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

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

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.