LocalManagementContext (Apache Brooklyn)

java.lang.Object
- brooklyn.management.internal.AbstractManagementContext
- - brooklyn.management.internal.LocalManagementContext

All Implemented Interfaces:

ManagementContextInternal, ManagementContext
```
public class LocalManagementContext
extends AbstractManagementContext
```
A local (single node) implementation of the ManagementContext API.

Nested Class Summary
- Nested classes/interfaces inherited from interface brooklyn.management.ManagementContext
  ManagementContext.PropertiesReloadListener

Field Summary

Fields
Modifier and Type Field and Description

java.lang.Throwable constructionStackTrace
- Fields inherited from interface brooklyn.management.internal.ManagementContextInternal
  EFFECTOR_TAG, EMPTY_CATALOG_URL, NON_TRANSIENT_TASK_TAG, SUB_TASK_TAG, TRANSIENT_TASK_TAG

Fields
Modifier and Type	Field and Description
`java.lang.Throwable`	`constructionStackTrace`

Constructor Summary

Constructors
Constructor and Description
`LocalManagementContext()` Creates a LocalManagement with default BrooklynProperties.
`LocalManagementContext(BrooklynProperties.Factory.Builder builder)`
`LocalManagementContext(BrooklynProperties.Factory.Builder builder, DataGridFactory datagridFactory)`
`LocalManagementContext(BrooklynProperties.Factory.Builder builder, java.util.Map<java.lang.String,java.lang.Object> brooklynAdditionalProperties)`
`LocalManagementContext(BrooklynProperties.Factory.Builder builder, java.util.Map<java.lang.String,java.lang.Object> brooklynAdditionalProperties, DataGridFactory datagridFactory)`
`LocalManagementContext(BrooklynProperties brooklynProperties)`
`LocalManagementContext(BrooklynProperties brooklynProperties, DataGridFactory datagridFactory)` Creates a new LocalManagementContext.
`LocalManagementContext(BrooklynProperties brooklynProperties, java.util.Map<java.lang.String,java.lang.Object> brooklynAdditionalProperties)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addEntitySetListener(CollectionChangeListener<Entity> listener)`
`void`	`addPropertiesReloadListener(ManagementContext.PropertiesReloadListener listener)` Registers a listener to be notified when brooklyn.properties is reloaded
`void`	`clearLocationRegistry()`
`AccessController`	`getAccessController()` For controlling access to operations - can be queried to find if an operation is allowed.
`LocalAccessManager`	`getAccessManager()`
`java.util.Collection<Application>`	`getApplications()` All applications under control of this management plane
`InternalEntityFactory`	`getEntityFactory()`
`LocalEntityManager`	`getEntityManager()` Returns the `EntityManager` instance for managing/querying entities.
`ExecutionManager`	`getExecutionManager()` Returns the `ExecutionManager` instance for entities and users in this management realm to submit tasks and to observe what tasks are occurring
`InternalLocationFactory`	`getLocationFactory()`
`LocalLocationManager`	`getLocationManager()`
`java.lang.String`	`getManagementNodeId()` UID for this `ManagementContext` node (as part of a single management plane).
`java.lang.String`	`getManagementPlaneId()` UID for the Brooklyn management plane which this `ManagementContext` node is a part of.
`Maybe<OsgiManager>`	`getOsgiManager()`
`InternalPolicyFactory`	`getPolicyFactory()`
`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)
`LocalUsageManager`	`getUsageManager()`
`boolean`	`isManagedLocally(Entity e)` Whether the master entity record is local, and sensors and effectors can be properly accessed locally.
`static void`	`logAll(org.slf4j.Logger logger)`
`void`	`noteStartupComplete()`
`void`	`prePreManage(Entity entity)` Registers an entity that has been created, but that has not yet begun to be managed.
`void`	`prePreManage(Location location)` Registers a location that has been created, but that has not yet begun to be managed.
`void`	`reloadBrooklynProperties()` Reloads locations from `brooklyn.properties`.
`void`	`removeEntitySetListener(CollectionChangeListener<Entity> listener)`
`void`	`removePropertiesReloadListener(ManagementContext.PropertiesReloadListener listener)` Deregisters a listener from brooklyn.properties reload notifications
`<T> Task<T>`	`runAtEntity(java.util.Map flags, Entity entity, java.util.concurrent.Callable<T> c)` Causes the indicated runnable to be run at the right location for the given entity.
`void`	`terminate()`
`static int`	`terminateAll()` terminates all (best effort); returns count of sessions closed; if exceptions thrown, returns negative number.
`java.lang.String`	`toString()`

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

- Field Detail
  - constructionStackTrace
```
public final java.lang.Throwable constructionStackTrace
```
- Constructor Detail
  - LocalManagementContext
```
public LocalManagementContext()
```
    Creates a LocalManagement with default BrooklynProperties.
  - LocalManagementContext
```
public LocalManagementContext(BrooklynProperties brooklynProperties)
```
  - LocalManagementContext
```
public LocalManagementContext(BrooklynProperties brooklynProperties,
                      DataGridFactory datagridFactory)
