LocalEntityManager (Apache Brooklyn)

java.lang.Object
- brooklyn.management.internal.LocalEntityManager

All Implemented Interfaces:: EntityManager, EntityManagerInternal

public class LocalEntityManager
extends java.lang.Object
implements EntityManagerInternal

Constructor Summary

Constructors
Constructor and Description

LocalEntityManager(LocalManagementContext managementContext)

Constructors
Constructor and Description
`LocalEntityManager(LocalManagementContext managementContext)`

Method Summary

Methods
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 (unmanaged) 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(com.google.common.base.Predicate<? super Entity> filter)` All entities under control of this management plane that match the given filter
`java.util.Collection<Entity>`	`findEntitiesInApplication(Application application, com.google.common.base.Predicate<? super Entity> filter)` All entities managed as part of the given application that match the given filter
`java.lang.Iterable<Entity>`	`getAllEntitiesInApplication(Application application)` gets all entities currently known to the application, including entities that are not yet managed
`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.
`InternalEntityFactory`	`getEntityFactory()`
`java.util.Collection<java.lang.String>`	`getEntityIds()`
`EntityTypeRegistry`	`getEntityTypeRegistry()` Returns the type registry, used to identify the entity implementation when instantiating an entity of a given type.
`ManagementTransitionInfo.ManagementTransitionMode`	`getLastManagementTransitionMode(java.lang.String itemId)`
`InternalPolicyFactory`	`getPolicyFactory()`
`boolean`	`isKnownEntityId(java.lang.String id)`
`boolean`	`isManaged(Entity e)` 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`	`manageRebindedRoot(Entity item)` Begins management for the given rebinded root, recursively; if rebinding as a read-only copy, `#setReadOnly(Location, boolean)` should be called prior to this.
`void`	`setManagementTransitionMode(Entity item, ManagementTransitionInfo.ManagementTransitionMode mode)`
`void`	`stopTasks(Entity entity, Duration timeout)` stops all tasks (apart from any current one or its descendants) on this entity, optionally -- if a timeout is given -- waiting for completion and warning on incomplete tasks
`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)
`void`	`unmanage(Entity e, ManagementTransitionInfo.ManagementTransitionMode mode)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LocalEntityManager
```
public LocalEntityManager(LocalManagementContext managementContext)
```
- Method Detail
  - getEntityFactory
```
public InternalEntityFactory getEntityFactory()
```
  - getPolicyFactory
```
public InternalPolicyFactory getPolicyFactory()
```
  - getEntityTypeRegistry
```
public EntityTypeRegistry getEntityTypeRegistry()
```
    Description copied from interface: EntityManager
    
    Returns the type registry, used to identify the entity implementation when instantiating an entity of a given type.
    
    Specified by:
    
    getEntityTypeRegistry in interface EntityManager
    
    See Also:
    EntityManager.createEntity(EntitySpec)
  - createEntity
```
public <T extends Entity> T createEntity(EntitySpec<T> spec)
```
    Description copied from interface: EntityManager
    
    Creates a new (unmanaged) entity.
    
    Specified by:
    
    createEntity in interface EntityManager
    
    Returns:
    A proxy to the created entity (rather than the actual entity itself).
  - createEntity
```
public <T extends Entity> T createEntity(java.util.Map<?,?> config,
                                java.lang.Class<T> type)
```
    Description copied from interface: EntityManager
    
    Convenience (particularly for groovy code) to create an entity. Equivalent to createEntity(EntitySpec.create(type).configure(config))
    
    Specified by:
    
    createEntity in interface EntityManager
    
    See Also:
    EntityManager.createEntity(EntitySpec)
  - createPolicy
```
public <T extends Policy> T createPolicy(PolicySpec<T> spec)
```
    Description copied from interface: EntityManager
    
    Creates a new policy (not managed; not associated with any entity).
    
    Specified by:
    
    createPolicy in interface EntityManager
  - createEnricher
```
public <T extends Enricher> T createEnricher(EnricherSpec<T> spec)
```
    Description copied from interface: EntityManager
    
    Creates a new enricher (not managed; not associated with any entity).
    
    Specified by:
    
    createEnricher in interface EntityManager
  - getEntities
```
public java.util.Collection<Entity> getEntities()
```
    Description copied from interface: EntityManager
    
    All entities under control of this management plane
    
    Specified by:
    
    getEntities in interface EntityManager
  - getEntityIds
