org.apache.brooklyn.api.objs

Interface BrooklynObject

All Superinterfaces:

Configurable, Identifiable

All Known Subinterfaces:

AbstractController, AbstractGeoDnsService, AbstractGroup, AbstractMongoDBServer, AbstractNonProvisionedController, AbstractVanillaProcess, ActiveMQBroker, ActiveMQDestination, ActiveMQQueue, ActiveMQTopic, AddressableLocation, AmqpServer, AnsibleEntity, Application, AsyncApplication, BalanceableContainer<ItemType>, BalanceableWorkerPool, BaseTest, BasicApplication, BasicEntity, BasicGroup, BasicStartable, BindDnsServer, BrooklynCluster, BrooklynEntityMirror, BrooklynMetrics, BrooklynNode, BrooklynObjectInternal, CassandraCluster, CassandraDatacenter, CassandraFabric, CassandraNode, CatalogItem<T,SpecT>, ChefEntity, Cluster, CoLocatedMongoDBRouter, ConditionalEntity, ControlledDynamicWebAppCluster, CouchbaseCluster, CouchbaseNode, CouchbaseSyncGateway, CouchDBCluster, CouchDBNode, CrateNode, DatabaseNode, DataEntity, DatastoreMixins.DatastoreCommon, DelegateEntity, DockerContainer, DriverDependentEntity<D>, DynamicCluster, DynamicFabric, DynamicGroup, DynamicMultiGroup, DynamicRegionsFabric, DynamicWebAppCluster, DynamicWebAppFabric, ElasticSearchCluster, ElasticSearchNode, EmptySoftwareProcess, EmptyWindowsProcess, Enricher, Entity, EntityAdjunct, EntityInternal, EntityLocal, Fabric, Feed, FollowTheSunPool, GeoscalingDnsService, Group, HazelcastCluster, HazelcastNode, InfrastructureDeploymentTestCase, ItemsInContainersGroup, JavaWebAppService, JavaWebAppService.CanDeployAndUndeploy, JavaWebAppSoftwareProcess, JBoss6Server, JBoss7Server, JcloudsLocationPublic, JcloudsMachineLocation, JcloudsMachineLocationPublic, Jetty6Server, JMSBroker<Q,T>, JMSDestination, KafkaBroker, KafkaCluster, KafkaZooKeeper, KarafContainer, KubernetesMachineLocation, KubernetesPod, KubernetesResource, LoadBalancer, LoadBalancerCluster, LocalBrooklynNode, Location, LocationEntity, LocationInternal, LoopOverGroupMembersTestCase, MachineEntity, MachineLocation, MachineManagementMixins.RichMachineProvisioningLocation<T>, MachineProvisioningLocation<T>, ManagedBundle, MariaDbNode, MessageBroker, MongoDBClient, MongoDBConfigServer, MongoDBConfigServerCluster, MongoDBReplicaSet, MongoDBRouter, MongoDBRouterCluster, MongoDBServer, MongoDBShardCluster, MongoDBShardedDeployment, MonitNode, MoreEntity, Movable, MySqlCluster, MySqlNode, NginxController, NodeJsWebAppService, OpenShiftPod, OpenShiftResource, PaasLocation, ParallelTestCase, Policy, PortForwardManager, PostgreSqlNode, ProvisioningLocation<T>, QpidBroker, QpidDestination, QpidQueue, QpidTopic, QuarantineGroup, RabbitBroker, RedisCluster, RedisShard, RedisSlave, RedisStore, RelativeEntityTestCase, RiakCluster, RiakNode, RubyRepNode, SaltEntity, SameServerEntity, SequenceEntity, SequenceGroup, ServerPool, SimpleApplication, SimpleEntity, SimpleShellCommandTest, SimulatedExternalMonitor, SoftwareProcess, SolrServer, StartableApplication, Storm, StormDeployment, TargetableTestComponent, TestCase, TestEffector, TestEndpointReachable, TestHttpCall, TestSensor, TestSshCommand, TestWinrmCommand, Tier, Tomcat8Server, TomcatServer, UrlMapping, VanillaJavaApp, VanillaSoftwareProcess, VanillaWindowsProcess, WebAppService, ZabbixServer, ZooKeeperEnsemble, ZooKeeperNode

