org.apache.brooklyn.entity.group

Interface AbstractGroup

All Superinterfaces:

BrooklynObject, Changeable, Configurable, Entity, Group, Identifiable

All Known Subinterfaces:

BalanceableContainer<ItemType>, BasicGroup, BrooklynCluster, CassandraCluster, CassandraDatacenter, CassandraFabric, ControlledDynamicWebAppCluster, CouchbaseCluster, CouchDBCluster, DynamicCluster, DynamicFabric, DynamicGroup, DynamicMultiGroup, DynamicRegionsFabric, DynamicWebAppCluster, DynamicWebAppFabric, ElasticSearchCluster, HazelcastCluster, ItemsInContainersGroup, LoadBalancerCluster, MongoDBConfigServerCluster, MongoDBReplicaSet, MongoDBRouterCluster, MongoDBShardCluster, MySqlCluster, QuarantineGroup, RiakCluster, SequenceGroup, ServerPool, UrlMapping, ZooKeeperEnsemble

All Known Implementing Classes:

AbstractGroupImpl, BasicGroupImpl, BrooklynClusterImpl, CassandraClusterImpl, CassandraDatacenterImpl, CassandraFabricImpl, ControlledDynamicWebAppClusterImpl, CouchbaseClusterImpl, CouchDBClusterImpl, DynamicClusterImpl, DynamicFabricImpl, DynamicGroupImpl, DynamicMultiGroupImpl, DynamicRegionsFabricImpl, DynamicWebAppClusterImpl, DynamicWebAppFabricImpl, ElasticSearchClusterImpl, HazelcastClusterImpl, ItemsInContainersGroupImpl, LoadBalancerClusterImpl, MongoDBConfigServerClusterImpl, MongoDBReplicaSetImpl, MongoDBRouterClusterImpl, MongoDBShardClusterImpl, MySqlClusterImpl, QuarantineGroupImpl, RiakClusterImpl, SequenceGroupImpl, ServerPoolImpl, UrlMappingImpl, ZooKeeperEnsembleImpl

public interface AbstractGroup
extends Entity, Group, Changeable

Represents a group of entities - sub-classes can support dynamically changing membership, ad hoc groupings, etc.

Synchronization model. When changing and reading the group membership, this class uses internal synchronization to ensure atomic operations and the "happens-before" relationship for reads/updates from different threads. Sub-classes should not use this same synchronization mutex when doing expensive operations - e.g. if resizing a cluster, don't block everyone else from asking for the current number of members.

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 AttributeSensor<Entity>	FIRST Deprecated. since 0.12.0 use AbstractGroup.getFirst(Group) if required, or better use an external enricher or policy to define the primary.
static AttributeSensor<java.util.Collection<Entity>>	GROUP_MEMBERS
static ConfigKey<java.lang.Boolean>	MEMBER_DELEGATE_CHILDREN Deprecated. since 0.9.0, the UI no longer relies on the use of delegates to represent group membership (see #929)
static ConfigKey<java.lang.String>	MEMBER_DELEGATE_NAME_FORMAT Deprecated. since 0.12.0, but was only ever used in MEMBER_DELEGATE_CHILDREN was set (so effectively deprecated since 0.9.0).
static ConfigKey<QuorumCheck>	RUNNING_QUORUM_CHECK
static ConfigKey<QuorumCheck>	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
static Entity	getFirst(Group g)
void	setMembers(java.util.Collection<Entity> m)
void	setMembers(java.util.Collection<Entity> mm, <any> filter) Removes any existing members that do not match the given filter, and adds those entities in the given collection that match the predicate.

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

GROUP_MEMBERS

static final AttributeSensor<java.util.Collection<Entity>> GROUP_MEMBERS

FIRST

@Deprecated
static final AttributeSensor<Entity> FIRST

Deprecated. since 0.12.0 use AbstractGroup.getFirst(Group) if required, or better use an external enricher or policy to define the primary.

MEMBER_DELEGATE_CHILDREN

@Deprecated
static final ConfigKey<java.lang.Boolean> MEMBER_DELEGATE_CHILDREN

Deprecated. since 0.9.0, the UI no longer relies on the use of delegates to represent group membership (see #929)

MEMBER_DELEGATE_NAME_FORMAT

@Deprecated
static final ConfigKey<java.lang.String> MEMBER_DELEGATE_NAME_FORMAT

Deprecated. since 0.12.0, but was only ever used in MEMBER_DELEGATE_CHILDREN was set (so effectively deprecated since 0.9.0).

UP_QUORUM_CHECK

static final ConfigKey<QuorumCheck> UP_QUORUM_CHECK

RUNNING_QUORUM_CHECK

static final ConfigKey<QuorumCheck> RUNNING_QUORUM_CHECK

Method Detail

setMembers

void setMembers(java.util.Collection<Entity> m)

setMembers

void setMembers(java.util.Collection<Entity> mm,
                <any> filter)

Removes any existing members that do not match the given filter, and adds those entities in the given collection that match the predicate.

Parameters:

mm - Entities to test against the filter, and to add

filter - Filter for entities that are to be members (or null for "all")

getFirst

static Entity getFirst(Group g)