```
public java.util.Collection<java.lang.String> getEntityIds()
```
    Specified by:
    
    getEntityIds in interface EntityManagerInternal
  - getEntitiesInApplication
```
public java.util.Collection<Entity> getEntitiesInApplication(Application application)
```
    Description copied from interface: EntityManager
    
    All entities managed as part of the given application
    
    Specified by:
    
    getEntitiesInApplication in interface EntityManager
  - findEntities
```
public java.util.Collection<Entity> findEntities(com.google.common.base.Predicate<? super Entity> filter)
```
    Description copied from interface: EntityManager
    
    All entities under control of this management plane that match the given filter
    
    Specified by:
    
    findEntities in interface EntityManager
  - findEntitiesInApplication
```
public java.util.Collection<Entity> findEntitiesInApplication(Application application,
                                                     com.google.common.base.Predicate<? super Entity> filter)
```
    Description copied from interface: EntityManager
    
    All entities managed as part of the given application that match the given filter
    
    Specified by:
    
    findEntitiesInApplication in interface EntityManager
  - getAllEntitiesInApplication
```
public java.lang.Iterable<Entity> getAllEntitiesInApplication(Application application)
```
    Description copied from interface: EntityManagerInternal
    
    gets all entities currently known to the application, including entities that are not yet managed
    
    Specified by:
    
    getAllEntitiesInApplication in interface EntityManagerInternal
  - getEntity
```
public Entity getEntity(java.lang.String id)
```
    Description copied from interface: EntityManager
    
    Returns the entity with the given identifier (may be a full instance, or a proxy to one which is remote), or null.
    
    Specified by:
    
    getEntity in interface EntityManager
  - isManaged
```
public boolean isManaged(Entity e)
```
    Description copied from interface: EntityManager
    
    whether the entity is under management by this management context
    
    Specified by:
    
    isManaged in interface EntityManager
  - getLastManagementTransitionMode
```
public ManagementTransitionInfo.ManagementTransitionMode getLastManagementTransitionMode(java.lang.String itemId)
```
    Specified by:
    
    getLastManagementTransitionMode in interface EntityManagerInternal
  - setManagementTransitionMode
```
public void setManagementTransitionMode(Entity item,
                               ManagementTransitionInfo.ManagementTransitionMode mode)
```
    Specified by:
    
    setManagementTransitionMode in interface EntityManagerInternal
  - manage
```
public void manage(Entity e)
```
    Description copied from interface: EntityManager
    
    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.
    
    Specified by:
    
    manage in interface EntityManager
  - manageRebindedRoot
```
public void manageRebindedRoot(Entity item)
```
    Description copied from interface: EntityManagerInternal
    
    Begins management for the given rebinded root, recursively; if rebinding as a read-only copy, #setReadOnly(Location, boolean) should be called prior to this.
    
    Specified by:
    
    manageRebindedRoot in interface EntityManagerInternal
  - unmanage
```
public void unmanage(Entity e)
```
    Description copied from interface: EntityManager
    
    Causes the given entity and its children, recursively, to be removed from the management plane (for instance because the entity is no longer relevant)
    
    Specified by:
    
    unmanage in interface EntityManager
  - unmanage
```
public void unmanage(Entity e,
            ManagementTransitionInfo.ManagementTransitionMode mode)
```
    Specified by:
    
    unmanage in interface EntityManagerInternal
  - stopTasks
```
@Beta
public void stopTasks(Entity entity,
                  @Nullable
                  Duration timeout)
```
    stops all tasks (apart from any current one or its descendants) on this entity, optionally -- if a timeout is given -- waiting for completion and warning on incomplete tasks
  - isKnownEntityId
```
public boolean isKnownEntityId(java.lang.String id)
```

Class LocalEntityManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LocalEntityManager

Method Detail

getEntityFactory

getPolicyFactory

getEntityTypeRegistry

createEntity

createEntity

createPolicy

createEnricher

getEntities

getEntityIds

getEntitiesInApplication

findEntities

findEntitiesInApplication

getAllEntitiesInApplication

getEntity

isManaged

getLastManagementTransitionMode

setManagementTransitionMode

manage

manageRebindedRoot

unmanage

unmanage

stopTasks

isKnownEntityId