NonDeploymentManagementContext (Apache Brooklyn)

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

All Implemented Interfaces:: ManagementContextInternal, ManagementContext

public class NonDeploymentManagementContext
extends java.lang.Object
implements ManagementContextInternal

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NonDeploymentManagementContext.NonDeploymentManagementContextMode
- Nested classes/interfaces inherited from interface brooklyn.management.ManagementContext
  ManagementContext.PropertiesReloadListener

Nested Classes
Modifier and Type	Class and Description
`static class`	`NonDeploymentManagementContext.NonDeploymentManagementContextMode`

Field Summary
- Fields inherited from interface brooklyn.management.internal.ManagementContextInternal
  EFFECTOR_TAG, EMPTY_CATALOG_URL, NON_TRANSIENT_TASK_TAG, SUB_TASK_TAG, TRANSIENT_TASK_TAG

Constructor Summary

Constructors
Constructor and Description
`NonDeploymentManagementContext(AbstractEntity entity, NonDeploymentManagementContext.NonDeploymentManagementContextMode mode)`

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
`java.util.List<java.lang.Throwable>`	`errors()` Object which allows adding, removing, and clearing errors.
`AccessController`	`getAccessController()` For controlling access to operations - can be queried to find if an operation is allowed.
`AccessManager`	`getAccessManager()`
`java.util.Collection<Application>`	`getApplications()` All applications under control of this management plane
`java.lang.ClassLoader`	`getBaseClassLoader()`
`java.lang.Iterable<java.net.URL>`	`getBaseClassPathForScanning()`
`BrooklynProperties`	`getBrooklynProperties()`
`BrooklynCatalog`	`getCatalog()` Record of configured Brooklyn entities (and templates and policies) which can be loaded
`java.lang.ClassLoader`	`getCatalogClassLoader()` Returns the class loader to be used to load items.
`CatalogInitialization`	`getCatalogInitialization()`
`StringConfigMap`	`getConfig()` Returns the ConfigMap (e.g.
`EntitlementManager`	`getEntitlementManager()` Active entitlements checker instance.
`DownloadResolverManager`	`getEntityDownloadsManager()` Returns the `DownloadResolverManager` for resolving things like which URL to download an installer from.
`EntityDriverManager`	`getEntityDriverManager()` Returns the `EntityDriverManager` entities can use to create drivers.
`InternalEntityFactory`	`getEntityFactory()`
`EntityManager`	`getEntityManager()` Returns the `EntityManager` instance for managing/querying entities.
`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
`HighAvailabilityManager`	`getHighAvailabilityManager()`
`InternalLocationFactory`	`getLocationFactory()`
`LocationManager`	`getLocationManager()`
`LocationRegistry`	`getLocationRegistry()` Record of configured locations and location resolvers
`java.lang.String`	`getManagementNodeId()` UID for this `ManagementContext` node (as part of a single management plane).
`Maybe<java.net.URI>`	`getManagementNodeUri()` The URI that this management node's REST API is available at, or absent if the node's API is unavailable.
`java.lang.String`	`getManagementPlaneId()` UID for the Brooklyn management plane which this `ManagementContext` node is a part of.
`NonDeploymentManagementContext.NonDeploymentManagementContextMode`	`getMode()`
`Maybe<OsgiManager>`	`getOsgiManager()`
`InternalPolicyFactory`	`getPolicyFactory()`
`RebindManager`	`getRebindManager()`
`ExecutionContext`	`getServerExecutionContext()` Returns an `ExecutionContext` within the `ExecutionManager` for tasks associated to the Brooklyn node's operation (not any entities).
`BrooklynStorage`	`getStorage()`
`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
`QueueingSubscriptionManager`	`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)
`long`	`getTotalEffectorInvocations()`
`UsageManager`	`getUsageManager()`
`<T> Task<T>`	`invokeEffector(Entity entity, Effector<T> eff, java.util.Map parameters)`
`<T> T`	`invokeEffectorMethodSync(Entity entity, Effector<T> eff, java.lang.Object args)`
`boolean`	`isRunning()` Whether the management context has been initialized and not yet terminated.
`boolean`	`isStartupComplete()` Whether all startup tasks have completed.
`BrooklynObject`	`lookup(java.lang.String id)` As `ManagementContext.lookup(String, Class)` but not constraining the return type
`<T extends BrooklynObject> T`	`lookup(java.lang.String id, java.lang.Class<T> type)` Finds an entity with the given ID known at this management context
`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
`void`	`setBaseClassPathForScanning(java.lang.Iterable<java.net.URL> urls)`
`void`	`setCatalogInitialization(CatalogInitialization catalogInitialization)`
`void`	`setManagementContext(ManagementContextInternal val)`
`void`	`setManagementNodeUri(java.net.URI uri)`
`void`	`setMode(NonDeploymentManagementContext.NonDeploymentManagementContextMode mode)`
`void`	`terminate()`
`java.lang.String`	`toString()`

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

- Constructor Detail
  - NonDeploymentManagementContext
```
public NonDeploymentManagementContext(AbstractEntity entity,
                              NonDeploymentManagementContext.NonDeploymentManagementContextMode mode)
```
- Method Detail
  - 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.
    
    Specified by:
    
    getManagementPlaneId in interface ManagementContext
  - 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.
    
    Specified by:
    
    getManagementNodeId in interface ManagementContext
  - getManagementNodeUri
```
public Maybe<java.net.URI> getManagementNodeUri()
```
    Description copied from interface: ManagementContext
    
    The URI that this management node's REST API is available at, or absent if the node's API is unavailable.
    
    Specified by:
    
    getManagementNodeUri in interface ManagementContext
  - setManagementContext
```
public void setManagementContext(ManagementContextInternal val)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - setMode
```
public void setMode(NonDeploymentManagementContext.NonDeploymentManagementContextMode mode)
```
  - getMode
```
public NonDeploymentManagementContext.NonDeploymentManagementContextMode getMode()
```
  - getApplications
```
public java.util.Collection<Application> getApplications()
```
    Description copied from interface: ManagementContext
    
    All applications under control of this management plane
    
    Specified by:
    
    getApplications in interface ManagementContext
  - isRunning
```
public boolean isRunning()
```
    Description copied from interface: ManagementContext
    
    Whether the management context has been initialized and not yet terminated. This does not mean startup is entirely completed. See also ManagementContext.isStartupComplete().
    
    Specified by:
    
    isRunning in interface ManagementContext
  - isStartupComplete
```
public boolean isStartupComplete()
```
    Description copied from interface: ManagementContext
    
    Whether all startup tasks have completed. Previous to this point the management context is still usable (and hence ManagementContext.isRunning() returns true immediately after construction) but some subsystems (e.g. persistence, OSGi, webapps, entities started at startup) may not be available until this returns true.
    Also see ManagementContext.isStartupComplete().
    
    Specified by:
    
    isStartupComplete in interface ManagementContext
  - getEntityFactory
```
public InternalEntityFactory getEntityFactory()
```
    Specified by:
    
    getEntityFactory in interface ManagementContextInternal
  - getLocationFactory
```
public InternalLocationFactory getLocationFactory()
```
    Specified by:
    
    getLocationFactory in interface ManagementContextInternal
  - getPolicyFactory
```
public InternalPolicyFactory getPolicyFactory()
```
    Specified by:
    
    getPolicyFactory in interface ManagementContextInternal
  - getEntityManager
```
public EntityManager getEntityManager()
```
    Description copied from interface: ManagementContext
    
    Returns the EntityManager instance for managing/querying entities.
    
    Specified by:
    
    getEntityManager in interface ManagementContext
  - getLocationManager
```
public LocationManager getLocationManager()
```
    Specified by:
    
    getLocationManager in interface ManagementContext
  - getAccessManager
```
public AccessManager getAccessManager()
```
    Specified by:
    
    getAccessManager in interface ManagementContextInternal
  - getUsageManager
```
public UsageManager getUsageManager()
```
    Specified by:
    
    getUsageManager in interface ManagementContextInternal
  - getOsgiManager
```
public Maybe<OsgiManager> getOsgiManager()
```
    Specified by:
    
    getOsgiManager in interface ManagementContextInternal
    
    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.
    
    Specified by:
    
    getAccessController in interface ManagementContext
  - 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
    
    Specified by:
    
    getExecutionManager in interface ManagementContext
  - getSubscriptionManager
```
public QueueingSubscriptionManager 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)
    
    Specified by:
    
    getSubscriptionManager in interface ManagementContext
  - getSubscriptionContext
