org.apache.brooklyn.entity.group

Interface DynamicMultiGroup

All Superinterfaces:

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

All Known Implementing Classes:

DynamicMultiGroupImpl

public interface DynamicMultiGroup
extends DynamicGroup

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>>	BUCKET_FUNCTION Implements the mapping from Entity to bucket name.
static ConfigKey<EntitySpec<? extends BasicGroup>>	BUCKET_SPEC Determines the type of Group used for the buckets.
static AttributeSensor<java.util.Map<java.lang.String,BasicGroup>>	BUCKETS
static AttributeSensor<java.lang.Void>	RESCAN Notification that a rescan has taken place.
static ConfigKey<java.lang.Long>	RESCAN_INTERVAL Interval (in seconds) between scans of all entities for membership and distribution into buckets.

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

ENTITY_FILTER, RESCAN_EFFECTOR, 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
void	distributeEntities() Distribute entities accepted by the DynamicGroup.ENTITY_FILTER into uniquely-named buckets according to the BUCKET_FUNCTION.

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

addSubscription, addSubscription, entityFilter, rescanEntities, setEntityFilter, 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

BUCKET_FUNCTION

static final ConfigKey<<any>> BUCKET_FUNCTION

Implements the mapping from Entity to bucket name.

See Also:

DynamicMultiGroupImpl.bucketFromAttribute(org.apache.brooklyn.api.sensor.AttributeSensor), DynamicMultiGroupImpl.bucketFromAttribute(org.apache.brooklyn.api.sensor.AttributeSensor, String)

BUCKET_SPEC

static final ConfigKey<EntitySpec<? extends BasicGroup>> BUCKET_SPEC

Determines the type of Group used for the buckets.

See Also:

BasicGroup

BUCKETS

static final AttributeSensor<java.util.Map<java.lang.String,BasicGroup>> BUCKETS

RESCAN_INTERVAL

static final ConfigKey<java.lang.Long> RESCAN_INTERVAL

Interval (in seconds) between scans of all entities for membership and distribution into buckets.

RESCAN

static final AttributeSensor<java.lang.Void> RESCAN

Notification that a rescan has taken place.

Method Detail

distributeEntities

void distributeEntities()

Distribute entities accepted by the DynamicGroup.ENTITY_FILTER into uniquely-named buckets according to the BUCKET_FUNCTION.

A Group entity is created for each required bucket and added as a managed child of this component. Entities for a given bucket are added as members of the corresponding group. By default BasicGroup instances will be created for the buckets, however any group entity can be used instead (e.g. with custom effectors) by specifying the relevant entity spec via the BUCKET_SPEC config key.

Entities for which the bucket function returns null are not allocated to any bucket and are thus effectively excluded. Buckets that become empty following re-evaluation are removed.

See Also:

DynamicGroup.ENTITY_FILTER, BUCKET_FUNCTION, #GROUP_SPEC