org.apache.brooklyn.enricher.stock.aggregator

Class DashboardAggregator

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.objs.AbstractEntityAdjunct

org.apache.brooklyn.core.enricher.AbstractEnricher

org.apache.brooklyn.enricher.stock.aggregator.DashboardAggregator

All Implemented Interfaces:

Rebindable, BrooklynObject, Configurable, EntityAdjunct, Identifiable, Enricher, BrooklynObjectInternal

public class DashboardAggregator
extends AbstractEnricher

The DashboardAggregator is an enricher that combines config/sensor values from the children of the entity it is attached to. The combined values are set as sensors on the entity that it is attached to. Preference is given to the child entities sensors values, but if none are set, config values are used instead. The reason that this exists is to provide high level summary information, that could be useful to display on a dashboard. Whilst brooklyn itself has no such dashboard, we can imagine this entity being used in that fashion. Please note, that the DashboardAggregator will aggregate all descendants of the entity it is attached to, even intermediate level children. Therefore, please only ever attach one DashboardAggregator to the top most entity. For a detailed list of the config that is combined, please see the AggregationJob class.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

AbstractEntityAdjunct.AdjunctTagSupport, AbstractEntityAdjunct.BasicSubscriptionSupport

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

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Field Summary

Fields

Modifier and Type	Field and Description
static BasicAttributeSensorAndConfigKey<Duration>	DASHBOARD_AGGREGATION_PERIOD

Fields inherited from class org.apache.brooklyn.core.enricher.AbstractEnricher

SUPPRESS_DUPLICATES

Fields inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

HIGHLIGHT_NAME_LAST_ACTION, HIGHLIGHT_NAME_LAST_CONFIRMATION, HIGHLIGHT_NAME_LAST_VIOLATION, HIGHLIGHT_NAME_TRIGGERS

Constructor Summary

Constructors

Constructor and Description
DashboardAggregator()

Method Summary

Modifier and Type	Method and Description
void	destroy() Unsubscribes and clears all managed subscriptions; is called by the owning entity when a policy is removed and should always be called by any subclasses overriding this method
void	setEntity(EntityLocal entity)

Methods inherited from class org.apache.brooklyn.core.enricher.AbstractEnricher

getEnricherType, getRebindSupport, relations

Methods inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

config, configure, getAdjunctType, getConfig, getDisplayName, getEntity, getExecutionContext, getHighlights, getManagementContext, getUniqueTag, isDestroyed, isRunning, setDisplayName, setHighlights, subscriptions, tags, toString

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

addSearchPath, getCatalogItemId, getCatalogItemIdSearchPath, getId, init, rebind, setCatalogItemId, setCatalogItemIdAndSearchPath, setManagementContext, stackCatalogItemId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.api.sensor.Enricher

getId

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

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

addSearchPath, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

Field Detail

DASHBOARD_AGGREGATION_PERIOD

public static BasicAttributeSensorAndConfigKey<Duration> DASHBOARD_AGGREGATION_PERIOD

Constructor Detail

DashboardAggregator

public DashboardAggregator()

Method Detail

setEntity

public void setEntity(EntityLocal entity)

Overrides:

setEntity in class AbstractEnricher

destroy

public void destroy()

Description copied from class: AbstractEntityAdjunct

Unsubscribes and clears all managed subscriptions; is called by the owning entity when a policy is removed and should always be called by any subclasses overriding this method

Overrides:

destroy in class AbstractEntityAdjunct