```
public SubscriptionContext getSubscriptionContext(Entity entity)
```
    Description copied from interface: ManagementContext
    
    Returns a SubscriptionContext instance representing subscriptions (from the SubscriptionManager) associated with this entity, and capable of conveniently subscribing on behalf of that entity
    
    Specified by:
    
    getSubscriptionContext in interface ManagementContext
  - getExecutionContext
```
public ExecutionContext getExecutionContext(Entity entity)
```
    Description copied from interface: ManagementContext
    
    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
    
    Specified by:
    
    getExecutionContext in interface ManagementContext
  - getServerExecutionContext
```
public ExecutionContext getServerExecutionContext()
```
    Description copied from interface: ManagementContext
    
    Returns an ExecutionContext within the ExecutionManager for tasks associated to the Brooklyn node's operation (not any entities).
    
    Specified by:
    
    getServerExecutionContext in interface ManagementContext
  - getEntityDriverManager
```
public EntityDriverManager getEntityDriverManager()
```
    Description copied from interface: ManagementContext
    
    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() 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.
    
    Specified by:
    
    getEntityDriverManager in interface ManagementContext
  - getEntityDownloadsManager
```
public DownloadResolverManager getEntityDownloadsManager()
```
    Description copied from interface: ManagementContext
    
    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).
    
    Specified by:
    
    getEntityDownloadsManager in interface ManagementContext
  - getConfig
