org.apache.brooklyn.api.sensor

Interface Feed

All Superinterfaces:

BrooklynObject, Configurable, EntityAdjunct, Identifiable, Rebindable

All Known Implementing Classes:

AbstractCommandFeed, AbstractFeed, ChefAttributeFeed, CmdFeed, FunctionFeed, HttpFeed, JmxFeed, ShellFeed, SshFeed, WindowsPerformanceCounterFeed, ZabbixFeed

public interface Feed
extends EntityAdjunct, Rebindable

A sensor feed. These generally poll or subscribe to get sensor values for an entity. They make it easy to poll over http, jmx, etc. Assumes:

• There will not be concurrent calls to start and stop.
• There will only be one call to start and that will be done immediately after construction, in the same thread.
• Once stopped, the feed will not be re-started.

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
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	isSuspended()
BrooklynObject.RelationSupport<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	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 interface org.apache.brooklyn.api.objs.EntityAdjunct

getHighlights, getId, 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

isActivated

boolean isActivated()

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

start

void start()

suspend

void suspend()

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

isSuspended

boolean isSuspended()

resume

void resume()

resumes this feed if it has been suspended and not stopped

stop

void stop()

getRebindSupport

RebindSupport<FeedMemento> 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<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