org.apache.brooklyn.entity.group

Interface DynamicGroup

All Superinterfaces:

AbstractGroup, BrooklynObject, Changeable, Configurable, Entity, Group, Identifiable

All Known Subinterfaces:

ControlledDynamicWebAppCluster, DynamicMultiGroup, ItemsInContainersGroup, SequenceGroup

All Known Implementing Classes:

ControlledDynamicWebAppClusterImpl, DynamicGroupImpl, DynamicMultiGroupImpl, ItemsInContainersGroupImpl, SequenceGroupImpl

public interface DynamicGroup
extends AbstractGroup

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.entity.Entity

Entity.AdjunctSupport<T extends EntityAdjunct>, Entity.EnricherSupport, Entity.GroupSupport, Entity.PolicySupport, Entity.SensorSupport

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

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigKey<<any>>	ENTITY_FILTER
static MethodEffector<java.lang.Void>	RESCAN_EFFECTOR
static AttributeSensor<java.lang.Boolean>	RUNNING

Fields inherited from interface org.apache.brooklyn.entity.group.AbstractGroup

FIRST, GROUP_MEMBERS, MEMBER_DELEGATE_CHILDREN, MEMBER_DELEGATE_NAME_FORMAT, RUNNING_QUORUM_CHECK, UP_QUORUM_CHECK

Fields inherited from interface org.apache.brooklyn.core.entity.trait.Changeable

GROUP_SIZE, MEMBER_ADDED, MEMBER_REMOVED

Method Summary

Modifier and Type	Method and Description
<T> void	addSubscription(Entity producer, Sensor<T> sensor) Indicates an entity and/or sensor this group should monitor
<T> void	addSubscription(Entity producer, Sensor<T> sensor, <any> filter) As addSubscription(Entity, Sensor) but with an additional filter.
<any>	entityFilter() Deprecated. since 0.10.0 use config().get(ENTITY_FILTER) instead.
void	rescanEntities() Rescans all entities to determine whether they match the filter.
void	setEntityFilter(<any> filter) Sets ENTITY_FILTER, overriding (and rescanning all) if already set.
void	stop() Deprecated. since 0.7; no longer supported (was only used in tests, and by classes that also implemented Startable.stop()!)

Methods inherited from interface org.apache.brooklyn.entity.group.AbstractGroup

getFirst, setMembers, setMembers

Methods inherited from interface org.apache.brooklyn.api.entity.Group

addChild, addChild, addMember, addMemberChild, addMemberChild, getCurrentSize, getMembers, hasMember, removeMember

Methods inherited from interface org.apache.brooklyn.api.entity.Entity

addFeed, clearParent, enrichers, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getCreationTime, getDisplayName, getEntityType, getIconUrl, getId, getLocations, getParent, groups, invoke, policies, relations, removeChild, sensors, setDisplayName, setParent

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getCatalogItemId, getCatalogItemIdSearchPath, subscriptions, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig

Field Detail

ENTITY_FILTER

static final ConfigKey<<any>> ENTITY_FILTER

RUNNING

static final AttributeSensor<java.lang.Boolean> RUNNING

RESCAN_EFFECTOR

static final MethodEffector<java.lang.Void> RESCAN_EFFECTOR

Method Detail

stop

@Deprecated
void stop()

Deprecated. since 0.7; no longer supported (was only used in tests, and by classes that also implemented Startable.stop()!)

Stops this group.

Does not stop any of its members. De-activates the filter and unsubscribes to entity-updates, so the membership of the group will not change.

rescanEntities

void rescanEntities()

Rescans all entities to determine whether they match the filter.

setEntityFilter

void setEntityFilter(<any> filter)

Sets ENTITY_FILTER, overriding (and rescanning all) if already set.

addSubscription

<T> void addSubscription(Entity producer,
                         Sensor<T> sensor,
                         <any> filter)

As addSubscription(Entity, Sensor) but with an additional filter.

addSubscription

<T> void addSubscription(Entity producer,
                         Sensor<T> sensor)

Indicates an entity and/or sensor this group should monitor

Setting either to null indicates everything should be monitored. Note that subscriptions do not restrict what can be added, they merely ensure prompt membership checking (via ENTITY_FILTER) for those entities so subscribed.

entityFilter

@Deprecated
<any> entityFilter()

Deprecated. since 0.10.0 use config().get(ENTITY_FILTER) instead.