Policy (Apache Brooklyn)

All Superinterfaces:

BrooklynObject, Configurable, EntityAdjunct, Identifiable, Rebindable

All Known Implementing Classes:

AbstractControllerImpl.ServerPoolMemberTrackerPolicy, AbstractFailureDetector, AbstractGeoDnsServiceImpl.MemberTrackingPolicy, AbstractMembershipTrackingPolicy, AbstractNonProvisionedControllerImpl.MemberTrackingPolicy, AbstractPolicy, AdvertiseWinrmLoginPolicy, AutoScalerPolicy, BindDnsServerImpl.MemberTrackingPolicy, CassandraDatacenterImpl.MemberTrackingPolicy, CassandraFabricImpl.MemberTrackingPolicy, ConditionalSuspendPolicy, ConnectionFailureDetector, CouchbaseClusterImpl.MemberTrackingPolicy, CreateUserPolicy, FollowTheSunPolicy, GeneralPurposePolicy, LoadBalancingPolicy, MemberFailureDetectionPolicy, MongoDBReplicaSetImpl.MemberTrackingPolicy, MongoDBRouterClusterImpl.MemberTrackingPolicy, MongoDBShardedDeploymentImpl.ColocatedRouterTrackingPolicy, MorePolicy, NginxControllerImpl.UrlMappingsMemberTrackerPolicy, RiakClusterImpl.MemberTrackingPolicy, ServerPoolImpl.MemberTrackingPolicy, ServiceReplacer, ServiceRestarter, SimplePolicy, SshMachineFailureDetector, ZooKeeperEnsembleImpl.MemberTrackingPolicy
```
public interface Policy
extends EntityAdjunct, Rebindable, Configurable
```
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

Nested Class Summary
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject
  BrooklynObject.TagSupport
- Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable
  Configurable.ConfigurationSupport

Method Summary

Methods
Modifier and Type	Method and Description
`java.util.Map<ConfigKey<?>,java.lang.Object>`	`getAllConfig()` Deprecated. since 0.7.0; use `Configurable.config()`, such as `policy.config().getBag()`
`<T> T`	`getConfig(ConfigKey<T> key)` Convenience method for `config().get(key)`
`java.lang.String`	`getId()` A unique id for this policy.
`java.lang.String`	`getName()` Deprecated. since 0.7; use `BrooklynObject.getDisplayName()`
`PolicyType`	`getPolicyType()` Information about the type of this entity; analogous to Java's object.getClass.
`RebindSupport<PolicyMemento>`	`getRebindSupport()` Users are strongly discouraged from calling or overriding this method.
`boolean`	`isSuspended()` Whether the policy is suspended
`void`	`resume()` Resume the policy
`<T> T`	`setConfig(ConfigKey<T> key, T val)` Deprecated. since 0.7.0; use `Configurable.config()`, such as `policy.config().setConfig(key, val)`
`void`	`suspend()` Suspend the policy

Methods inherited from interface brooklyn.policy.EntityAdjunct
getUniqueTag, isDestroyed, isRunning

Methods inherited from interface brooklyn.basic.BrooklynObject
getCatalogItemId, getDisplayName, getTagSupport, tags

Methods inherited from interface brooklyn.entity.trait.Configurable
config

- Method Detail
  - getId
```
java.lang.String getId()
```
    A unique id for this policy.
    
    Specified by:
    
    getId in interface EntityAdjunct
    
    Specified by:
    
    getId in interface Identifiable
  - getName
```
@Deprecated
java.lang.String getName()
```
    Deprecated. since 0.7; use BrooklynObject.getDisplayName()
    
    Get the name assigned to this policy.
    
    Specified by:
    
    getName in interface EntityAdjunct
    
    Returns:
    the name assigned to the policy.
  - getPolicyType
```
@Beta
PolicyType getPolicyType()
```
    Information about the type of this entity; analogous to Java's object.getClass.
  - resume
```
void resume()
```
    Resume the policy
  - suspend
```
void suspend()
```
    Suspend the policy
  - isSuspended
```
boolean isSuspended()
```
    Whether the policy is suspended
  - getConfig
```
<T> T getConfig(ConfigKey<T> key)
```
    Convenience method for config().get(key)
  - setConfig
```
@Deprecated
<T> T setConfig(ConfigKey<T> key,
                         T val)
```
    Deprecated. since 0.7.0; use Configurable.config(), such as policy.config().setConfig(key, val)
    
    Specified by:
    
    setConfig in interface Configurable
    
    Returns:
    the old value, or null if there was not one
  - getAllConfig
```
@Deprecated
java.util.Map<ConfigKey<?>,java.lang.Object> getAllConfig()
```
    Deprecated. since 0.7.0; use Configurable.config(), such as policy.config().getBag()
  - getRebindSupport
```
@Beta
RebindSupport<PolicyMemento> getRebindSupport()
```
    Users are strongly discouraged from calling or overriding this method. It is for internal calls only, relating to persisting/rebinding entities. This method may change (or be removed) in a future release without notice.
    
    Specified by:
    
    getRebindSupport in interface Rebindable

Interface Policy

Nested Class Summary

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject

Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable

Method Summary

Methods inherited from interface brooklyn.policy.EntityAdjunct

Methods inherited from interface brooklyn.basic.BrooklynObject

Methods inherited from interface brooklyn.entity.trait.Configurable

Method Detail

getId

getName

getPolicyType

resume

suspend

isSuspended

getConfig

setConfig

getAllConfig

getRebindSupport