NucleusContext (DataNucleus Core 3.2.11 API)

java.lang.Object
- org.datanucleus.NucleusContext

All Implemented Interfaces:

Serializable
```
public class NucleusContext
extends Object
implements Serializable
```
Representation of the context being run within DataNucleus. Provides a series of services and can be used for persistence, or enhancement. Responsible for
- properties defining configuration for persistence.
- creating ExecutionContext objects to handle persistence. Uses a pool of ExecutionContext objects, reusing them as required.
- providing a cache across ExecutionContext objects (the "Level 2" cache).
- manages the plugins involved in this DataNucleus context
- provides access to the API in use
- manages metadata for persistable classes
- provides a factory for creating ObjectProviders. This factory makes use of pooling, allowing reuse.
- provides access to the datastore via a StoreManager
- provides access to the TypeManager, defining the behaviour for java types.
TODO For DataNucleus 4.0 create PersistenceContext which extends this and has all of the persistence-related fields (storeMgr, jca, txManager, jtaTxManager, etc) and remove "type" variable.
See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NucleusContext.ContextType

Nested Classes
Modifier and Type	Class and Description
`static class`	`NucleusContext.ContextType`

Field Summary

Fields
Modifier and Type	Field and Description
`protected static Localiser`	`LOCALISER` Localisation of messages.
`static Random`	`random` Random number generator, for use when needing unique names.
`static Set<String>`	`STARTUP_PROPERTIES`

Constructor Summary

