org.apache.brooklyn.policy.failover

Class ElectPrimaryEffector

java.lang.Object

org.apache.brooklyn.policy.failover.ElectPrimaryEffector

All Implemented Interfaces:

EntityInitializer, ElectPrimaryConfig

public class ElectPrimaryEffector
extends java.lang.Object
implements EntityInitializer, ElectPrimaryConfig

This effector will scan candidates among children or members to determine which should be noted as "primary". The primary is selected from service-up candidates based on a numeric weight as a sensor or config on the candidates (`ha.primary.weight`, unless overridden), with higher weights being preferred. In the case of ties, or a new candidate emerging with a weight higher than a current healthy primary, behaviour can be configured with `primary.selection.mode`.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ElectPrimaryEffector.CheckPrimaries
static class	ElectPrimaryEffector.PrimaryTransition
static class	ElectPrimaryEffector.ResultCode

Nested classes/interfaces inherited from interface org.apache.brooklyn.policy.failover.ElectPrimaryConfig

ElectPrimaryConfig.PrimaryDefaultSensorsAndEffectors, ElectPrimaryConfig.SelectionMode, ElectPrimaryConfig.TargetMode

Field Summary

Fields

Modifier and Type	Field and Description
static Effector<java.lang.Object>	EFFECTOR
static AttributeSensor<ElectPrimaryEffector.PrimaryTransition>	PRIMARY_TRANSITION

Fields inherited from interface org.apache.brooklyn.policy.failover.ElectPrimaryConfig

BEST_STARTING_WAIT_TIMEOUT, BEST_WAIT_TIMEOUT, DEMOTE_EFFECTOR_NAME, PRIMARY_SENSOR_NAME, PRIMARY_WEIGHT_NAME, PROMOTE_EFFECTOR_NAME, SELECTION_MODE, TARGET_MODE

Constructor Summary

Constructors

Constructor and Description
ElectPrimaryEffector(ConfigBag params)
ElectPrimaryEffector(java.util.Map<java.lang.String,java.lang.String> params)

Method Summary

Modifier and Type	Method and Description
void	apply(EntityLocal entity) Applies initialization logic to a just-built entity.
static Effector<java.lang.Object>	makeEffector(ConfigBag params)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EFFECTOR

public static final Effector<java.lang.Object> EFFECTOR

PRIMARY_TRANSITION

public static final AttributeSensor<ElectPrimaryEffector.PrimaryTransition> PRIMARY_TRANSITION

Constructor Detail

ElectPrimaryEffector

public ElectPrimaryEffector(ConfigBag params)

ElectPrimaryEffector

public ElectPrimaryEffector(java.util.Map<java.lang.String,java.lang.String> params)

Method Detail

apply

public void apply(EntityLocal entity)

Description copied from interface: EntityInitializer

Applies initialization logic to a just-built entity. Invoked immediately after the "init" call on the AbstractEntity constructed.

Specified by:

apply in interface EntityInitializer

Parameters:

entity - guaranteed to be the actual implementation instance, thus guaranteed to be castable to EntityInternal which is often desired, or to the type at hand (it is not even a proxy)

makeEffector

public static Effector<java.lang.Object> makeEffector(ConfigBag params)