org.apache.brooklyn.api.mgmt

Interface EntityManager

All Known Subinterfaces:

EntityManagerInternal

All Known Implementing Classes:

LocalEntityManager, NonDeploymentEntityManager

public interface EntityManager

For managing and querying entities.

Method Summary

Modifier and Type	Method and Description
<T extends Enricher> T	createEnricher(EnricherSpec<T> spec) Creates a new enricher (not managed; not associated with any entity).
<T extends Entity> T	createEntity(EntitySpec<T> spec) Creates a new entity.
<T extends Entity> T	createEntity(java.util.Map<?,?> config, java.lang.Class<T> type) Convenience (particularly for groovy code) to create an entity.
<T extends Policy> T	createPolicy(PolicySpec<T> spec) Creates a new policy (not managed; not associated with any entity).
java.util.Collection<Entity>	findEntities(<any> filter) All entities under control of this management plane that match the given filter
java.util.Collection<Entity>	findEntitiesInApplication(Application application, <any> filter) All entities managed as part of the given application that match the given filter
java.util.Collection<Entity>	getEntities() All entities under control of this management plane
java.util.Collection<Entity>	getEntitiesInApplication(Application application) All entities managed as part of the given application
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), or null.
EntityTypeRegistry	getEntityTypeRegistry() Returns the type registry, used to identify the entity implementation when instantiating an entity of a given type.
boolean	isManaged(Entity entity) whether the entity is under management by this management context
void	manage(Entity e) Begins management for the given entity and its children, recursively.
void	unmanage(Entity e) Causes the given entity and its children, recursively, to be removed from the management plane (for instance because the entity is no longer relevant)

Method Detail

getEntityTypeRegistry

EntityTypeRegistry getEntityTypeRegistry()

Returns the type registry, used to identify the entity implementation when instantiating an entity of a given type.

See Also:

EntityManager.createEntity(EntitySpec)

createEntity

<T extends Entity> T createEntity(EntitySpec<T> spec)

Creates a new entity. Management is started immediately (by this method).

Parameters:

spec -

Returns:

A proxy to the created entity (rather than the actual entity itself).

createEntity

<T extends Entity> T createEntity(java.util.Map<?,?> config,
                                  java.lang.Class<T> type)

Convenience (particularly for groovy code) to create an entity. Equivalent to createEntity(EntitySpec.create(type).configure(config))

See Also:

createEntity(EntitySpec)

createPolicy

<T extends Policy> T createPolicy(PolicySpec<T> spec)

Creates a new policy (not managed; not associated with any entity).

Parameters:

spec -

createEnricher

<T extends Enricher> T createEnricher(EnricherSpec<T> spec)

Creates a new enricher (not managed; not associated with any entity).

Parameters:

spec -

getEntities

java.util.Collection<Entity> getEntities()

All entities under control of this management plane

getEntitiesInApplication

java.util.Collection<Entity> getEntitiesInApplication(Application application)

All entities managed as part of the given application

findEntities

java.util.Collection<Entity> findEntities(<any> filter)

All entities under control of this management plane that match the given filter

findEntitiesInApplication

java.util.Collection<Entity> findEntitiesInApplication(Application application,
                                                       <any> filter)

All entities managed as part of the given application that match the given filter

getEntity

@Nullable
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), or null.

isManaged

boolean isManaged(Entity entity)

whether the entity is under management by this management context

manage

void manage(Entity e)

Begins management for the given entity and its children, recursively. depending on the implementation of the management context, this might push it out to one or more remote management nodes. Manage an entity.

unmanage

void unmanage(Entity e)

Causes the given entity and its children, recursively, to be removed from the management plane (for instance because the entity is no longer relevant)