All Known Implementing Classes:

AbstractAggregator, AbstractApplication, AbstractBrooklynObject, AbstractCloudMachineProvisioningLocation, AbstractCommandFeed, AbstractControllerImpl, AbstractControllerImpl.ServerPoolMemberTrackerPolicy, AbstractEnricher, AbstractEntity, AbstractEntityAdjunct, AbstractFailureDetector, AbstractFeed, AbstractGeoDnsServiceImpl, AbstractGeoDnsServiceImpl.MemberTrackingPolicy, AbstractGroupImpl, AbstractInvokeEffectorPolicy, AbstractJcloudsSubnetSshMachineLocation, AbstractLocation, AbstractMachineLocation, AbstractMembershipTrackingPolicy, AbstractMultipleSensorAggregator, AbstractNonProvisionedControllerImpl, AbstractNonProvisionedControllerImpl.MemberTrackingPolicy, AbstractNonProvisionedControllerImpl.ServerPoolMemberTrackerPolicy, AbstractOnNetworkEnricher, AbstractPolicy, AbstractScheduledEffectorPolicy, AbstractTransformer, AbstractTransformingEnricher, AbstractTypeTransformingEnricher, AbstractZooKeeperImpl, ActiveMQBrokerImpl, ActiveMQDestinationImpl, ActiveMQQueueImpl, ActiveMQTopicImpl, AdvertiseWinrmLoginPolicy, AggregatingMachineProvisioningLocation, Aggregator, AnsibleEntityImpl, AsyncApplicationImpl, AsyncApplicationImpl.ServiceStateComputer, AutoScalerPolicy, BalanceableWorkerPoolImpl, BasicApplicationImpl, BasicEntityImpl, BasicGroupImpl, BasicManagedBundle, BasicStartableImpl, BindDnsServerImpl, BindDnsServerImpl.MemberTrackingPolicy, BrooklynClusterImpl, BrooklynEntityMirrorImpl, BrooklynExternalUiModuleEnricher, BrooklynMetricsImpl, BrooklynNodeImpl, CassandraClusterImpl, CassandraDatacenterImpl, CassandraDatacenterImpl.MemberTrackingPolicy, CassandraFabricImpl, CassandraFabricImpl.MemberTrackingPolicy, CassandraNodeImpl, CatalogApplicationItemDto, CatalogEnricherItemDto, CatalogEntityItemDto, CatalogItemDo, CatalogItemDtoAbstract, CatalogLocationItemDto, CatalogPolicyItemDto, CatalogTemplateItemDto, ChefAttributeFeed, ChefEntityImpl, CmdFeed, CoLocatedMongoDBRouterImpl, Combiner, ConditionalEntityImpl, ConditionalSuspendPolicy, ConnectionFailureDetector, ControlledDynamicWebAppClusterImpl, CouchbaseClusterImpl, CouchbaseClusterImpl.MemberTrackingPolicy, CouchbaseNodeImpl, CouchbaseSyncGatewayImpl, CouchDBClusterImpl, CouchDBNodeImpl, CrateNodeImpl, CreateUserPolicy, DashboardAggregator, DataEntityImpl, DelegateEntityImpl, DeltaEnricher, DerbyDatabase, DerbySchema, DockerContainerImpl, DockerJcloudsLocation, DynamicClusterImpl, DynamicFabricImpl, DynamicGroupImpl, DynamicMultiGroupImpl, DynamicRegionsFabricImpl, DynamicWebAppClusterImpl, DynamicWebAppFabricImpl, EffectorStartableImpl, ElasticSearchClusterImpl, ElasticSearchNodeImpl, ElectPrimaryPolicy, EmptySoftwareProcessImpl, EmptyWindowsProcessImpl, FixedListMachineProvisioningLocation, FollowTheSunPolicy, FollowTheSunPoolImpl, FunctionFeed, GeoscalingDnsServiceImpl, HazelcastClusterImpl, HazelcastClusterImpl.MemberTrackingPolicy, HazelcastNodeImpl, HttpFeed, HttpLatencyDetector, Infinispan5Server, InfrastructureDeploymentTestCaseImpl, InvokeEffectorOnCollectionSensorChange, InvokeEffectorOnSensorChange, ItemsInContainersGroupImpl, JavaWebAppSoftwareProcessImpl, JBoss6ServerImpl, JBoss7ServerImpl, JcloudsLocation, JcloudsSshMachineLocation, JcloudsWinRmMachineLocation, Jetty6ServerImpl, JMSBrokerImpl, JMSDestinationImpl, JmxFeed, Joiner, KafkaBrokerImpl, KafkaClusterImpl, KafkaZooKeeperImpl, KarafContainerImpl, KubernetesEmptyMachineLocation, KubernetesLocation, KubernetesPodImpl, KubernetesResourceImpl, KubernetesSshMachineLocation, LoadBalancerClusterImpl, LoadBalancingPolicy, LocalBrooklynNodeImpl, LocalhostMachineProvisioningLocation, LocalhostMachineProvisioningLocation.LocalhostMachine, LocationEntityImpl, LoopOverGroupMembersTestCaseImpl, MachineEntityImpl, MapAggregator, MariaDbNodeImpl, MongoDBClientImpl, MongoDBConfigServerClusterImpl, MongoDBConfigServerImpl, MongoDBReplicaSetImpl, MongoDBReplicaSetImpl.MemberTrackingPolicy, MongoDBRouterClusterImpl, MongoDBRouterClusterImpl.MemberTrackingPolicy, MongoDBRouterImpl, MongoDBServerImpl, MongoDBShardClusterImpl, MongoDBShardedDeploymentImpl, MongoDBShardedDeploymentImpl.ColocatedRouterTrackingPolicy, MonitNodeImpl, MoreEntityImpl, MoreLocation, MorePolicy, MoreTemplate, MultiLocation, MySqlClusterImpl, MySqlNodeImpl, NginxControllerImpl, NginxControllerImpl.UrlMappingsMemberTrackerPolicy, NodeJsTodoApplication, NodeJsWebAppServiceImpl, OnPublicNetworkEnricher, OnSubnetNetworkEnricher, OpenShiftLocation, OpenShiftPodImpl, OpenShiftResourceImpl, ParallelTestCaseImpl, PercentageEnricher, PeriodicEffectorPolicy, PortForwardManagerAuthority, PortForwardManagerClient, PortForwardManagerImpl, PostgreSqlNodeChefImplFromScratch, PostgreSqlNodeImpl, PostgreSqlNodeSaltImpl, PrimaryRunningEnricher, PropagatePrimaryEnricher, Propagator, QpidBrokerImpl, QpidDestinationImpl, QpidQueueImpl, QpidTopicImpl, QuarantineGroupImpl, RabbitBrokerImpl, RabbitDestination, RabbitQueue, RedisClusterImpl, RedisShardImpl, RedisSlaveImpl, RedisStoreImpl, Reducer, RelativeEntityTestCaseImpl, RiakClusterImpl, RiakClusterImpl.MemberTrackingPolicy, RiakNodeImpl, RollingMeanEnricher, RollingTimeWindowMeanEnricher, RubyRepNodeImpl, SaltEntityImpl, SameServerEntityImpl, ScheduledEffectorPolicy, SequenceEntityImpl, SequenceGroupImpl, ServerPoolImpl, ServerPoolImpl.MemberTrackingPolicy, ServerPoolLocation, ServiceFailureDetector, ServiceReplacer, ServiceRestarter, ServiceStateLogic.ComputeServiceIndicatorsFromChildrenAndMembers, ServiceStateLogic.ComputeServiceState, ShellFeed, SimpleApplicationImpl, SimpleEntityImpl, SimpleLocation, SimplePolicy, SimpleShellCommandTestImpl, SimulatedExternalMonitorImpl, SimulatedJBoss7ServerImpl, SimulatedMySqlNodeImpl, SimulatedNginxControllerImpl, SimulatedTheeTierApp, SimulatedVanillaSoftwareProcessImpl, SingleMachineProvisioningLocation, SingleWebServerExample, SoftwareProcessImpl, SoftwareProcessImpl.ServiceNotUpDiagnosticsCollector, SoftwareProcessImpl.UpdatingNotUpFromServiceProcessIsRunning, SolrServerImpl, SshCommandMembershipTrackingPolicy, SshFeed, SshMachineFailureDetector, SshMachineLocation, StopAfterDurationPolicy, StormDeploymentImpl, StormImpl, SystemServiceEnricher, TargetableTestComponentImpl, TestCaseImpl, TestEffectorImpl, TestEndpointReachableImpl, TestHttpCallImpl, TestSensorImpl, TestSshCommandImpl, TestWinrmCommandImpl, TimeFractionDeltaEnricher, TimeWeightedDeltaEnricher, Tomcat8ServerImpl, TomcatServerImpl, Transformer, UpdatingMap, UrlMappingImpl, VanillaJavaAppImpl, VanillaSoftwareProcessImpl, VanillaWindowsProcessImpl, WebClusterDatabaseExample, WebClusterDatabaseExampleApp, WebClusterExample, WindowsPerformanceCounterFeed, WinRmMachineLocation, YamlRollingTimeWindowMeanEnricher, YamlTimeWeightedDeltaEnricher, ZabbixFeed, ZabbixServerImpl, ZabbixServerImpl.AgentTrackingPolicy, ZooKeeperEnsembleImpl, ZooKeeperNodeImpl

