FeedConfig (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.core.feed.FeedConfig<V,T,F>

Direct Known Subclasses:

JmxNotificationSubscriptionConfig, PollConfig
```
public class FeedConfig<V,T,F extends FeedConfig<V,T,F>>
extends java.lang.Object
```
Configuration for a poll, or a subscription etc, that is being added to a feed.

Field Summary

Fields
Modifier and Type	Field and Description
`static AttributeSensor<java.lang.Void>`	`NO_SENSOR` Indicates that no sensor is being used here.
`static java.lang.Object`	`REMOVE` The onSuccess or onError functions can return this value to indicate that the sensor value should be removed (cf 'null', but useful in dynamic situations)
`static java.lang.Object`	`UNCHANGED` The onSuccess or onError functions can return this value to indicate that the sensor should not change.

Constructor Summary

Constructors
Constructor and Description

FeedConfig(AttributeSensor<T> sensor)

FeedConfig(FeedConfig<V,T,F> other)

Constructors
Constructor and Description
`FeedConfig(AttributeSensor<T> sensor)`
`FeedConfig(FeedConfig<V,T,F> other)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`F`	`checkSuccess(<any> val)` sets the predicate used to check whether a feed run is successful
`F`	`checkSuccess(<any> val)` as `#checkSuccess(Predicate)`
`F`	`enabled(boolean val)` Whether this feed is enabled (defaulting to true).
`boolean`	`equals(java.lang.Object obj)`
`<any>`	`getCheckSuccess()`
`Duration`	`getLogWarningGraceTime()`
`Duration`	`getLogWarningGraceTimeOnStartup()`
`<any>`	`getOnException()`
`<any>`	`getOnFailure()`
`<any>`	`getOnSuccess()`
`AttributeSensor<T>`	`getSensor()`
`boolean`	`getSupressDuplicates()`
`boolean`	`hasCheckSuccessHandler()`
`boolean`	`hasExceptionHandler()`
`boolean`	`hasFailureHandler()`
`int`	`hashCode()`
`boolean`	`hasSuccessHandler()`
`boolean`	`isEnabled()`
`F`	`logWarningGraceTime(Duration val)`
`F`	`logWarningGraceTimeOnStartup(Duration val)`
`F`	`onException(<any> val)` An exception is when there is an error in the communication
`F`	`onFailure(<any> val)` A failure is when the connection is fine (no exception) but the other end returns a result object V which the feed can tell indicates a failure (e.g.
`F`	`onFailureOrException(<any> val)` A convenience for indicating a behaviour to occur for both `#onException(Function)` (error connecting) and `#onFailure(Function)` (successful communication but failure report from remote end)
`F`	`onResult(<any> val)` Registers a callback to be used by `#onSuccess(Function)` and `#onFailure(Function)`, i.e.
`F`	`onSuccess(<any> val)`
`F`	`setOnException(T val)`
`F`	`setOnFailure(T val)`
`F`	`setOnFailureOrException(T val)`
`F`	`setOnResult(T val)`
`F`	`setOnSuccess(T val)`
`F`	`suppressDuplicates(boolean val)`
`java.lang.String`	`toString()`

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

- Field Detail
  - UNCHANGED
```
public static final java.lang.Object UNCHANGED
```
    The onSuccess or onError functions can return this value to indicate that the sensor should not change.
  - REMOVE
```
public static final java.lang.Object REMOVE
```
    The onSuccess or onError functions can return this value to indicate that the sensor value should be removed (cf 'null', but useful in dynamic situations)
  - NO_SENSOR
```
public static final AttributeSensor<java.lang.Void> NO_SENSOR
```
    Indicates that no sensor is being used here. This sensor is suppressed, but is useful where you want to use the feeds with custom success/exception/failure functions which directly set multiple sensors, e.g. dynamically based on the poll response.
    See HttpPollConfig.forMultiple() and its usages. (It can work for any poll config, but conveniences have not been supplied for others.)
- Constructor Detail
  - FeedConfig
```
public FeedConfig(AttributeSensor<T> sensor)
```
  - FeedConfig
```
public FeedConfig(FeedConfig<V,T,F> other)
```
- Method Detail
  - getSensor
```
public AttributeSensor<T> getSensor()
```
  - getCheckSuccess
```
public <any> getCheckSuccess()
```
  - getOnSuccess
```
public <any> getOnSuccess()
```
  - getOnFailure
```
public <any> getOnFailure()
```
  - getOnException
```
public <any> getOnException()
```
  - getSupressDuplicates
```
public boolean getSupressDuplicates()
```
  - isEnabled
```
public boolean isEnabled()
```
  - checkSuccess
```
public F checkSuccess(<any> val)
```
    sets the predicate used to check whether a feed run is successful
  - checkSuccess
```
public F checkSuccess(<any> val)
```
    as #checkSuccess(Predicate)
  - onSuccess
```
public F onSuccess(<any> val)
```
  - setOnSuccess
```
public F setOnSuccess(T val)
```
  - onFailure
```
public F onFailure(<any> val)
```
    A failure is when the connection is fine (no exception) but the other end returns a result object V which the feed can tell indicates a failure (e.g. HTTP code 404)
  - setOnFailure
```
public F setOnFailure(T val)
```
    See Also:
    
    #onFailure(Function)
  - onResult
```
public F onResult(<any> val)
```
    Registers a callback to be used by #onSuccess(Function) and #onFailure(Function), i.e. whenever a result comes back, but not in case of exceptions being thrown (ie problems communicating)
  - setOnResult
```
public F setOnResult(T val)
```
    See Also:
    
    #onResult(Function)
  - onException
```
public F onException(<any> val)
```
    An exception is when there is an error in the communication
  - setOnException
```
public F setOnException(T val)
```
    See Also:
    
    #onException(Function)
  - onFailureOrException
```
public F onFailureOrException(<any> val)
```
    A convenience for indicating a behaviour to occur for both #onException(Function) (error connecting) and #onFailure(Function) (successful communication but failure report from remote end)
  - setOnFailureOrException
```
public F setOnFailureOrException(T val)
```
    See Also:
    
    #onFailureOrException(Function)
  - suppressDuplicates
```
public F suppressDuplicates(boolean val)
```
  - logWarningGraceTimeOnStartup
```
public F logWarningGraceTimeOnStartup(Duration val)
```
  - logWarningGraceTime
```
public F logWarningGraceTime(Duration val)
```
  - getLogWarningGraceTimeOnStartup
```
public Duration getLogWarningGraceTimeOnStartup()
```
  - getLogWarningGraceTime
```
public Duration getLogWarningGraceTime()
```
  - enabled
```
public F enabled(boolean val)
```
    Whether this feed is enabled (defaulting to true).
  - hasSuccessHandler
```
public boolean hasSuccessHandler()
```
  - hasFailureHandler
```
public boolean hasFailureHandler()
```
  - hasExceptionHandler
```
public boolean hasExceptionHandler()
```
  - hasCheckSuccessHandler
```
public boolean hasCheckSuccessHandler()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class FeedConfig<V,T,F extends FeedConfig<V,T,F>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNCHANGED

REMOVE

NO_SENSOR

Constructor Detail

FeedConfig

FeedConfig

Method Detail

getSensor

getCheckSuccess

getOnSuccess

getOnFailure

getOnException

getSupressDuplicates

isEnabled

checkSuccess

checkSuccess

onSuccess

setOnSuccess

onFailure

setOnFailure

onResult

setOnResult

onException

setOnException

onFailureOrException

setOnFailureOrException

suppressDuplicates

logWarningGraceTimeOnStartup

logWarningGraceTime

getLogWarningGraceTimeOnStartup

getLogWarningGraceTime

enabled

hasSuccessHandler

hasFailureHandler

hasExceptionHandler

hasCheckSuccessHandler

toString

hashCode

equals