AbstractManagementContext (Apache Brooklyn)

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

All Implemented Interfaces:

ManagementContextInternal, ManagementContext

Direct Known Subclasses:

LocalManagementContext
```
public abstract class AbstractManagementContext
extends java.lang.Object
implements ManagementContextInternal
```

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

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
`AbstractManagementContext(BrooklynProperties brooklynProperties)`
`AbstractManagementContext(BrooklynProperties brooklynProperties, DataGridFactory datagridFactory)`

Method Summary

Methods
Modifier and Type	Method and Description
`abstract void`	`addEntitySetListener(CollectionChangeListener<Entity> listener)`
`java.util.List<java.lang.Throwable>`	`errors()` Object which allows adding, removing, and clearing errors.
`java.lang.ClassLoader`	`getBaseClassLoader()` Optional class-loader that this management context should use as its base, as the first-resort in the catalog, and for scanning (if scanning the default in the catalog).
`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.
`ExecutionContext`	`getExecutionContext(Entity e)` 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
`BrooklynGarbageCollector`	`getGarbageCollector()`
`HighAvailabilityManager`	`getHighAvailabilityManager()`
`LocationRegistry`	`getLocationRegistry()` Record of configured locations and location resolvers
`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.
`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 e)` Returns a `SubscriptionContext` instance representing subscriptions (from the `SubscriptionManager`) associated with this entity, and capable of conveniently subscribing on behalf of that entity
`long`	`getTotalEffectorInvocations()`
`<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)` Method for entity to make effector happen with correct semantics (right place, right task context), when a method is called on that entity.
`abstract boolean`	`isManagedLocally(Entity e)` Whether the master entity record is local, and sensors and effectors can be properly accessed locally.
`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
`abstract void`	`removeEntitySetListener(CollectionChangeListener<Entity> listener)`
`abstract <T> Task<T>`	`runAtEntity(java.util.Map flags, Entity entity, java.util.concurrent.Callable<T> c)` Deprecated. since 0.6.0 use effectors (or support `runAtEntity(Entity, Effector, Map)` if something else is needed); (Callable with Map flags is too open-ended, bothersome to support, and not used much)
`void`	`setBaseClassLoader(java.lang.ClassLoader cl)` See `getBaseClassLoader()`.
`void`	`setBaseClassPathForScanning(java.lang.Iterable<java.net.URL> urls)` Optional mechanism for setting the classpath which should be scanned by the catalog, if the catalog is scanning the default classpath.
`void`	`setCatalogInitialization(CatalogInitialization catalogInitialization)`
`void`	`setManagementNodeUri(java.net.URI uri)`
`void`	`terminate()`

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

Methods inherited from interface brooklyn.management.internal.ManagementContextInternal
getAccessManager, getEntityFactory, getLocationFactory, getOsgiManager, getPolicyFactory, getUsageManager, prePreManage, prePreManage

Methods inherited from interface brooklyn.management.ManagementContext
addPropertiesReloadListener, getAccessController, getApplications, getEntityManager, getExecutionManager, getLocationManager, getManagementNodeId, getManagementPlaneId, getSubscriptionManager, reloadBrooklynProperties, removePropertiesReloadListener

- Constructor Detail
  - AbstractManagementContext
```
public AbstractManagementContext(BrooklynProperties brooklynProperties)
```
  - AbstractManagementContext
```
public AbstractManagementContext(BrooklynProperties brooklynProperties,
                         DataGridFactory datagridFactory)
```
- Method Detail
  - terminate
```
public void terminate()
```
    Specified by:
    
    terminate in interface ManagementContextInternal
  - 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
  - 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
  - getTotalEffectorInvocations
```
public long getTotalEffectorInvocations()
```
    Specified by:
    
    getTotalEffectorInvocations in interface ManagementContextInternal
  - getExecutionContext
```
public ExecutionContext getExecutionContext(Entity e)
```
    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
  - getSubscriptionContext
```
public SubscriptionContext getSubscriptionContext(Entity e)
```
    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
  - 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
  - getEntitlementManager
```
public EntitlementManager getEntitlementManager()
```
    Description copied from interface: ManagementContext
    
    Active entitlements checker instance.
    
    Specified by:
    
    getEntitlementManager in interface ManagementContext
  - invokeEffector
```
public <T> Task<T> invokeEffector(Entity entity,
                         Effector<T> eff,
                         java.util.Map parameters)
```
    Specified by:
    
    invokeEffector in interface ManagementContextInternal
  - invokeEffectorMethodSync
```
public <T> T invokeEffectorMethodSync(Entity entity,
                             Effector<T> eff,
                             java.lang.Object args)
                           throws java.util.concurrent.ExecutionException
