org.apache.brooklyn.api.sensor

Interface Enricher

All Superinterfaces:

BrooklynObject, Configurable, EntityAdjunct, Identifiable, Rebindable

All Known Implementing Classes:

AbstractAggregator, AbstractEnricher, AbstractMultipleSensorAggregator, AbstractOnNetworkEnricher, AbstractTransformer, AbstractTransformingEnricher, AbstractTypeTransformingEnricher, Aggregator, AsyncApplicationImpl.ServiceStateComputer, BrooklynExternalUiModuleEnricher, Combiner, DashboardAggregator, DeltaEnricher, HttpLatencyDetector, Joiner, MapAggregator, OnPublicNetworkEnricher, OnSubnetNetworkEnricher, PercentageEnricher, PrimaryRunningEnricher, PropagatePrimaryEnricher, Propagator, Reducer, RollingMeanEnricher, RollingTimeWindowMeanEnricher, ServiceFailureDetector, ServiceStateLogic.ComputeServiceIndicatorsFromChildrenAndMembers, ServiceStateLogic.ComputeServiceState, SoftwareProcessImpl.ServiceNotUpDiagnosticsCollector, SoftwareProcessImpl.UpdatingNotUpFromServiceProcessIsRunning, SystemServiceEnricher, TimeFractionDeltaEnricher, TimeWeightedDeltaEnricher, Transformer, UpdatingMap, YamlRollingTimeWindowMeanEnricher, YamlTimeWeightedDeltaEnricher

public interface Enricher
extends EntityAdjunct, Rebindable, Configurable

Publishes metrics for an entity, e.g. aggregating information from other sensors/entities. Has some similarities to Policy. However, enrichers specifically do not invoke effectors and should only function to publish new metrics.

Nested Class Summary

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

BrooklynObject.RelationSupport<T extends BrooklynObject>, BrooklynObject.SubscriptionSupport, BrooklynObject.TagSupport

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

Configurable.ConfigurationSupport

Method Summary

Modifier and Type	Method and Description
EnricherType	getEnricherType() Information about the type of this entity; analogous to Java's object.getClass.
java.lang.String	getId() A unique id for this enricher.
RebindSupport<EnricherMemento>	getRebindSupport() Users are strongly discouraged from calling or overriding this method.
BrooklynObject.RelationSupport<Enricher>	relations() Relations specify a typed, directed connection between two entities.

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

getHighlights, getUniqueTag, isDestroyed, isRunning

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

getCatalogItemId, getCatalogItemIdSearchPath, getDisplayName, subscriptions, tags

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

config, getConfig

Method Detail

getId

java.lang.String getId()

A unique id for this enricher.

Specified by:

getId in interface EntityAdjunct

Specified by:

getId in interface Identifiable

getEnricherType

EnricherType getEnricherType()

Information about the type of this entity; analogous to Java's object.getClass.

getRebindSupport

RebindSupport<EnricherMemento> getRebindSupport()

Users are strongly discouraged from calling or overriding this method. It is for internal calls only, relating to persisting/rebinding entities. This method may change (or be removed) in a future release without notice.

Specified by:

getRebindSupport in interface Rebindable

relations

BrooklynObject.RelationSupport<Enricher> relations()

Description copied from interface: BrooklynObject

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

Specified by:

relations in interface BrooklynObject