Constructors
Constructor and Description
`NucleusContext(String apiName, Map startupProps)` Constructor for the context.
`NucleusContext(String apiName, Map startupProps, PluginManager pluginMgr)` Constructor for the context.
`NucleusContext(String apiName, NucleusContext.ContextType type, Map startupProps)` Constructor for the context.
`NucleusContext(String apiName, NucleusContext.ContextType type, Map startupProps, PluginManager pluginMgr)` Constructor for the context.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addExecutionContextListener(ExecutionContext.LifecycleListener listener)` Register a new Listener for ExecutionContext events.
`void`	`addInternalFetchGroup(FetchGroup grp)` Method to add a dynamic FetchGroup for use by this OMF.
`void`	`close()` Clear out resources
`FetchGroup`	`createInternalFetchGroup(Class cls, String name)` Method to create a new internal fetch group for the class+name.
`static StoreManager`	`createStoreManagerForProperties(Map<String,Object> props, Map<String,Object> datastoreProps, ClassLoaderResolver clr, NucleusContext nucCtx)` Method to create a StoreManager based on the specified properties passed in.
`ApiAdapter`	`getApiAdapter()` Accessor for the ApiAdapter
`String`	`getApiName()` Accessor for the name of the API (JDO, JPA, etc).
`AutoStartMechanism`	`getAutoStartMechanism()`
`ClassLoaderResolver`	`getClassLoaderResolver(ClassLoader primaryLoader)` Accessor for a ClassLoaderResolver to use in resolving classes.
`Class`	`getDatastoreIdentityClass()` Accessor for the class to use for datastore identity.
`ExecutionContext`	`getExecutionContext(Object owner, Map<String,Object> options)` Method to return an ExecutionContext for use in persistence.
`ExecutionContext.LifecycleListener[]`	`getExecutionContextListeners()` Object the array of registered ExecutionContext listeners.
`ExecutionContextPool`	`getExecutionContextPool()`
`FetchGroupManager`	`getFetchGroupManager()` Convenience accessor for the FetchGroupManager.
`Set<FetchGroup>`	`getFetchGroupsWithName(String name)` Accessor for the fetch groups for the specified name.
`IdentityKeyTranslator`	`getIdentityKeyTranslator()` Accessor for the current identity key translator to use (if any).
`IdentityStringTranslator`	`getIdentityStringTranslator()` Accessor for the current identity string translator to use (if any).
`ImplementationCreator`	`getImplementationCreator()`
`FetchGroup`	`getInternalFetchGroup(Class cls, String name)` Accessor for an internal fetch group for the specified class.
`ManagementManager`	`getJMXManager()` Accessor for the JMX manager (if required).
`JTASyncRegistry`	`getJtaSyncRegistry()`
`TransactionManager`	`getJtaTransactionManager()` Accessor for the JTA transaction manager (if using JTA).
`Level2Cache`	`getLevel2Cache()` Accessor for the DataStore (level 2) Cache
`MetaDataManager`	`getMetaDataManager()` Accessor for the Meta-Data Manager.
`ObjectProviderFactory`	`getObjectProviderFactory()`
`PersistenceConfiguration`	`getPersistenceConfiguration()` Accessor for the persistence configuration.
`PluginManager`	`getPluginManager()` Accessor for the Plugin Manager
`FactoryStatistics`	`getStatistics()`
`StoreManager`	`getStoreManager()` Accessor for the StoreManager
`static String`	`getTransactionIsolationForStoreManager(StoreManager storeMgr, String transactionIsolation)` Method to return the transaction isolation level that will be used for the provided StoreManager bearing in mind the specified level the user requested.
`TransactionManager`	`getTransactionManager()` Accessor for the transaction manager.
`NucleusContext.ContextType`	`getType()` Accessor for the type of this context (persistence, enhancer etc).
`TypeManager`	`getTypeManager()` Accessor for the Type Manager
`CallbackHandler`	`getValidationHandler(ExecutionContext ec)` Method to return a handler for validation (JSR303).
`boolean`	`hasLevel2Cache()` Return whether there is an L2 cache.
`void`	`initialise()` Method to initialise the context for use.
`protected void`	`initialiseAutoStart(ClassLoaderResolver clr)` Method to initialise the auto-start mechanism, loading up the classes from its store into memory so that we start from what is required to be loaded.
`protected void`	`initialiseNamedQueries(ClassLoaderResolver clr)` Method to compile all registered named queries (when the user has initialised using a persistence-unit).
`protected void`	`initialiseSchema(String generateModeStr, boolean generateScripts)` Method to handle generation (create, drop, drop+create) of a schema at initialisation.
`boolean`	`isClassCacheable(AbstractClassMetaData cmd)` Convenience method to return if objects of this type are cached for this NucleusContext.
`boolean`	`isClassWithIdentityCacheable(Object id)` Convenience method to return if the supplied id is of an object that is cacheable in the L2 cache.
`boolean`	`isJcaMode()` Accessor for the JCA mode.
`boolean`	`isStoreManagerInitialised()`
`protected void`	`logConfiguration()` Method to log the configuration of this context.
`void`	`removeExecutionContextListener(ExecutionContext.LifecycleListener listener)` Unregister a Listener from ExecutionContext events.
`void`	`removeInternalFetchGroup(FetchGroup grp)` Method to remove a dynamic FetchGroup from use by this OMF.
`void`	`setJcaMode(boolean jca)` Mutator for whether we are in JCA mode.
`boolean`	`statisticsEnabled()` Accessor for whether statistics gathering is enabled.

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

- Field Detail
  - LOCALISER
```
protected static final Localiser LOCALISER
```
    Localisation of messages.
  - random
```
public static final Random random
```
    Random number generator, for use when needing unique names.
  - STARTUP_PROPERTIES
```
public static final Set<String> STARTUP_PROPERTIES
```
- Constructor Detail
  - NucleusContext
```
public NucleusContext(String apiName,
              Map startupProps)
```
    Constructor for the context.
    
    Parameters:
    apiName - Name of the API that we need a context for (JDO, JPA, etc)
    startupProps - Any properties that could define behaviour of this context (plugin registry, class loading etc)
  - NucleusContext
```
public NucleusContext(String apiName,
              Map startupProps,
              PluginManager pluginMgr)
```
    Constructor for the context.
    
    Parameters:
    apiName - Name of the API that we need a context for (JDO, JPA, etc)
    startupProps - Any properties that could define behaviour of this context (plugin registry, class loading etc)
    pluginMgr - Plugin Manager (or null if wanting it to be created)
  - NucleusContext
```
public NucleusContext(String apiName,
              NucleusContext.ContextType type,
              Map startupProps)
