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 descended from those applications.

getApplications

public java.util.Collection getApplications()

All applications under control of this management plane

getCatalog

public BrooklynCatalog getCatalog()

Record of configured Brooklyn entities (and templates and policies) which can be loaded

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

@Deprecated
public java.util.Collection getEntities()

All entities under control of this management plane

deprecated:

Use getEntityManager().getEntities() instead; deprecated in 0.5

getEntity

@Deprecated
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)

deprecated:

Use getEntityManager().getEntity(String) instead; deprecated in 0.5

getEntityDownloadsManager

public DownloadResolverManager getEntityDownloadsManager()

Returns the DownloadResolverManager for resolving things like which URL to download an installer from. The default DownloadResolverManager will retrieve entity.getAttribute(Attributes.DOWNLOAD_URL), and substitute things like "${version}" etc. However, additional resolvers can be registered to customize this behaviour (e.g. to always go to an enterprise's repository).

getEntityDriverFactory

public EntityDriverManager getEntityDriverFactory()

deprecated:

since 0.5; use getEntityDriverManager()

getEntityDriverManager

public EntityDriverManager getEntityDriverManager()

Returns the EntityDriverManager entities can use to create drivers. This manager can also be used to programmatically customize which driver type to use for entities in different locations. The default strategy for choosing a driver is to use a naming convention: DriverDependentEntity#getDriverInterface()#getDriverInterface() returns the interface that the driver must implement; its name should end in "Driver". For example, this suffix is replaced with "SshDriver" for SshMachineLocation, for example.

getEntityManager

public EntityManager getEntityManager()

Returns the EntityManager instance for managing/querying entities.

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

getLocationRegistry

public LocationRegistry getLocationRegistry()

Record of configured locations and location resolvers

getRebindManager

public RebindManager getRebindManager()

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

@Deprecated
public boolean isManaged(Entity entity)

Whether the entity is under management by this management context

deprecated:

Use getEntityManager().isManaged(Entity) instead; deprecated in 0.5

isRunning

public boolean isRunning()

Whether this management context is still running, or has been terminated.

manage

@Deprecated
public void manage(Entity e)

Manage an entity.

deprecated:

Use getEntityManager().manage(Entity) instead; deprecated in 0.5

unmanage

@Deprecated
public void unmanage(Entity e)

Unmanage an entity.

deprecated:

Use getEntityManager().unmanage(Entity) instead; deprecated in 0.5

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.