AbstractFeed (Apache Brooklyn)

java.lang.Object
- brooklyn.basic.AbstractBrooklynObject
- - brooklyn.policy.basic.AbstractEntityAdjunct
  - - brooklyn.event.feed.AbstractFeed

All Implemented Interfaces:

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

Direct Known Subclasses:

ChefAttributeFeed, FunctionFeed, HttpFeed, JmxFeed, ShellFeed, SshFeed, WindowsPerformanceCounterFeed
```
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 interface brooklyn.basic.BrooklynObject
  BrooklynObject.TagSupport

Field Summary

Fields
Modifier and Type Field and Description

static ConfigKey<java.lang.Boolean> ONLY_IF_SERVICE_UP

Fields
Modifier and Type	Field and Description
`static ConfigKey<java.lang.Boolean>`	`ONLY_IF_SERVICE_UP`

Constructor Summary

Constructors
Constructor and Description
`AbstractFeed()`
`AbstractFeed(EntityLocal entity)` Deprecated. since 0.7.0; use no-arg constructor; call `setEntity(EntityLocal)`
`AbstractFeed(EntityLocal entity, boolean onlyIfServiceUp)` Deprecated. since 0.7.0; use no-arg constructor; call `setEntity(EntityLocal)` and `setConfig(ONLY_IF_SERVICE_UP, onlyIfServiceUp)`

Method Summary

Methods
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 `Feed.isActive()`
`boolean`	`isActive()`
`boolean`	`isRunning()` Whether the adjunct is available/active
`boolean`	`isSuspended()`
`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 brooklyn.policy.basic.AbstractEntityAdjunct
configure, getAllConfig, getConfig, getConfigMap, getDisplayName, getName, getUniqueTag, isDestroyed, setConfig, setDisplayName, setName, tags, toString

Methods inherited from class brooklyn.basic.AbstractBrooklynObject
getCatalogItemId, getId, getManagementContext, getTagSupport, init, rebind, setCatalogItemId, setManagementContext

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface brooklyn.policy.EntityAdjunct
getId, getName, getUniqueTag, isDestroyed

Methods inherited from interface brooklyn.basic.BrooklynObject
getCatalogItemId, getDisplayName, getTagSupport, tags

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal
setCatalogItemId

- Field Detail
  - ONLY_IF_SERVICE_UP
```
public static final ConfigKey<java.lang.Boolean> ONLY_IF_SERVICE_UP
```
- Constructor Detail
  - AbstractFeed
```
public AbstractFeed()
```
  - AbstractFeed
```
@Deprecated
public AbstractFeed(EntityLocal entity)
```
    Deprecated. since 0.7.0; use no-arg constructor; call setEntity(EntityLocal)
  - AbstractFeed
```
@Deprecated
public AbstractFeed(EntityLocal entity,
                       boolean onlyIfServiceUp)
```
    Deprecated. since 0.7.0; use no-arg constructor; call setEntity(EntityLocal) and setConfig(ONLY_IF_SERVICE_UP, onlyIfServiceUp)
- Method Detail
  - setEntity
```
public void setEntity(EntityLocal entity)
```
    Overrides:
    
    setEntity in class AbstractEntityAdjunct
  - 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 Feed.isActive()
    
    Specified by:
    
    isActivated in interface Feed
  - isActive
```
public boolean isActive()
```
    Specified by:
    
    isActive in interface Feed
  - getEntity
```
public EntityLocal getEntity()
```
  - 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
  - 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
    
    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 Feed
    
    Specified by:
    
    getRebindSupport in interface Rebindable

Class AbstractFeed

Nested Class Summary

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class brooklyn.policy.basic.AbstractEntityAdjunct

Methods inherited from class brooklyn.basic.AbstractBrooklynObject

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.policy.EntityAdjunct

Methods inherited from interface brooklyn.basic.BrooklynObject

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal

Field Detail

ONLY_IF_SERVICE_UP

Constructor Detail

AbstractFeed

AbstractFeed

AbstractFeed

Method Detail

setEntity

isActivated

isActive

getEntity

start

suspend

resume

destroy

stop

isSuspended

isRunning

getRebindSupport