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.Policy
  brooklyn.entity.rebind.Rebindable
      brooklyn.policy.EntityAdjunct
          brooklyn.entity.trait.Identifiable

All Superinterfaces:: Rebindable, EntityAdjunct, Identifiable

public interface Policy
extends EntityAdjunct, Rebindable

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.util.Map`	`getAllConfig()`
`java.lang.Object`	`getConfig(ConfigKey key)`
`java.lang.String`	`getId()` A unique id for this policy.
`java.lang.String`	`getName()` Get the name assigned to this policy.
`PolicyType`	`getPolicyType()` Information about the type of this entity; analogous to Java's object.getClass.
`RebindSupport`	`getRebindSupport()`
`boolean`	`isSuspended()` Whether the policy is suspended
`void`	`resume()` Resume the policy
`java.lang.Object`	`setConfig(ConfigKey key, java.lang.Object val)`
`void`	`suspend()` Suspend the policy

Methods inherited from interface Rebindable
getRebindSupport

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

Methods inherited from interface Identifiable
getId

Method Detail

getAllConfig

public java.util.Map getAllConfig()

getConfig

public java.lang.Object getConfig(ConfigKey key)

getId

@Override
public java.lang.String getId()

A unique id for this policy.

getName

@Override
public java.lang.String getName()

Get the name assigned to this policy.

Returns:: the name assigned to the policy.

getPolicyType

@Beta
public PolicyType getPolicyType()

Information about the type of this entity; analogous to Java's object.getClass.

getRebindSupport

@Override
public RebindSupport getRebindSupport()

isSuspended

public boolean isSuspended()

Whether the policy is suspended

resume

public void resume()

Resume the policy

setConfig

public java.lang.Object setConfig(ConfigKey key, java.lang.Object val)

suspend

public void suspend()

Suspend the policy

brooklyn.policy [Java] Interface Policy