Startable (Apache Brooklyn)

All Known Subinterfaces:

AbstractController, AbstractMongoDBServer, AbstractNonProvisionedController, AbstractVanillaProcess, ActiveMQBroker, BasicApplication, BasicStartable, BindDnsServer, BrooklynCluster, BrooklynNode, CassandraCluster, CassandraDatacenter, CassandraFabric, CassandraNode, ChefEntity, Cluster, CoLocatedMongoDBRouter, ControlledDynamicWebAppCluster, CouchbaseCluster, CouchbaseNode, CouchbaseSyncGateway, CouchDBCluster, CouchDBNode, CrateNode, DataEntity, DynamicCluster, DynamicFabric, DynamicRegionsFabric, DynamicWebAppCluster, DynamicWebAppFabric, ElasticJavaWebAppService, ElasticSearchCluster, ElasticSearchNode, EmptySoftwareProcess, JavaWebAppSoftwareProcess, JBoss6Server, JBoss7Server, Jetty6Server, JMSBroker<Q,T>, KafkaBroker, KafkaCluster, KafkaZooKeeper, KarafContainer, LoadBalancer, LoadBalancerCluster, LocalBrooklynNode, MachineEntity, MariaDbNode, MongoDBClient, MongoDBConfigServer, MongoDBConfigServerCluster, MongoDBReplicaSet, MongoDBRouter, MongoDBRouterCluster, MongoDBServer, MongoDBShardCluster, MongoDBShardedDeployment, MonitNode, MySqlNode, NginxController, NodeJsWebAppService, PostgreSqlNode, QpidBroker, RabbitBroker, RedisCluster, RedisSlave, RedisStore, RiakCluster, RiakNode, RubyRepNode, SameServerEntity, ServerPool, SimpleApplication, SoftwareProcess, SolrServer, StartableApplication, Storm, StormDeployment, Tomcat8Server, TomcatServer, VanillaJavaApp, VanillaSoftwareProcess, VanillaWindowsProcess, ZooKeeperEnsemble, ZooKeeperNode

All Known Implementing Classes:

AbstractApplication, AbstractControllerImpl, AbstractNonProvisionedControllerImpl, AbstractZooKeeperImpl, ActiveMQBrokerImpl, BasicApplicationImpl, BasicStartableImpl, BindDnsServerImpl, BrooklynClusterImpl, BrooklynNodeImpl, CassandraClusterImpl, CassandraDatacenterImpl, CassandraFabricImpl, CassandraNodeImpl, ChefEntityImpl, CoLocatedMongoDBRouterImpl, ControlledDynamicWebAppClusterImpl, CouchbaseClusterImpl, CouchbaseNodeImpl, CouchbaseSyncGatewayImpl, CouchDBClusterImpl, CouchDBNodeImpl, CrateNodeImpl, CumulusRDFApplication, DataEntityImpl, DynamicClusterImpl, DynamicFabricImpl, DynamicRegionsFabricImpl, DynamicWebAppClusterImpl, DynamicWebAppFabricImpl, EffectorStartableImpl, ElasticSearchClusterImpl, ElasticSearchNodeImpl, EmptySoftwareProcessImpl, GlobalWebFabricExample, HighAvailabilityCassandraCluster, JavaWebAppSoftwareProcessImpl, JBoss6ServerImpl, JBoss7ServerImpl, Jetty6ServerImpl, JMSBrokerImpl, KafkaBrokerImpl, KafkaClusterImpl, KafkaZooKeeperImpl, KarafContainerImpl, LoadBalancerClusterImpl, LocalBrooklynNodeImpl, MachineEntityImpl, MariaDbNodeImpl, MongoDBClientImpl, MongoDBConfigServerClusterImpl, MongoDBConfigServerImpl, MongoDBReplicaSetImpl, MongoDBRouterClusterImpl, MongoDBRouterImpl, MongoDBServerImpl, MongoDBShardClusterImpl, MongoDBShardedDeploymentImpl, MonitNodeImpl, MoreTemplate, MySqlNodeImpl, NginxControllerImpl, NodeJsTodoApplication, NodeJsWebAppServiceImpl, PostgreSqlNodeChefImplFromScratch, PostgreSqlNodeImpl, QpidBrokerImpl, RabbitBrokerImpl, RedisClusterImpl, RedisSlaveImpl, RedisStoreImpl, ResilientMongoDbApp, RiakClusterExample, RiakClusterImpl, RiakNodeImpl, RubyRepNodeImpl, SameServerEntityImpl, ServerPoolImpl, SimpleApplicationImpl, SimpleCassandraCluster, SimulatedJBoss7ServerImpl, SimulatedMySqlNodeImpl, SimulatedNginxControllerImpl, SimulatedTheeTierApp, SingleWebServerExample, SoftwareProcessImpl, SolrServerImpl, StandaloneQpidBrokerExample, StormDeploymentImpl, StormImpl, StormSampleApp, Tomcat8ServerImpl, TomcatServerImpl, VanillaJavaAppImpl, VanillaSoftwareProcessImpl, VanillaWindowsProcessImpl, WebClusterDatabaseExample, WebClusterDatabaseExampleApp, WebClusterExample, WideAreaCassandraCluster, ZooKeeperEnsembleImpl, ZooKeeperNodeImpl
```
public interface Startable
```
This interface describes an Entity that can be started and stopped. The Effectors are START, STOP and RESTART. The start effector takes a collection of Location objects as an argument which will cause the entity to be started or stopped in all these locations. The other effectors will stop or restart the entity in the location(s) it is already running in.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Startable.RestartEffectorBody`
`static class`	`Startable.StartEffectorBody`
`static class`	`Startable.StopEffectorBody`

Field Summary

Fields
Modifier and Type	Field and Description
`static Effector<java.lang.Void>`	`RESTART`
`static AttributeSensor<java.lang.Boolean>`	`SERVICE_UP`
`static Effector<java.lang.Void>`	`START`
`static Effector<java.lang.Void>`	`STOP`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`restart()` Restart the entity.
`void`	`start(java.util.Collection<? extends Location> locations)` Start the entity in the given collection of locations.
`void`	`stop()` Stop the entity.

- Field Detail
  - SERVICE_UP
```
static final AttributeSensor<java.lang.Boolean> SERVICE_UP
```
  - START
```
static final Effector<java.lang.Void> START
```
  - STOP
```
static final Effector<java.lang.Void> STOP
```
  - RESTART
```
static final Effector<java.lang.Void> RESTART
```
- Method Detail
  - start
```
void start(java.util.Collection<? extends Location> locations)
```
    Start the entity in the given collection of locations.
    Some entities may define custom Effector implementations which support a richer set of parameters. See the entity-specific START effector declaration.
  - stop
```
void stop()
```
    Stop the entity.
    Some entities may define custom Effector implementations which support a richer set of parameters. See the entity-specific STOP effector declaration.
  - restart
```
void restart()
```
    Restart the entity.
    Some entities may define custom Effector implementations which support a richer set of parameters. See the entity-specific RESTART effector declaration.

Interface Startable

Nested Class Summary

Field Summary

Method Summary

Field Detail

SERVICE_UP

START

STOP

RESTART

Method Detail

start

stop

restart