```
    Method for entity to make effector happen with correct semantics (right place, right task context), when a method is called on that entity.
    
    Specified by:
    
    invokeEffectorMethodSync in interface ManagementContextInternal
    
    Throws:
    
    java.util.concurrent.ExecutionException
  - isManagedLocally
```
public abstract boolean isManagedLocally(Entity e)
```
    Whether the master entity record is local, and sensors and effectors can be properly accessed locally.
  - runAtEntity
```
@Deprecated
public abstract <T> Task<T> runAtEntity(java.util.Map flags,
                                 Entity entity,
                                 java.util.concurrent.Callable<T> c)
```
    Deprecated. since 0.6.0 use effectors (or support runAtEntity(Entity, Effector, Map) if something else is needed); (Callable with Map flags is too open-ended, bothersome to support, and not used much)
    
    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.
  - addEntitySetListener
```
public abstract void addEntitySetListener(CollectionChangeListener<Entity> listener)
```
    Specified by:
    
    addEntitySetListener in interface ManagementContextInternal
  - removeEntitySetListener
```
public abstract void removeEntitySetListener(CollectionChangeListener<Entity> listener)
```
    Specified by:
    
    removeEntitySetListener in interface ManagementContextInternal
  - 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
  - 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
  - getBaseClassLoader
```
public java.lang.ClassLoader getBaseClassLoader()
```
    Optional class-loader that this management context should use as its base, as the first-resort in the catalog, and for scanning (if scanning the default in the catalog). In most instances the default classloader (ManagementContext.class.getClassLoader(), assuming this was in the JARs used at boot time) is fine, and in those cases this method normally returns null. (Surefire does some weird stuff, but the default classloader is fine for loading; however it requires a custom base classpath to be set for scanning.)
    
    Specified by:
    
    getBaseClassLoader in interface ManagementContextInternal
  - setBaseClassLoader
```
public void setBaseClassLoader(java.lang.ClassLoader cl)
```
    See getBaseClassLoader(). Only settable once and must be invoked before catalog is loaded.
  - setBaseClassPathForScanning
```
public void setBaseClassPathForScanning(java.lang.Iterable<java.net.URL> urls)
```
    Optional mechanism for setting the classpath which should be scanned by the catalog, if the catalog is scanning the default classpath. Usually it infers the right thing, but some classloaders (e.g. surefire) do funny things which the underlying org.reflections.Reflections library can't see in to.
    This should normally be invoked early in the server startup. Setting it after the catalog is loaded will not take effect without an explicit internal call to do so. Once set, it can be changed prior to catalog loading but it cannot be changed once the catalog is loaded.
    ClasspathHelper.forJavaClassPath() is often a good argument to pass, and is used internally in some places when no items are found on the catalog.
    
    Specified by:
    
    setBaseClassPathForScanning in interface ManagementContextInternal
  - getBaseClassPathForScanning
```
public java.lang.Iterable<java.net.URL> getBaseClassPathForScanning()
```
    Specified by:
    
    getBaseClassPathForScanning in interface ManagementContextInternal
    
    See Also:
    setBaseClassPathForScanning(Iterable)
  - getGarbageCollector
```
public BrooklynGarbageCollector getGarbageCollector()
```
  - setManagementNodeUri
```
public void setManagementNodeUri(java.net.URI uri)
```
    Specified by:
    
    setManagementNodeUri in interface ManagementContextInternal
  - 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
  - getCatalogInitialization
```
public CatalogInitialization getCatalogInitialization()
```
    Specified by:
    
    getCatalogInitialization in interface ManagementContextInternal
  - setCatalogInitialization
```
public void setCatalogInitialization(CatalogInitialization catalogInitialization)
```
    Specified by:
    
    setCatalogInitialization in interface ManagementContextInternal
  - 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

Class AbstractManagementContext

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

Methods inherited from interface brooklyn.management.internal.ManagementContextInternal

Methods inherited from interface brooklyn.management.ManagementContext

Constructor Detail

AbstractManagementContext

AbstractManagementContext

Method Detail

terminate

isRunning

isStartupComplete

getStorage

getRebindManager

getHighAvailabilityManager

getTotalEffectorInvocations

getExecutionContext

getServerExecutionContext

getSubscriptionContext

getEntityDriverManager

getEntityDownloadsManager

getEntitlementManager

invokeEffector

invokeEffectorMethodSync

isManagedLocally

runAtEntity

addEntitySetListener

removeEntitySetListener

getConfig

getBrooklynProperties

getLocationRegistry

getCatalog

getCatalogClassLoader

getBaseClassLoader

setBaseClassLoader

setBaseClassPathForScanning

getBaseClassPathForScanning

getGarbageCollector

setManagementNodeUri

getManagementNodeUri

getCatalogInitialization

setCatalogInitialization

lookup

lookup

errors