org.apache.brooklyn.policy.action

Class PeriodicEffectorPolicy

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.objs.AbstractEntityAdjunct

org.apache.brooklyn.core.policy.AbstractPolicy

org.apache.brooklyn.policy.action.AbstractScheduledEffectorPolicy

org.apache.brooklyn.policy.action.PeriodicEffectorPolicy

All Implemented Interfaces:

java.lang.Runnable, Rebindable, BrooklynObject, Configurable, EntityAdjunct, Identifiable, Policy, SensorEventListener<java.lang.Object>, BrooklynObjectInternal

public class PeriodicEffectorPolicy
extends AbstractScheduledEffectorPolicy

A Policy that executes an Effector at specific intervals.

The following example shows a pair of policies that resize a cluster from one to ten entities during the day and back to one at night,:

 brooklyn.policies:
   - type: org.apache.brooklyn.policy.action.PeriodicEffectorPolicy
     brooklyn.config:
       effector: resize
       args:
         desiredSize: 10
       period: 1 day
       time: 08:00:00
   - type: org.apache.brooklyn.policy.action.PeriodicEffectorPolicy
     brooklyn.config:
       effector: resize
       args:
         desiredSize: 1
       period: 1 day
       time: 18:00:00
 

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

AbstractEntityAdjunct.AdjunctTagSupport, AbstractEntityAdjunct.BasicSubscriptionSupport

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

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigKey<Duration>	PERIOD

Fields inherited from class org.apache.brooklyn.policy.action.AbstractScheduledEffectorPolicy

EFFECTOR, EFFECTOR_ARGUMENTS, IMMEDIATELY, NOW, RUNNING, SCHEDULED, START_SENSOR, TIME, TIME_FORMAT, WAIT

Fields inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

HIGHLIGHT_NAME_LAST_ACTION, HIGHLIGHT_NAME_LAST_CONFIRMATION, HIGHLIGHT_NAME_LAST_VIOLATION, HIGHLIGHT_NAME_TRIGGERS

Fields inherited from interface org.apache.brooklyn.api.sensor.SensorEventListener

NOOP

Constructor Summary

Constructors

Constructor and Description
PeriodicEffectorPolicy()

Method Summary

Modifier and Type	Method and Description
void	run()
void	start()

Methods inherited from class org.apache.brooklyn.policy.action.AbstractScheduledEffectorPolicy

destroy, getExecutor, init, onEvent, rebind, resume, setEntity, setup

Methods inherited from class org.apache.brooklyn.core.policy.AbstractPolicy

getPolicyType, getRebindSupport, isRunning, isSuspended, relations, suspend, toString

Methods inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

config, configure, getAdjunctType, getConfig, getDisplayName, getEntity, getExecutionContext, getHighlights, getManagementContext, getUniqueTag, isDestroyed, setDisplayName, setHighlights, subscriptions, tags

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

addSearchPath, getCatalogItemId, getCatalogItemIdSearchPath, getId, setCatalogItemId, setCatalogItemIdAndSearchPath, setManagementContext, stackCatalogItemId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.brooklyn.api.policy.Policy

getId

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

getHighlights, getUniqueTag, isDestroyed

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

getCatalogItemId, getCatalogItemIdSearchPath, getDisplayName, subscriptions, tags

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

config, getConfig

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

addSearchPath, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

Field Detail

PERIOD

public static final ConfigKey<Duration> PERIOD

Constructor Detail

PeriodicEffectorPolicy

public PeriodicEffectorPolicy()

Method Detail

start

public void start()

Specified by:

start in class AbstractScheduledEffectorPolicy

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class AbstractScheduledEffectorPolicy