```
    Constructor for the context.
    
    Parameters:
    apiName - Name of the API that we need a context for (JDO, JPA, etc)
    type - The type of context required (persistence, enhancement)
    startupProps - Any properties that could define behaviour of this context (plugin registry, class loading etc)
  - NucleusContext
```
public NucleusContext(String apiName,
              NucleusContext.ContextType type,
              Map startupProps,
              PluginManager pluginMgr)
```
    Constructor for the context.
    
    Parameters:
    apiName - Name of the API that we need a context for (JDO, JPA, etc)
    type - The type of context required (persistence, enhancement)
    startupProps - Any properties that could define behaviour of this context (plugin registry, class loading etc)
    pluginMgr - Plugin Manager (or null if wanting it to be created)
- Method Detail
  - initialise
```
public void initialise()
```
    Method to initialise the context for use. This creates the required StoreManager(s).
  - initialiseAutoStart
```
protected void initialiseAutoStart(ClassLoaderResolver clr)
                            throws DatastoreInitialisationException
```
    Method to initialise the auto-start mechanism, loading up the classes from its store into memory so that we start from what is required to be loaded.
    
    Parameters:
    clr - The ClassLoaderResolver
    
    Throws:
    
    DatastoreInitialisationException
  - getAutoStartMechanism
```
public AutoStartMechanism getAutoStartMechanism()
```
  - initialiseNamedQueries
```
protected void initialiseNamedQueries(ClassLoaderResolver clr)
```
    Method to compile all registered named queries (when the user has initialised using a persistence-unit).
    
    Parameters:
    clr - ClassLoader resolver
  - initialiseSchema
```
protected void initialiseSchema(String generateModeStr,
                    boolean generateScripts)
```
    Method to handle generation (create, drop, drop+create) of a schema at initialisation. Will generate the schema for all classes that have had their metadata loaded at this point, which typically means the persistence-unit.
    
    Parameters:
    generateModeStr - Generate "mode"
  - close
```
public void close()
```
    Clear out resources
  - getExecutionContextPool
```
public ExecutionContextPool getExecutionContextPool()
```
  - getType
```
public NucleusContext.ContextType getType()
```
    Accessor for the type of this context (persistence, enhancer etc).
    
    Returns:
    The type
  - getApiAdapter
```
public ApiAdapter getApiAdapter()
```
    Accessor for the ApiAdapter
    
    Returns:
    the ApiAdapter
  - getApiName
```
public String getApiName()
```
    Accessor for the name of the API (JDO, JPA, etc).
    
    Returns:
    the api
  - getPersistenceConfiguration
```
public PersistenceConfiguration getPersistenceConfiguration()
```
    Accessor for the persistence configuration.
    
    Returns:
    Returns the persistence configuration.
  - getPluginManager
```
public PluginManager getPluginManager()
```
    Accessor for the Plugin Manager
    
    Returns:
    the PluginManager
  - getMetaDataManager
```
public MetaDataManager getMetaDataManager()
```
    Accessor for the Meta-Data Manager.
    
    Returns:
    Returns the MetaDataManager.
  - getTypeManager
```
public TypeManager getTypeManager()
```
    Accessor for the Type Manager
    
    Returns:
    the TypeManager
  - getObjectProviderFactory
```
public ObjectProviderFactory getObjectProviderFactory()
```
  - getExecutionContext
```
public ExecutionContext getExecutionContext(Object owner,
                                   Map<String,Object> options)
```
    Method to return an ExecutionContext for use in persistence.
    
    Parameters:
    owner - The owner object for the context. A PM for example
    options - Any options affecting startup
    
    Returns:
    The ExecutionContext
  - getClassLoaderResolver
```
public ClassLoaderResolver getClassLoaderResolver(ClassLoader primaryLoader)
```
    Accessor for a ClassLoaderResolver to use in resolving classes. Caches the resolver for the specified primary loader, and hands it out if present.
    
    Parameters:
    primaryLoader - Loader to use as the primary loader (or null)
    
    Returns:
    The ClassLoader resolver
  - getTransactionIsolationForStoreManager
```
public static String getTransactionIsolationForStoreManager(StoreManager storeMgr,
                                            String transactionIsolation)
