Policy (Brooklyn)

Overview

Package

Class

Deprecated

Index

Help

Brooklyn

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | METHOD

DETAIL: FIELD | METHOD

brooklyn.policy
[Java] Interface Policy

brooklyn.policy.EntityAdjunct
  brooklyn.policy.Policy

All Superinterfaces:: EntityAdjunct

public interface Policy
extends EntityAdjunct

Policies implement actions and thus must be suspendable; policies should continue to evaluate their sensors and indicate their desired planned action even if they aren't invoking them

Method Summary
`java.lang.String`	`getId()` A unique id for this policy.
`java.lang.String`	`getName()` Get the name assigned to this policy.
`boolean`	`isSuspended()` Whether the policy is suspended
`void`	`resume()` Resume the policy
`void`	`suspend()` Suspend the policy

Methods inherited from interface EntityAdjunct
getId, getName, isDestroyed, isRunning

Method Detail

getId

public java.lang.String getId()

A unique id for this policy.

getName

public java.lang.String getName()

Get the name assigned to this policy.

Returns:: the name assigned to the policy.

isSuspended

public boolean isSuspended()

Whether the policy is suspended

resume

public void resume()

Resume the policy

suspend

public void suspend()

Suspend the policy