org.apache.brooklyn.core.mgmt.internal

Class LocalManagementContext

java.lang.Object

org.apache.brooklyn.core.mgmt.internal.AbstractManagementContext

org.apache.brooklyn.core.mgmt.internal.LocalManagementContext

All Implemented Interfaces:

ManagementContext, ManagementContextInternal

public class LocalManagementContext
extends AbstractManagementContext

A local (single node) implementation of the ManagementContext API.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.mgmt.ManagementContext

ManagementContext.PropertiesReloadListener

Field Summary

Fields

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

Fields inherited from interface org.apache.brooklyn.core.mgmt.internal.ManagementContextInternal

EFFECTOR_TAG, EMPTY_CATALOG_URL, NON_TRANSIENT_TASK_TAG, SUB_TASK_TAG, TRANSIENT_TASK_TAG

Constructor Summary

Constructors

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

Method Summary

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()
void	generateManagementPlaneId()
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	getManagementPlaneId() Deprecated.
Maybe<java.lang.String>	getManagementPlaneIdMaybe() UID for the Brooklyn management plane which this ManagementContext node is a part of.
ManagementNodeState	getNodeState() Returns node state, always reporting ManagementNodeState.INITIALIZING if there is any transition and ManagementNodeState.FAILED if there are any server errors.
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.
boolean	isStartupComplete() Whether all startup tasks have completed.
static void	logAll(org.slf4j.Logger logger)
void	noteStartupComplete()
void	noteStartupTransitioning() Exposed for services to advertise that startup tasks are again occurring
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	setManagementPlaneId(java.lang.String newPlaneId)
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 org.apache.brooklyn.core.mgmt.internal.AbstractManagementContext

errors, getBaseClassLoader, getBaseClassPathForScanning, getBrooklynProperties, getCatalog, getCatalogClassLoader, getCatalogInitialization, getConfig, getEntitlementManager, getEntityDownloadsManager, getEntityDriverManager, getExecutionContext, getExecutionContext, getExternalConfigProviderRegistry, getGarbageCollector, getHighAvailabilityManager, getLocationRegistry, getManagementNodeId, getManagementNodeUri, getRebindManager, getScratchpad, getServerExecutionContext, getStorage, getSubscriptionContext, getSubscriptionContext, getSubscriptionContext, getTotalEffectorInvocations, getTypeRegistry, invokeEffector, invokeEffectorMethodSync, isRunning, lookup, lookup, lookup, lookupAll, setBaseClassLoader, setBaseClassPathForScanning, setCatalogInitialization, setManagementNodeUri

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)

Creates a new LocalManagementContext.

Parameters:

brooklynProperties - the BrooklynProperties.

LocalManagementContext

public LocalManagementContext(BrooklynProperties.Factory.Builder builder)

LocalManagementContext

public LocalManagementContext(BrooklynProperties.Factory.Builder builder,
                              java.util.Map<java.lang.String,java.lang.Object> brooklynAdditionalProperties)

Method Detail

logAll

public static void logAll(org.slf4j.Logger logger)

terminateAll

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

@Deprecated
public java.lang.String getManagementPlaneId()

Deprecated.

Description copied from interface: ManagementContext

As ManagementContext.getManagementPlaneIdMaybe(), but throws if not available, to prevent callers accessing prematurely.

getManagementPlaneIdMaybe

public Maybe<java.lang.String> getManagementPlaneIdMaybe()

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()).

Returns absent while the management context is still initialising. The value is set:

• no persistence - during launch
• persistence enabled, HA disabled - on rebind (during launch)
• persistence enabled, HA enabled - on the first HA state check (async to launch)

setManagementPlaneId

public void setManagementPlaneId(java.lang.String newPlaneId)

generateManagementPlaneId

public void generateManagementPlaneId()

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)

removeEntitySetListener

public void removeEntitySetListener(CollectionChangeListener<Entity> listener)

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

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()

noteStartupTransitioning

public void noteStartupTransitioning()

Exposed for services to advertise that startup tasks are again occurring

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 returns false if HA state is transitioning. See ManagementContext.getNodeState() to atomically check node state, as the preferred way to tell if a node is master.

Specified by:

isStartupComplete in interface ManagementContext

Overrides:

isStartupComplete in class AbstractManagementContext

getNodeState

public ManagementNodeState getNodeState()

Description copied from interface: ManagementContext

Returns node state, always reporting ManagementNodeState.INITIALIZING if there is any transition and ManagementNodeState.FAILED if there are any server errors. If this returns ManagementNodeState.MASTER we can guarantee the node to be in master state, unlike HighAvailabilityManager.getNodeState() which may return ManagementNodeState.MASTER slightly early.