```
public StringConfigMap getConfig()
```
    Description copied from interface: ManagementContext
    
    Returns the ConfigMap (e.g. BrooklynProperties) applicable to this management context. Defaults to reading ~/.brooklyn/brooklyn.properties but configurable in the management context.
    
    Specified by:
    
    getConfig in interface ManagementContext
  - getBrooklynProperties
```
public BrooklynProperties getBrooklynProperties()
```
    Specified by:
    
    getBrooklynProperties in interface ManagementContextInternal
  - getStorage
```
public BrooklynStorage getStorage()
```
    Specified by:
    
    getStorage in interface ManagementContextInternal
  - getRebindManager
```
public RebindManager getRebindManager()
```
    Specified by:
    
    getRebindManager in interface ManagementContext
  - getHighAvailabilityManager
```
public HighAvailabilityManager getHighAvailabilityManager()
```
    Specified by:
    
    getHighAvailabilityManager in interface ManagementContext
  - getLocationRegistry
```
public LocationRegistry getLocationRegistry()
```
    Description copied from interface: ManagementContext
    
    Record of configured locations and location resolvers
    
    Specified by:
    
    getLocationRegistry in interface ManagementContext
  - getCatalog
```
public BrooklynCatalog getCatalog()
```
    Description copied from interface: ManagementContext
    
    Record of configured Brooklyn entities (and templates and policies) which can be loaded
    
    Specified by:
    
    getCatalog in interface ManagementContext
  - getCatalogClassLoader
```
public java.lang.ClassLoader getCatalogClassLoader()
```
    Description copied from interface: ManagementContext
    
    Returns the class loader to be used to load items. Temporary routine while catalog supports classloader-based and OSGi-based classloading.
    
    Specified by:
    
    getCatalogClassLoader in interface ManagementContext
  - getEntitlementManager
```
public EntitlementManager getEntitlementManager()
```
    Description copied from interface: ManagementContext
    
    Active entitlements checker instance.
    
    Specified by:
    
    getEntitlementManager in interface ManagementContext
  - invokeEffectorMethodSync
```
public <T> T invokeEffectorMethodSync(Entity entity,
                             Effector<T> eff,
                             java.lang.Object args)
                           throws java.util.concurrent.ExecutionException
```
    Specified by:
    
    invokeEffectorMethodSync in interface ManagementContextInternal
    
    Throws:
    
    java.util.concurrent.ExecutionException
  - invokeEffector
```
public <T> Task<T> invokeEffector(Entity entity,
                         Effector<T> eff,
                         java.util.Map parameters)
```
    Specified by:
    
    invokeEffector in interface ManagementContextInternal
  - getBaseClassLoader
```
public java.lang.ClassLoader getBaseClassLoader()
```
    Specified by:
    
    getBaseClassLoader in interface ManagementContextInternal
  - getBaseClassPathForScanning
```
public java.lang.Iterable<java.net.URL> getBaseClassPathForScanning()
```
    Specified by:
    
    getBaseClassPathForScanning in interface ManagementContextInternal
  - addEntitySetListener
```
public void addEntitySetListener(CollectionChangeListener<Entity> listener)
```
    Specified by:
    
    addEntitySetListener in interface ManagementContextInternal
  - removeEntitySetListener