```
    Method to return the transaction isolation level that will be used for the provided StoreManager bearing in mind the specified level the user requested.
    
    Parameters:
    storeMgr - The Store Manager
    transactionIsolation - Requested isolation level
    
    Returns:
    Isolation level to use
    
    Throws:
    
    TransactionIsolationNotSupportedException - When no suitable level available given the requested level
  - createStoreManagerForProperties
```
public static StoreManager createStoreManagerForProperties(Map<String,Object> props,
                                           Map<String,Object> datastoreProps,
                                           ClassLoaderResolver clr,
                                           NucleusContext nucCtx)
```
    Method to create a StoreManager based on the specified properties passed in.
    
    Parameters:
    props - The overall persistence properties
    datastoreProps - Persistence properties to apply to the datastore
    clr - ClassLoader resolver
    
    Returns:
    The StoreManager
    
    Throws:
    
    NucleusUserException - if impossible to create the StoreManager (not in CLASSPATH?, invalid definition?)
  - logConfiguration
```
protected void logConfiguration()
```
    Method to log the configuration of this context.
  - getDatastoreIdentityClass
```
public Class getDatastoreIdentityClass()
```
    Accessor for the class to use for datastore identity.
    
    Returns:
    Class for datastore-identity
  - getIdentityStringTranslator
```
public IdentityStringTranslator getIdentityStringTranslator()
```
    Accessor for the current identity string translator to use (if any).
    
    Returns:
    Identity string translator instance (or null if persistence property not set)
  - getIdentityKeyTranslator
```
public IdentityKeyTranslator getIdentityKeyTranslator()
```
    Accessor for the current identity key translator to use (if any).
    
    Returns:
    Identity key translator instance (or null if persistence property not set)
  - statisticsEnabled
```
public boolean statisticsEnabled()
```
    Accessor for whether statistics gathering is enabled.
    
    Returns:
    Whether the user has enabled statistics or JMX management is enabled
  - getJMXManager
```
public ManagementManager getJMXManager()
```
    Accessor for the JMX manager (if required). Does nothing if the property "datanucleus.jmxType" is unset.
    
    Returns:
    The JMX manager
  - getStatistics
```
public FactoryStatistics getStatistics()
```
  - getImplementationCreator
```
public ImplementationCreator getImplementationCreator()
```
  - getTransactionManager
```
public TransactionManager getTransactionManager()
```
    Accessor for the transaction manager.
    
    Returns:
    The transaction manager.
  - getJtaTransactionManager
```
public TransactionManager getJtaTransactionManager()
```
    Accessor for the JTA transaction manager (if using JTA).
    
    Returns:
    the JTA Transaction Manager
  - getJtaSyncRegistry
```
public JTASyncRegistry getJtaSyncRegistry()
```
  - isStoreManagerInitialised
```
public boolean isStoreManagerInitialised()
```
  - getStoreManager
```
public StoreManager getStoreManager()
```
    Accessor for the StoreManager
    
    Returns:
    the StoreManager
  - getValidationHandler
```
public CallbackHandler getValidationHandler(ExecutionContext ec)
```
    Method to return a handler for validation (JSR303).
    
    Parameters:
    ec - The ExecutionContext that the handler is for.
    
    Returns:
    The handler (or null if not supported on this PMF/EMF, or no validator present)
  - hasLevel2Cache
```
public boolean hasLevel2Cache()
```
    Return whether there is an L2 cache.
    
    Returns:
    Whether the L2 cache is enabled
  - getLevel2Cache
```
public Level2Cache getLevel2Cache()
```
    Accessor for the DataStore (level 2) Cache
    
    Returns:
    The datastore cache
  - getExecutionContextListeners
```
public ExecutionContext.LifecycleListener[] getExecutionContextListeners()
```
    Object the array of registered ExecutionContext listeners.
    
    Returns:
    array of ExecutionContext.LifecycleListener
  - addExecutionContextListener
```
public void addExecutionContextListener(ExecutionContext.LifecycleListener listener)
```
    Register a new Listener for ExecutionContext events.
    
    Parameters:
    listener - the listener to register
  - removeExecutionContextListener
```
public void removeExecutionContextListener(ExecutionContext.LifecycleListener listener)
```
    Unregister a Listener from ExecutionContext events.
    
    Parameters:
    listener - the listener to unregister
  - setJcaMode
```
public void setJcaMode(boolean jca)
```
    Mutator for whether we are in JCA mode.
    
    Parameters:
    jca - true if using JCA connector
  - isJcaMode
```
public boolean isJcaMode()
```
    Accessor for the JCA mode.
    
    Returns:
    true if using JCA connector.
  - getFetchGroupManager
```
public FetchGroupManager getFetchGroupManager()
```
    Convenience accessor for the FetchGroupManager. Creates it if not yet existing.
    
    Returns:
    The FetchGroupManager
  - addInternalFetchGroup
```
public void addInternalFetchGroup(FetchGroup grp)
```
    Method to add a dynamic FetchGroup for use by this OMF.
    
    Parameters:
    grp - The group
  - removeInternalFetchGroup
```
public void removeInternalFetchGroup(FetchGroup grp)
```
    Method to remove a dynamic FetchGroup from use by this OMF.
    
    Parameters:
    grp - The group
  - createInternalFetchGroup
```
public FetchGroup createInternalFetchGroup(Class cls,
                                  String name)