```
    Creates a new LocalManagementContext.
    
    Parameters:
    brooklynProperties - the BrooklynProperties.
    datagridFactory - the DataGridFactory to use. If this instance is null, it means that the system is going to use BrooklynProperties to figure out which instance to load or otherwise use a default instance.
  - LocalManagementContext
```
public LocalManagementContext(BrooklynProperties.Factory.Builder builder)
```
  - LocalManagementContext
```
public LocalManagementContext(BrooklynProperties.Factory.Builder builder,
                      DataGridFactory datagridFactory)
```
  - LocalManagementContext
```
public LocalManagementContext(BrooklynProperties.Factory.Builder builder,
                      java.util.Map<java.lang.String,java.lang.Object> brooklynAdditionalProperties)
```
  - LocalManagementContext
```
public LocalManagementContext(BrooklynProperties brooklynProperties,
                      java.util.Map<java.lang.String,java.lang.Object> brooklynAdditionalProperties)
```
  - LocalManagementContext
```
public LocalManagementContext(BrooklynProperties.Factory.Builder builder,
                      java.util.Map<java.lang.String,java.lang.Object> brooklynAdditionalProperties,
                      DataGridFactory datagridFactory)
```
- Method Detail
  - logAll
```
public static void logAll(org.slf4j.Logger logger)
```
  - terminateAll
```
@Beta
public static int terminateAll()
```
    terminates all (best effort); returns count of sessions closed; if exceptions thrown, returns negative number. semantics might change, particular in dealing with interminable mgmt contexts.
  - getManagementPlaneId
```
public java.lang.String getManagementPlaneId()
```
    Description copied from interface: ManagementContext
    
    UID for the Brooklyn management plane which this ManagementContext node is a part of.
    Each Brooklyn entity is actively managed by a unique management plane whose ID which should not normally change for the duration of that entity, even though the nodes in that plane might, and the plane may go down and come back up. In other words the value of Application#getManagementContext()#getManagementPlaneId() will generally be constant (in contrast to ManagementContext.getManagementNodeId()).
    This value should not be null unless the management context is a non-functional (non-deployment) instance.
  - getManagementNodeId
```
public java.lang.String getManagementNodeId()
```
    Description copied from interface: ManagementContext
    
    UID for this ManagementContext node (as part of a single management plane).
    No two instances of ManagementContext should ever have the same node UID. The value of Application#getManagementContext()#getManagementNodeId() may change many times (in contrast to ManagementContext.getManagementPlaneId()).
    This value should not be null unless the management context is a non-functional (non-deployment) instance.
  - prePreManage
```
public void prePreManage(Entity entity)
```
    Description copied from interface: ManagementContextInternal
    
    Registers an entity that has been created, but that has not yet begun to be managed.
    This differs from the idea of "preManaged" where the entities are in the process of being managed, but where management is not yet complete.
  - prePreManage
```
public void prePreManage(Location location)
```
    Description copied from interface: ManagementContextInternal
    
    Registers a location that has been created, but that has not yet begun to be managed.
  - getApplications
```
public java.util.Collection<Application> getApplications()
```
    Description copied from interface: ManagementContext
    
    All applications under control of this management plane
  - addEntitySetListener
```
public void addEntitySetListener(CollectionChangeListener<Entity> listener)
```
    Specified by:
    
    addEntitySetListener in interface ManagementContextInternal
    
    Specified by:
    
    addEntitySetListener in class AbstractManagementContext
  - removeEntitySetListener
```
public void removeEntitySetListener(CollectionChangeListener<Entity> listener)
```
    Specified by:
    
    removeEntitySetListener in interface ManagementContextInternal
    
    Specified by:
    
    removeEntitySetListener in class AbstractManagementContext
  - getEntityManager
```
public LocalEntityManager getEntityManager()
```
    Description copied from interface: ManagementContext
    
    Returns the EntityManager instance for managing/querying entities.
  - getEntityFactory
```
public InternalEntityFactory getEntityFactory()
```
  - getLocationFactory
```
public InternalLocationFactory getLocationFactory()
```
  - getPolicyFactory
```
public InternalPolicyFactory getPolicyFactory()
```
  - getLocationManager
```
public LocalLocationManager getLocationManager()
```
  - getAccessManager
```
public LocalAccessManager getAccessManager()
```
  - getUsageManager
```
public LocalUsageManager getUsageManager()
```
  - getOsgiManager
```
public Maybe<OsgiManager> getOsgiManager()
```
    Returns:
    The OSGi manager, if available; may be absent if OSGi is not supported, e.g. in test contexts (but will be supported in all major contexts).
  - getAccessController
```
public AccessController getAccessController()
```
    Description copied from interface: ManagementContext
    
    For controlling access to operations - can be queried to find if an operation is allowed. Callers should *not* cache the result of this method, but should instead always call again to get the AccessController.
  - getSubscriptionManager
```
public SubscriptionManager getSubscriptionManager()
```
    Description copied from interface: ManagementContext
    
    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)
  - getExecutionManager
```
public ExecutionManager getExecutionManager()
```
    Description copied from interface: ManagementContext
    
    Returns the ExecutionManager instance for entities and users in this management realm to submit tasks and to observe what tasks are occurring
  - terminate
```
public void terminate()
```
    Specified by:
    
    terminate in interface ManagementContextInternal
    
    Overrides:
    
    terminate in class AbstractManagementContext
  - runAtEntity
```
public <T> Task<T> runAtEntity(java.util.Map flags,
                      Entity entity,
                      java.util.concurrent.Callable<T> c)
