AbstractMembershipTrackingPolicy (Apache Brooklyn)

java.lang.Object
- brooklyn.basic.AbstractBrooklynObject
- - brooklyn.policy.basic.AbstractEntityAdjunct
  - - brooklyn.policy.basic.AbstractPolicy
    - - brooklyn.entity.group.AbstractMembershipTrackingPolicy

All Implemented Interfaces:

BrooklynObject, BrooklynObjectInternal, Rebindable, Configurable, Identifiable, EntityAdjunct, Policy

Direct Known Subclasses:

AbstractControllerImpl.ServerPoolMemberTrackerPolicy, AbstractGeoDnsServiceImpl.MemberTrackingPolicy, AbstractNonProvisionedControllerImpl.MemberTrackingPolicy, BindDnsServerImpl.MemberTrackingPolicy, CassandraDatacenterImpl.MemberTrackingPolicy, CassandraFabricImpl.MemberTrackingPolicy, CouchbaseClusterImpl.MemberTrackingPolicy, MongoDBReplicaSetImpl.MemberTrackingPolicy, MongoDBRouterClusterImpl.MemberTrackingPolicy, MongoDBShardedDeploymentImpl.ColocatedRouterTrackingPolicy, NginxControllerImpl.UrlMappingsMemberTrackerPolicy, RiakClusterImpl.MemberTrackingPolicy, ServerPoolImpl.MemberTrackingPolicy, ZooKeeperEnsembleImpl.MemberTrackingPolicy
```
public abstract class AbstractMembershipTrackingPolicy
extends AbstractPolicy
```
Abstract class which helps track membership of a group, invoking (empty) methods in this class on MEMBER{ADDED,REMOVED} events, as well as SERVICE_UP {true,false} for those members.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractMembershipTrackingPolicy.EventType
- Nested classes/interfaces inherited from class brooklyn.policy.basic.AbstractEntityAdjunct
  AbstractEntityAdjunct.AdjunctTagSupport
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject
  BrooklynObject.TagSupport
- Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable
  Configurable.ConfigurationSupport
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObjectInternal
  BrooklynObjectInternal.ConfigurationSupportInternal

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractMembershipTrackingPolicy.EventType`

Field Summary

Fields
Modifier and Type	Field and Description
`static ConfigKey<Group>`	`GROUP`
`static ConfigKey<java.lang.Boolean>`	`NOTIFY_ON_DUPLICATES`
`static ConfigKey<java.util.Set<Sensor<?>>>`	`SENSORS_TO_TRACK`

Constructor Summary

Constructors
Constructor and Description

AbstractMembershipTrackingPolicy()

AbstractMembershipTrackingPolicy(java.util.Map<?,?> flags)

Constructors
Constructor and Description
`AbstractMembershipTrackingPolicy()`
`AbstractMembershipTrackingPolicy(java.util.Map<?,?> flags)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`reset()` Deprecated. since 0.7; misleading method name; either remove the policy, or suspend/resume
`void`	`resume()` Resume the policy
`void`	`setEntity(EntityLocal entity)`
`void`	`setGroup(Group group)` Deprecated. since 0.7; instead set the group as config
`void`	`suspend()` Suspend the policy

Methods inherited from class brooklyn.policy.basic.AbstractPolicy
destroy, getPolicyType, getRebindSupport, isRunning, isSuspended, toString

Methods inherited from class brooklyn.policy.basic.AbstractEntityAdjunct
config, configure, getAllConfig, getConfig, getConfigMap, getDisplayName, getName, getUniqueTag, isDestroyed, setConfig, setDisplayName, setName, tags

Methods inherited from class brooklyn.basic.AbstractBrooklynObject
getCatalogItemId, getId, getManagementContext, getTagSupport, init, rebind, setCatalogItemId, setManagementContext

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

Methods inherited from interface brooklyn.policy.Policy
getAllConfig, getConfig, getId, getName, setConfig

Methods inherited from interface brooklyn.policy.EntityAdjunct
getUniqueTag, isDestroyed

Methods inherited from interface brooklyn.basic.BrooklynObject
getCatalogItemId, getDisplayName, getTagSupport, tags

Methods inherited from interface brooklyn.entity.trait.Configurable
config

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal
setCatalogItemId

- Field Detail
  - SENSORS_TO_TRACK
```
public static final ConfigKey<java.util.Set<Sensor<?>>> SENSORS_TO_TRACK
```
  - NOTIFY_ON_DUPLICATES
```
public static final ConfigKey<java.lang.Boolean> NOTIFY_ON_DUPLICATES
```
  - GROUP
```
public static final ConfigKey<Group> GROUP
```
- Constructor Detail
  - AbstractMembershipTrackingPolicy
```
public AbstractMembershipTrackingPolicy(java.util.Map<?,?> flags)
```
  - AbstractMembershipTrackingPolicy
```
public AbstractMembershipTrackingPolicy()
```
- Method Detail
  - setEntity
```
public void setEntity(EntityLocal entity)
```
    Overrides:
    
    setEntity in class AbstractEntityAdjunct
  - setGroup
```
@Deprecated
public void setGroup(Group group)
```
    Deprecated. since 0.7; instead set the group as config
    
    Sets the group to be tracked; unsubscribes from any previous group, and subscribes to this group. Note this must be called *after* adding the policy to the entity.
    
    Parameters:
    group -
  - reset
```
@Deprecated
public void reset()
```
    Deprecated. since 0.7; misleading method name; either remove the policy, or suspend/resume
    
    Unsubscribes from the group.
  - suspend
```
public void suspend()
```
    Description copied from interface: Policy
    
    Suspend the policy
    
    Specified by:
    
    suspend in interface Policy
    
    Overrides:
    
    suspend in class AbstractPolicy
  - resume
```
public void resume()
```
    Description copied from interface: Policy
    
    Resume the policy
    
    Specified by:
    
    resume in interface Policy
    
    Overrides:
    
    resume in class AbstractPolicy

Class AbstractMembershipTrackingPolicy

Nested Class Summary

Nested classes/interfaces inherited from class brooklyn.policy.basic.AbstractEntityAdjunct

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject

Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObjectInternal

Field Summary

Constructor Summary

Method Summary

Methods inherited from class brooklyn.policy.basic.AbstractPolicy

Methods inherited from class brooklyn.policy.basic.AbstractEntityAdjunct

Methods inherited from class brooklyn.basic.AbstractBrooklynObject

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.policy.Policy

Methods inherited from interface brooklyn.policy.EntityAdjunct

Methods inherited from interface brooklyn.basic.BrooklynObject

Methods inherited from interface brooklyn.entity.trait.Configurable

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal

Field Detail

SENSORS_TO_TRACK

NOTIFY_ON_DUPLICATES

GROUP

Constructor Detail

AbstractMembershipTrackingPolicy

AbstractMembershipTrackingPolicy

Method Detail

setEntity

setGroup

reset

suspend

resume