ManagementContext (Brooklyn)

Overview

Package

Class

Deprecated

Index

Help

Brooklyn

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | METHOD

DETAIL: FIELD | METHOD

brooklyn.management
[Java] Interface ManagementContext

public interface ManagementContext

This is the entry point for accessing and interacting with a realm of applications and their entities in Brooklyn. For example, policies and the management console(s) (web-app, etc) can use this to interact with entities; policies, web-app, and entities share the realm for subscribing to events, executing tasks, and generally co-existing.

It may refer to several applications, and it refers to all the entities owned by those applications.

Method Summary
`java.util.Collection`	`getApplications()` All applications under control of this management plane
`StringConfigMap`	`getConfig()` Returns the ConfigMap (e.g.
`java.util.Collection`	`getEntities()` All entities under control of this management plane
`Entity`	`getEntity(java.lang.String id)` Returns the entity with the given identifier (may be a full instance, or a proxy to one which is remote)
`EntityDriverFactory`	`getEntityDriverFactory()` Returns the EntityDriverFactory entities can use to create drivers.
`ExecutionContext`	`getExecutionContext(Entity entity)` Returns an ExecutionContext instance representing tasks (from the ExecutionManager) associated with this entity, and capable of conveniently running such tasks which will be associated with that entity
`ExecutionManager`	`getExecutionManager()` Returns the ExecutionManager instance for entities and users in this management realm to submit tasks and to observe what tasks are occurring
`SubscriptionContext`	`getSubscriptionContext(Entity entity)` Returns a SubscriptionContext instance representing subscriptions (from the SubscriptionManager) associated with this entity, and capable of conveniently subscribing on behalf of that entity
`SubscriptionManager`	`getSubscriptionManager()` Returns the SubscriptionManager instance for entities and users of this management realm to subscribe to sensor events (and, in the case of entities, to emit sensor events)
`boolean`	`isManaged(Entity entity)` whether the entity is under management by this management context
`void`	`manage(Entity e)` Manage an entity.
`void`	`unmanage(Entity e)` Unmanage an entity.

Method Detail

getApplications

public java.util.Collection getApplications()

All applications under control of this management plane

getConfig

public StringConfigMap getConfig()

Returns the ConfigMap (e.g. BrooklynProperties) applicable to this management context. Defaults to reading ~/.brooklyn/brooklyn.properties but configurable in the management context.

getEntities

public java.util.Collection getEntities()

All entities under control of this management plane

getEntity

public Entity getEntity(java.lang.String id)

Returns the entity with the given identifier (may be a full instance, or a proxy to one which is remote)

getEntityDriverFactory

public EntityDriverFactory getEntityDriverFactory()

Returns the EntityDriverFactory entities can use to create drivers.

Returns:: the EntityDriverFactory to use.

getExecutionContext

public ExecutionContext getExecutionContext(Entity entity)

Returns an ExecutionContext instance representing tasks (from the ExecutionManager) associated with this entity, and capable of conveniently running such tasks which will be associated with that entity

getExecutionManager

public ExecutionManager getExecutionManager()

Returns the ExecutionManager instance for entities and users in this management realm to submit tasks and to observe what tasks are occurring

getSubscriptionContext

public SubscriptionContext getSubscriptionContext(Entity entity)

Returns a SubscriptionContext instance representing subscriptions (from the SubscriptionManager) associated with this entity, and capable of conveniently subscribing on behalf of that entity

getSubscriptionManager

public SubscriptionManager getSubscriptionManager()

Returns the SubscriptionManager instance for entities and users of this management realm to subscribe to sensor events (and, in the case of entities, to emit sensor events)

isManaged

public boolean isManaged(Entity entity)

whether the entity is under management by this management context

manage

public void manage(Entity e)

Manage an entity.

unmanage

public void unmanage(Entity e)

Unmanage an entity.

brooklyn.management [Java] Interface ManagementContext