```
public void removeEntitySetListener(CollectionChangeListener<Entity> listener)
```
    Specified by:
    
    removeEntitySetListener in interface ManagementContextInternal
  - terminate
```
public void terminate()
```
    Specified by:
    
    terminate in interface ManagementContextInternal
  - getTotalEffectorInvocations
```
public long getTotalEffectorInvocations()
```
    Specified by:
    
    getTotalEffectorInvocations in interface ManagementContextInternal
  - setBaseClassPathForScanning
```
public void setBaseClassPathForScanning(java.lang.Iterable<java.net.URL> urls)
```
    Specified by:
    
    setBaseClassPathForScanning in interface ManagementContextInternal
  - setManagementNodeUri
```
public void setManagementNodeUri(java.net.URI uri)
```
    Specified by:
    
    setManagementNodeUri in interface ManagementContextInternal
  - 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.
    
    Specified by:
    
    prePreManage in interface ManagementContextInternal
  - 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.
    
    Specified by:
    
    prePreManage in interface ManagementContextInternal
  - reloadBrooklynProperties
```
public void reloadBrooklynProperties()
```
    Description copied from interface: ManagementContext
    
    Reloads locations from brooklyn.properties. Any changes will apply only to newly created applications
    
    Specified by:
    
    reloadBrooklynProperties in interface ManagementContext
  - addPropertiesReloadListener
```
public void addPropertiesReloadListener(ManagementContext.PropertiesReloadListener listener)
```
    Description copied from interface: ManagementContext
    
    Registers a listener to be notified when brooklyn.properties is reloaded
    
    Specified by:
    
    addPropertiesReloadListener in interface ManagementContext
  - removePropertiesReloadListener
```
public void removePropertiesReloadListener(ManagementContext.PropertiesReloadListener listener)
```
    Description copied from interface: ManagementContext
    
    Deregisters a listener from brooklyn.properties reload notifications
    
    Specified by:
    
    removePropertiesReloadListener in interface ManagementContext
  - lookup
```
public BrooklynObject lookup(java.lang.String id)
```
    Description copied from interface: ManagementContext
    
    As ManagementContext.lookup(String, Class) but not constraining the return type
    
    Specified by:
    
    lookup in interface ManagementContext
  - lookup
```
public <T extends BrooklynObject> T lookup(java.lang.String id,
                                  java.lang.Class<T> type)
```
    Description copied from interface: ManagementContext
    
    Finds an entity with the given ID known at this management context
    
    Specified by:
    
    lookup in interface ManagementContext
  - errors
```
public java.util.List<java.lang.Throwable> errors()
```
    Description copied from interface: ManagementContextInternal
    
    Object which allows adding, removing, and clearing errors. TODO In future this will change to a custom interface with a unique identifier for each error.
    
    Specified by:
    
    errors in interface ManagementContextInternal
  - getCatalogInitialization
```
public CatalogInitialization getCatalogInitialization()
```
    Specified by:
    
    getCatalogInitialization in interface ManagementContextInternal
  - setCatalogInitialization
```
public void setCatalogInitialization(CatalogInitialization catalogInitialization)
```
    Specified by:
    
    setCatalogInitialization in interface ManagementContextInternal

Class NonDeploymentManagementContext

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 java.lang.Object

Constructor Detail

NonDeploymentManagementContext

Method Detail

getManagementPlaneId

getManagementNodeId

getManagementNodeUri

setManagementContext

toString

setMode

getMode

getApplications

isRunning

isStartupComplete

getEntityFactory

getLocationFactory

getPolicyFactory

getEntityManager

getLocationManager

getAccessManager

getUsageManager

getOsgiManager

getAccessController

getExecutionManager

getSubscriptionManager

getSubscriptionContext

getExecutionContext

getServerExecutionContext

getEntityDriverManager

getEntityDownloadsManager

getConfig

getBrooklynProperties

getStorage

getRebindManager

getHighAvailabilityManager

getLocationRegistry

getCatalog

getCatalogClassLoader

getEntitlementManager

invokeEffectorMethodSync

invokeEffector

getBaseClassLoader

getBaseClassPathForScanning

addEntitySetListener

removeEntitySetListener

terminate

getTotalEffectorInvocations

setBaseClassPathForScanning

setManagementNodeUri

prePreManage

prePreManage

reloadBrooklynProperties

addPropertiesReloadListener

removePropertiesReloadListener

lookup

lookup

errors

getCatalogInitialization

setCatalogInitialization