Overview  Package   Class  Deprecated  Index  Help 
Brooklyn
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

brooklyn.policy.basic
[Java] Class AbstractPolicy

java.lang.Object
  brooklyn.policy.basic.AbstractEntityAdjunct
      brooklyn.policy.basic.AbstractPolicy
All Implemented Interfaces:
Policy
public abstract class AbstractPolicy
extends AbstractEntityAdjunct

Base Policy implementation; all policies should extend this or its children

Field Summary
protected ExecutionContext execution

protected java.util.Map leftoverProperties

protected java.lang.String policyStatus

protected java.util.concurrent.atomic.AtomicBoolean suspended

 
Fields inherited from class AbstractEntityAdjunct
_subscriptionTracker, entity, id, name
 
Constructor Summary
AbstractPolicy()

AbstractPolicy(java.util.Map flags)

 
Method Summary
protected void configure()

will set fields from flags, and put the remaining ones into the 'leftovers' map.

protected void configure(java.util.Map properties)

void destroy()

boolean isRunning()

boolean isSuspended()

void resume()

void suspend()

java.lang.String toString()

 
Methods inherited from class AbstractEntityAdjunct
check, destroy, getAllSubscriptions, getId, getManagementContext, getName, getSubscriptionTracker, isDestroyed, isRunning, setEntity, setId, setName, subscribe, subscribeToChildren, subscribeToMembers, unsubscribe, unsubscribe
 

Field Detail

execution

protected ExecutionContext execution

leftoverProperties

protected java.util.Map leftoverProperties

policyStatus

protected java.lang.String policyStatus

suspended

protected java.util.concurrent.atomic.AtomicBoolean suspended

 
Constructor Detail

AbstractPolicy

public AbstractPolicy()

AbstractPolicy

public AbstractPolicy(java.util.Map flags)

 
Method Detail

configure

protected void configure()
will set fields from flags, and put the remaining ones into the 'leftovers' map. can be subclassed for custom initialization but note the following.

if you require fields to be initialized you must do that in this method. You must *not* rely on field initializers because they may not run until *after* this method (this method is invoked by the constructor in this class, so initializers in subclasses will not have run when this overridden method is invoked.)

configure

protected void configure(java.util.Map properties)

destroy

@Override
public void destroy()

isRunning

@Override
public boolean isRunning()

isSuspended

public boolean isSuspended()

resume

public void resume()

suspend

public void suspend()

toString

@Override
public java.lang.String toString()

 

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.