org.apache.brooklyn.core.objs

Class AbstractEntityAdjunct

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.objs.AbstractEntityAdjunct

All Implemented Interfaces:

Rebindable, BrooklynObject, Configurable, EntityAdjunct, Identifiable, BrooklynObjectInternal

Direct Known Subclasses:

AbstractEnricher, AbstractFeed, AbstractPolicy

public abstract class AbstractEntityAdjunct
extends AbstractBrooklynObject
implements BrooklynObjectInternal, EntityAdjunct, Configurable

Common functionality for policies and enrichers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractEntityAdjunct.AdjunctTagSupport
class	AbstractEntityAdjunct.BasicSubscriptionSupport

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

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HIGHLIGHT_NAME_LAST_ACTION Name of a highlight that indicates the last action taken by this adjunct.
static java.lang.String	HIGHLIGHT_NAME_LAST_CONFIRMATION Name of a highlight that indicates the last confirmation detected by this adjunct.
static java.lang.String	HIGHLIGHT_NAME_LAST_VIOLATION Name of a highlight that indicates the last violation detected by this adjunct.
static java.lang.String	HIGHLIGHT_NAME_TRIGGERS Name of a highlight that indicates the triggers for this adjunct.

Constructor Summary

Constructors

Constructor and Description
AbstractEntityAdjunct()
AbstractEntityAdjunct(java.util.Map properties)

Method Summary

Modifier and Type	Method and Description
BrooklynObjectInternal.ConfigurationSupportInternal	config()
AbstractEntityAdjunct	configure(java.util.Map flags) Deprecated. since 0.7.0; only used for legacy brooklyn types where constructor is called directly
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
AdjunctType	getAdjunctType()
<T> T	getConfig(ConfigKey<T> key) Convenience for calling Configurable.ConfigurationSupport.get(ConfigKey), via code like config().get(key).
java.lang.String	getDisplayName() A display name; recommended to be a concise single-line description.
Entity	getEntity()
ExecutionContext	getExecutionContext() If the entity has been set, returns the execution context indicating this adjunct.
java.util.Map<java.lang.String,HighlightTuple>	getHighlights()
ManagementContext	getManagementContext()
java.lang.String	getUniqueTag() An optional tag used to identify adjuncts with a specific purpose, typically created by the caller.
boolean	isDestroyed() Whether the adjunct is destroyed
boolean	isRunning() Whether the adjunct is available/active, ie started and not stopped or interrupted
void	setDisplayName(java.lang.String name)
void	setEntity(EntityLocal entity)
void	setHighlights(java.util.Map<java.lang.String,HighlightTuple> highlights) Should only be used for rebind
AbstractEntityAdjunct.BasicSubscriptionSupport	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.
java.lang.String	toString()

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

addSearchPath, getCatalogItemId, getCatalogItemIdSearchPath, getId, init, rebind, relations, 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.core.objs.BrooklynObjectInternal

addSearchPath, getRebindSupport, relations, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

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

getId

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

getCatalogItemId, getCatalogItemIdSearchPath

Field Detail

HIGHLIGHT_NAME_LAST_ACTION

public static java.lang.String HIGHLIGHT_NAME_LAST_ACTION

Name of a highlight that indicates the last action taken by this adjunct.

HIGHLIGHT_NAME_LAST_CONFIRMATION

public static java.lang.String HIGHLIGHT_NAME_LAST_CONFIRMATION

Name of a highlight that indicates the last confirmation detected by this adjunct.

HIGHLIGHT_NAME_LAST_VIOLATION

public static java.lang.String HIGHLIGHT_NAME_LAST_VIOLATION

Name of a highlight that indicates the last violation detected by this adjunct.

HIGHLIGHT_NAME_TRIGGERS

public static java.lang.String HIGHLIGHT_NAME_TRIGGERS

Name of a highlight that indicates the triggers for this adjunct.

Constructor Detail

AbstractEntityAdjunct

public AbstractEntityAdjunct()

AbstractEntityAdjunct

public AbstractEntityAdjunct(java.util.Map properties)

Method Detail

configure

@Deprecated
public AbstractEntityAdjunct configure(java.util.Map flags)

Deprecated. since 0.7.0; only used for legacy brooklyn types where constructor is called directly

Description copied from class: AbstractBrooklynObject

Will set fields from flags, and put the remaining ones into the 'leftovers' map. For some types, you can find unused config via ConfigBag.getUnusedConfig().

To be overridden by AbstractEntity, AbstractLoation, AbstractPolicy, AbstractEnricher, etc.

But should not be overridden by specific entity types. If you do, the entity may break in subsequent releases. Also note that if you require fields to be initialized you must do that in this method. You must *not* rely on field initializers because they may not run until *after* this method (this method is invoked by the constructor in this class, so initializers in subclasses will not have run when this overridden method is invoked.)

getExecutionContext

public ExecutionContext getExecutionContext()

If the entity has been set, returns the execution context indicating this adjunct. Primarily intended for this adjunct to execute tasks, but in some cases, mainly low level, it may make sense for other components to execute tasks against this adjunct.

config

public BrooklynObjectInternal.ConfigurationSupportInternal config()

Specified by:

config in interface Configurable

Specified by:

config in interface BrooklynObjectInternal

subscriptions

public AbstractEntityAdjunct.BasicSubscriptionSupport subscriptions()

Description copied from interface: BrooklynObject

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

Specified by:

subscriptions in interface BrooklynObject

Specified by:

subscriptions in interface BrooklynObjectInternal

getConfig

public <T> T getConfig(ConfigKey<T> key)

Description copied from interface: Configurable

Convenience for calling Configurable.ConfigurationSupport.get(ConfigKey), via code like config().get(key).

Specified by:

getConfig in interface Configurable

getAdjunctType

public AdjunctType getAdjunctType()

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: BrooklynObject

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

Specified by:

getDisplayName in interface BrooklynObject

setDisplayName

public void setDisplayName(java.lang.String name)

Specified by:

setDisplayName in class AbstractBrooklynObject

getManagementContext

public ManagementContext getManagementContext()

Specified by:

getManagementContext in interface BrooklynObjectInternal

Overrides:

getManagementContext in class AbstractBrooklynObject

setEntity

public void setEntity(EntityLocal entity)

getEntity

public Entity getEntity()

destroy

public 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

isDestroyed

public boolean isDestroyed()

Description copied from interface: EntityAdjunct

Whether the adjunct is destroyed

Specified by:

isDestroyed in interface EntityAdjunct

isRunning

public boolean isRunning()

Description copied from interface: EntityAdjunct

Whether the adjunct is available/active, ie started and not stopped or interrupted

Specified by:

isRunning in interface EntityAdjunct

getUniqueTag

public java.lang.String getUniqueTag()

Description copied from interface: EntityAdjunct

An optional tag used to identify adjuncts with a specific purpose, typically created by the caller. This is used to prevent multiple instances with the same purpose from being created, and to access and customize adjuncts so created.

This will be included in the call to #getTags().

Specified by:

getUniqueTag in interface EntityAdjunct

tags

public BrooklynObject.TagSupport tags()

Description copied from interface: BrooklynObject

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.

Specified by:

tags in interface BrooklynObject

Overrides:

tags in class AbstractBrooklynObject

getHighlights

public java.util.Map<java.lang.String,HighlightTuple> getHighlights()

Specified by:

getHighlights in interface EntityAdjunct

setHighlights

public void setHighlights(java.util.Map<java.lang.String,HighlightTuple> highlights)

Should only be used for rebind

Parameters:

highlights -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object