public interface BrooklynObject
extends Identifiable, Configurable

Super-type of entity, location, policy and enricher.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BrooklynObject.RelationSupport<T extends BrooklynObject>
static interface	BrooklynObject.SubscriptionSupport
static interface	BrooklynObject.TagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Configurable.ConfigurationSupport

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCatalogItemId() The catalog item ID this object was loaded from.
java.util.List<java.lang.String>	getCatalogItemIdSearchPath() An immutable list of ids of catalog items that this item depends on in some way, with the item that directly defines it implicit, but other items it references explicit.
java.lang.String	getDisplayName() A display name; recommended to be a concise single-line description.
BrooklynObject.RelationSupport<?>	relations() Relations specify a typed, directed connection between two entities.
BrooklynObject.SubscriptionSupport	subscriptions() Subscriptions are the mechanism for receiving notifications of sensor-events (e.g.
BrooklynObject.TagSupport	tags() Tags are arbitrary objects which can be attached to an entity for subsequent reference.

Methods inherited from interface org.apache.brooklyn.api.objs.Identifiable

getId

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig

Method Detail

getDisplayName

java.lang.String getDisplayName()

A display name; recommended to be a concise single-line description.

getCatalogItemId

java.lang.String getCatalogItemId()

The catalog item ID this object was loaded from.

This can be used to understand the appropriate classloading context, such as for versioning purposes, as well as meta-information such as branding (maybe you can even get an icon) and potentially things like resource lifecycle (if a software version is being sunsetted).

In some cases this may be set heuristically from context and so may not be accurate. Callers can set an explicit catalog item ID if inferencing is not correct.

This should conform to OSGi specs for symbolic_name:version but weaker semantics are usually allowed so long as neither segment contains a : or whitespace.

getCatalogItemIdSearchPath

java.util.List<java.lang.String> getCatalogItemIdSearchPath()

An immutable list of ids of catalog items that this item depends on in some way, with the item that directly defines it implicit, but other items it references explicit. Wrapping items are first in the list (i.e. wrapping items precede wrapped items), so for example, if the catalog is:

     items:
     - id: X
     - id: Y
       item: X
     - id: Z
       item: Y
 

the spec for Z will have getCatalogId() of Z and getCatalogItemIdSearchPath() of Y, X. (The self catalog ID is implicit at the head of the search path.)

tags

BrooklynObject.TagSupport tags()

Tags are arbitrary objects which can be attached to an entity for subsequent reference. They must not be null (as ImmutableMap may be used under the covers; also there is little point!); and they should be amenable to our persistence (on-disk serialization) and our JSON serialization in the REST API.

subscriptions

BrooklynObject.SubscriptionSupport subscriptions()

Subscriptions are the mechanism for receiving notifications of sensor-events (e.g. attribute-changed) from other entities.

relations

BrooklynObject.RelationSupport<?> relations()

Relations specify a typed, directed connection between two entities. Generic type is overridden in sub-interfaces.