```
    Method to create a new internal fetch group for the class+name.
    
    Parameters:
    cls - Class that it applies to
    name - Name of group
    
    Returns:
    The group
  - getInternalFetchGroup
```
public FetchGroup getInternalFetchGroup(Class cls,
                               String name)
```
    Accessor for an internal fetch group for the specified class.
    
    Parameters:
    cls - The class
    name - Name of the group
    
    Returns:
    The FetchGroup
    
    Throws:
    
    NucleusUserException - if the class is not persistable
  - getFetchGroupsWithName
```
public Set<FetchGroup> getFetchGroupsWithName(String name)
```
    Accessor for the fetch groups for the specified name.
    
    Parameters:
    name - Name of the group
    
    Returns:
    The FetchGroup
  - isClassWithIdentityCacheable
```
public boolean isClassWithIdentityCacheable(Object id)
```
    Convenience method to return if the supplied id is of an object that is cacheable in the L2 cache.
    
    Parameters:
    id - The identity
    
    Returns:
    Whether the object it refers to is considered cacheable
  - isClassCacheable
```
public boolean isClassCacheable(AbstractClassMetaData cmd)
```
    Convenience method to return if objects of this type are cached for this NucleusContext. Uses the "cacheable" flag of the class, and the cache-mode to determine whether to cache

Class NucleusContext

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOCALISER

random

STARTUP_PROPERTIES

Constructor Detail

NucleusContext

NucleusContext

NucleusContext

NucleusContext

Method Detail

initialise

initialiseAutoStart

getAutoStartMechanism

initialiseNamedQueries

initialiseSchema

close

getExecutionContextPool

getType

getApiAdapter

getApiName

getPersistenceConfiguration

getPluginManager

getMetaDataManager

getTypeManager

getObjectProviderFactory

getExecutionContext

getClassLoaderResolver

getTransactionIsolationForStoreManager

createStoreManagerForProperties

logConfiguration

getDatastoreIdentityClass

getIdentityStringTranslator

getIdentityKeyTranslator

statisticsEnabled

getJMXManager

getStatistics

getImplementationCreator

getTransactionManager

getJtaTransactionManager

getJtaSyncRegistry

isStoreManagerInitialised

getStoreManager

getValidationHandler

hasLevel2Cache

getLevel2Cache

getExecutionContextListeners

addExecutionContextListener

removeExecutionContextListener

setJcaMode

isJcaMode

getFetchGroupManager

addInternalFetchGroup

removeInternalFetchGroup

createInternalFetchGroup

getInternalFetchGroup

getFetchGroupsWithName

isClassWithIdentityCacheable

isClassCacheable