org.apache.brooklyn.feed.http

Class HttpFeed

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.objs.AbstractEntityAdjunct

org.apache.brooklyn.core.feed.AbstractFeed

org.apache.brooklyn.feed.http.HttpFeed

All Implemented Interfaces:

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

public class HttpFeed
extends AbstractFeed

Provides a feed of attribute values, by polling over http. Example usage (e.g. in an entity that extends SoftwareProcessImpl):

 
 private HttpFeed feed;
 
 //@Override
 protected void connectSensors() {
   super.connectSensors();
   
   feed = HttpFeed.builder()
       .entity(this)
       .period(200)
       .baseUri(String.format("http://%s:%s/management/subsystem/web/connector/http/read-resource", host, port))
       .baseUriVars(ImmutableMap.of("include-runtime","true"))
       .poll(new HttpPollConfig<Boolean>(SERVICE_UP)
           .onSuccess(HttpValueFunctions.responseCodeEquals(200))
           .onError(Functions.constant(false)))
       .poll(new HttpPollConfig<Integer>(REQUEST_COUNT)
           .onSuccess(HttpValueFunctions.jsonContents("requestCount", Integer.class)))
       .build();
 }
 
 {@literal @}Override
 protected void disconnectSensors() {
   super.disconnectSensors();
   if (feed != null) feed.stop();
 }
 
 

This also supports giving a Supplier for the URL (e.g. Entities#attributeSupplier(org.apache.brooklyn.api.entity.Entity, org.apache.brooklyn.api.event.AttributeSensor)) from a sensor. Note however that if a Supplier-based sensor is *https*, https-specific initialization may not occur if the URL is not available at start time, and it may report errors if that sensor is not available. Some guidance for controlling enablement of a feed based on availability of a sensor can be seen in HttpLatencyDetector (in brooklyn-policy).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpFeed.Builder

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 org.slf4j.Logger	log
static ConfigKey<<any>>	POLLS

Fields inherited from class org.apache.brooklyn.core.feed.AbstractFeed

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
HttpFeed() For rebind; do not call directly; use builder

Method Summary

Modifier and Type	Method and Description
static HttpFeed.Builder	builder()

Methods inherited from class org.apache.brooklyn.core.feed.AbstractFeed

destroy, getEntity, getRebindSupport, isActivated, isRunning, isSuspended, relations, resume, setEntity, start, stop, suspend

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

log

public static final org.slf4j.Logger log

POLLS

public static final ConfigKey<<any>> POLLS

Constructor Detail

HttpFeed

public HttpFeed()

For rebind; do not call directly; use builder

Method Detail

builder

public static HttpFeed.Builder builder()