org.apache.brooklyn.api.policy

Interface Policy

All Superinterfaces:

BrooklynObject, Configurable, EntityAdjunct, Identifiable, Rebindable

All Known Implementing Classes:

AbstractControllerImpl.ServerPoolMemberTrackerPolicy, AbstractFailureDetector, AbstractGeoDnsServiceImpl.MemberTrackingPolicy, AbstractInvokeEffectorPolicy, AbstractMembershipTrackingPolicy, AbstractNonProvisionedControllerImpl.MemberTrackingPolicy, AbstractNonProvisionedControllerImpl.ServerPoolMemberTrackerPolicy, AbstractPolicy, AbstractScheduledEffectorPolicy, AdvertiseWinrmLoginPolicy, AutoScalerPolicy, BindDnsServerImpl.MemberTrackingPolicy, CassandraDatacenterImpl.MemberTrackingPolicy, CassandraFabricImpl.MemberTrackingPolicy, ConditionalSuspendPolicy, ConnectionFailureDetector, CouchbaseClusterImpl.MemberTrackingPolicy, CreateUserPolicy, ElectPrimaryPolicy, FollowTheSunPolicy, HazelcastClusterImpl.MemberTrackingPolicy, InvokeEffectorOnCollectionSensorChange, InvokeEffectorOnSensorChange, LoadBalancingPolicy, MongoDBReplicaSetImpl.MemberTrackingPolicy, MongoDBRouterClusterImpl.MemberTrackingPolicy, MongoDBShardedDeploymentImpl.ColocatedRouterTrackingPolicy, MorePolicy, NginxControllerImpl.UrlMappingsMemberTrackerPolicy, PeriodicEffectorPolicy, RiakClusterImpl.MemberTrackingPolicy, ScheduledEffectorPolicy, ServerPoolImpl.MemberTrackingPolicy, ServiceReplacer, ServiceRestarter, SimplePolicy, SshCommandMembershipTrackingPolicy, SshMachineFailureDetector, StopAfterDurationPolicy, ZabbixServerImpl.AgentTrackingPolicy

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 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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() A unique id for this policy.
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
BrooklynObject.RelationSupport<Policy>	relations() Relations specify a typed, directed connection between two entities.
void	resume() Resume the policy
void	suspend() Suspend the policy

Methods inherited from interface org.apache.brooklyn.api.objs.EntityAdjunct

getHighlights, getUniqueTag, isDestroyed, isRunning

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

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

getPolicyType

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

getRebindSupport

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

relations

BrooklynObject.RelationSupport<Policy> relations()

Description copied from interface: BrooklynObject

Relations specify a typed, directed connection between two entities. Generic type is overridden in sub-interfaces.

Specified by:

relations in interface BrooklynObject