org.apache.brooklyn.policy.action

Class AbstractScheduledEffectorPolicy

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

All Implemented Interfaces:

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

Direct Known Subclasses:

PeriodicEffectorPolicy, ScheduledEffectorPolicy

public abstract class AbstractScheduledEffectorPolicy
extends AbstractPolicy
implements java.lang.Runnable, SensorEventListener<java.lang.Object>

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<java.lang.String>	EFFECTOR
static ConfigKey<java.util.Map<java.lang.String,java.lang.Object>>	EFFECTOR_ARGUMENTS
static java.lang.String	IMMEDIATELY
static java.lang.String	NOW
static ConfigKey<java.lang.Boolean>	RUNNING
static ConfigKey<java.util.List<java.lang.Long>>	SCHEDULED
static ConfigKey<AttributeSensor<java.lang.Boolean>>	START_SENSOR
static ConfigKey<java.lang.String>	TIME
static java.lang.String	TIME_FORMAT
static ConfigKey<Duration>	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
AbstractScheduledEffectorPolicy()

Method Summary

Modifier and Type	Method and Description
void	destroy() Unsubscribes and clears all managed subscriptions; is called by the owning entity when a policy is removed and should always be called by any subclasses overriding this method
java.util.concurrent.ScheduledExecutorService	getExecutor()
void	init() Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.
void	onEvent(SensorEvent<java.lang.Object> event) The SensorEvent handler method.
void	rebind() Called by framework on rebind (in new-style instances): after configuring, but before the instance is managed, and before adjuncts are attached to entities, and before a reference to an object is shared.
void	resume() Resume the policy
void	run()
void	setEntity(EntityLocal entity)
void	setup()
abstract void	start()

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

TIME_FORMAT

public static final java.lang.String TIME_FORMAT

See Also:

Constant Field Values

NOW

public static final java.lang.String NOW

See Also:

Constant Field Values

IMMEDIATELY

public static final java.lang.String IMMEDIATELY

See Also:

Constant Field Values

EFFECTOR

public static final ConfigKey<java.lang.String> EFFECTOR

EFFECTOR_ARGUMENTS

public static final ConfigKey<java.util.Map<java.lang.String,java.lang.Object>> EFFECTOR_ARGUMENTS

TIME

public static final ConfigKey<java.lang.String> TIME

WAIT

public static final ConfigKey<Duration> WAIT

START_SENSOR

public static final ConfigKey<AttributeSensor<java.lang.Boolean>> START_SENSOR

RUNNING

public static final ConfigKey<java.lang.Boolean> RUNNING

SCHEDULED

public static final ConfigKey<java.util.List<java.lang.Long>> SCHEDULED

Constructor Detail

AbstractScheduledEffectorPolicy

public AbstractScheduledEffectorPolicy()

Method Detail

init

public void init()

Description copied from class: AbstractBrooklynObject

Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.

To preserve backwards compatibility for if the instance is constructed directly, one can call the code below, but that means it will be called after references to this policy have been shared with other entities.

 
 if (isLegacyConstruction()) {
     init();
 }
 
 

Overrides:

init in class AbstractBrooklynObject

rebind

public void rebind()

Description copied from class: AbstractBrooklynObject

Called by framework on rebind (in new-style instances):

• after configuring, but
• before the instance is managed, and
• before adjuncts are attached to entities, and
• before a reference to an object is shared.

Note that AbstractBrooklynObject.init() will not be called on rebind.

If you need to intercept behaviour after adjuncts are attached, consider AbstractEntity.onManagementStarting() (but probably worth raising a discussion on the mailing list!)

Overrides:

rebind in class AbstractBrooklynObject

setup

public void setup()

setEntity

public void setEntity(EntityLocal entity)

Overrides:

setEntity in class AbstractEntityAdjunct

resume

public void resume()

Description copied from interface: Policy

Resume the policy

Specified by:

resume in interface Policy

Overrides:

resume in class AbstractPolicy

destroy

public void destroy()

Description copied from class: AbstractEntityAdjunct

Unsubscribes and clears all managed subscriptions; is called by the owning entity when a policy is removed and should always be called by any subclasses overriding this method

Overrides:

destroy in class AbstractPolicy

start

public abstract void start()

run

public void run()

Specified by:

run in interface java.lang.Runnable

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>

getExecutor

public java.util.concurrent.ScheduledExecutorService getExecutor()