org.apache.brooklyn.core.feed

Class AbstractFeed

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.objs.AbstractEntityAdjunct

org.apache.brooklyn.core.feed.AbstractFeed

All Implemented Interfaces:

Rebindable, BrooklynObject, Configurable, EntityAdjunct, Identifiable, Feed, BrooklynObjectInternal

Direct Known Subclasses:

AbstractCommandFeed, ChefAttributeFeed, FunctionFeed, HttpFeed, JmxFeed, ShellFeed, WindowsPerformanceCounterFeed, ZabbixFeed

public abstract class AbstractFeed
extends AbstractEntityAdjunct
implements Feed

Captures common fields and processes for sensor feeds. These generally poll or subscribe to get sensor values for an entity. They make it easy to poll over http, jmx, etc.

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 ConfigKey<java.lang.Boolean>	ONLY_IF_SERVICE_UP

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
AbstractFeed()

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
EntityLocal	getEntity()
RebindSupport<FeedMemento>	getRebindSupport() Users are strongly discouraged from calling or overriding this method.
boolean	isActivated() True if everything has been _started_ (or it is starting) but not stopped, even if it is suspended; see also EntityAdjunct.isRunning()
boolean	isRunning() Whether the adjunct is available/active, ie started and not stopped or interrupted
boolean	isSuspended()
BrooklynObjectInternal.RelationSupportInternal<Feed>	relations() Relations specify a typed, directed connection between two entities.
void	resume() resumes this feed if it has been suspended and not stopped
void	setEntity(EntityLocal entity)
void	start()
void	stop()
void	suspend() suspends this feed (stops the poller, or indicates that the feed should start in a state where the poller is stopped)

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

config, configure, getAdjunctType, getConfig, getDisplayName, getExecutionContext, getHighlights, getManagementContext, getUniqueTag, isDestroyed, 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.objs.EntityAdjunct

getHighlights, getId, getUniqueTag, isDestroyed

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

ONLY_IF_SERVICE_UP

public static final ConfigKey<java.lang.Boolean> ONLY_IF_SERVICE_UP

Constructor Detail

AbstractFeed

public AbstractFeed()

Method Detail

setEntity

public void setEntity(EntityLocal entity)

Overrides:

setEntity in class AbstractEntityAdjunct

start

public void start()

Specified by:

start in interface Feed

suspend

public void suspend()

Description copied from interface: Feed

suspends this feed (stops the poller, or indicates that the feed should start in a state where the poller is stopped)

Specified by:

suspend in interface Feed

resume

public void resume()

Description copied from interface: Feed

resumes this feed if it has been suspended and not stopped

Specified by:

resume in interface Feed

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

stop

public void stop()

Specified by:

stop in interface Feed

isActivated

public boolean isActivated()

Description copied from interface: Feed

True if everything has been _started_ (or it is starting) but not stopped, even if it is suspended; see also EntityAdjunct.isRunning()

Specified by:

isActivated in interface Feed

getEntity

public EntityLocal getEntity()

Overrides:

getEntity in class AbstractEntityAdjunct

isSuspended

public boolean isSuspended()

Specified by:

isSuspended in interface Feed

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

Overrides:

isRunning in class AbstractEntityAdjunct

getRebindSupport

public RebindSupport<FeedMemento> getRebindSupport()

Description copied from interface: Feed

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

Specified by:

getRebindSupport in interface Feed

Specified by:

getRebindSupport in interface BrooklynObjectInternal

relations

public BrooklynObjectInternal.RelationSupportInternal<Feed> 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

Specified by:

relations in interface Feed

Specified by:

relations in interface BrooklynObjectInternal

Overrides:

relations in class AbstractBrooklynObject