```
    Description copied from class: AbstractManagementContext
    
    Causes the indicated runnable to be run at the right location for the given entity. Returns the actual task (if it is local) or a proxy task (if it is remote); if management for the entity has not yet started this may start it.
    
    Specified by:
    
    runAtEntity in class AbstractManagementContext
  - isManagedLocally
```
public boolean isManagedLocally(Entity e)
```
    Description copied from class: AbstractManagementContext
    
    Whether the master entity record is local, and sensors and effectors can be properly accessed locally.
    
    Specified by:
    
    isManagedLocally in class AbstractManagementContext
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - reloadBrooklynProperties
```
public void reloadBrooklynProperties()
```
    Description copied from interface: ManagementContext
    
    Reloads locations from brooklyn.properties. Any changes will apply only to newly created applications
  - clearLocationRegistry
```
public void clearLocationRegistry()
```
  - addPropertiesReloadListener
```
public void addPropertiesReloadListener(ManagementContext.PropertiesReloadListener listener)
```
    Description copied from interface: ManagementContext
    
    Registers a listener to be notified when brooklyn.properties is reloaded
  - removePropertiesReloadListener
```
public void removePropertiesReloadListener(ManagementContext.PropertiesReloadListener listener)
```
    Description copied from interface: ManagementContext
    
    Deregisters a listener from brooklyn.properties reload notifications
  - noteStartupComplete
```
public void noteStartupComplete()
```

Class LocalManagementContext

Nested Class Summary

Nested classes/interfaces inherited from interface brooklyn.management.ManagementContext

Field Summary

Fields inherited from interface brooklyn.management.internal.ManagementContextInternal

Constructor Summary

Method Summary

Methods inherited from class brooklyn.management.internal.AbstractManagementContext

Methods inherited from class java.lang.Object

Field Detail

constructionStackTrace

Constructor Detail

LocalManagementContext

LocalManagementContext

LocalManagementContext

LocalManagementContext

LocalManagementContext

LocalManagementContext

LocalManagementContext

LocalManagementContext

Method Detail

logAll

terminateAll

getManagementPlaneId

getManagementNodeId

prePreManage

prePreManage

getApplications

addEntitySetListener

removeEntitySetListener

getEntityManager

getEntityFactory

getLocationFactory

getPolicyFactory

getLocationManager

getAccessManager

getUsageManager

getOsgiManager

getAccessController

getSubscriptionManager

getExecutionManager

terminate

runAtEntity

isManagedLocally

toString

reloadBrooklynProperties

clearLocationRegistry

addPropertiesReloadListener

removePropertiesReloadListener

noteStartupComplete