org.apache.brooklyn.policy.action

Class ScheduledEffectorPolicy

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.ScheduledEffectorPolicy

All Implemented Interfaces:

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

public class ScheduledEffectorPolicy
extends AbstractScheduledEffectorPolicy

A Policy the executes an Effector at a specific time in the future.

 brooklyn.policies:
   - type: org.apache.brooklyn.policy.action.ScheduledEffectorPolicy
     brooklyn.config:
       effector: update
       time: 12: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 AttributeSensor<java.util.Date>	INVOKE_AT
static AttributeSensor<java.lang.Boolean>	INVOKE_IMMEDIATELY

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
ScheduledEffectorPolicy()

Method Summary

Modifier and Type	Method and Description
void	onEvent(SensorEvent<java.lang.Object> event) The SensorEvent handler method.
void	setEntity(EntityLocal entity)
void	start()

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

destroy, getExecutor, init, rebind, resume, run, 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

INVOKE_IMMEDIATELY

public static final AttributeSensor<java.lang.Boolean> INVOKE_IMMEDIATELY

INVOKE_AT

public static final AttributeSensor<java.util.Date> INVOKE_AT

Constructor Detail

ScheduledEffectorPolicy

public ScheduledEffectorPolicy()

Method Detail

setEntity

public void setEntity(EntityLocal entity)

Overrides:

setEntity in class AbstractScheduledEffectorPolicy

start

public void start()

Specified by:

start in class AbstractScheduledEffectorPolicy

onEvent

public void onEvent(SensorEvent<java.lang.Object> event)

Description copied from interface: SensorEventListener

The SensorEvent handler method.

Specified by:

onEvent in interface SensorEventListener<java.lang.Object>

Overrides:

onEvent in class AbstractScheduledEffectorPolicy