org.datanucleus

Class AbstractNucleusContext

java.lang.Object

org.datanucleus.AbstractNucleusContext

All Implemented Interfaces:

NucleusContext

Direct Known Subclasses:

EnhancementNucleusContextImpl, PersistenceNucleusContextImpl

public abstract class AbstractNucleusContext
extends Object
implements NucleusContext

Base implementation of a NucleusContext, providing configuration, metadata management, type management, plugin management and ClassLoader services.

Field Summary

Fields

Modifier and Type	Field and Description
protected ApiAdapter	apiAdapter API adapter used by the context.
protected String	classLoaderResolverClassName Name of the class providing the ClassLoaderResolver.
protected Map<String,ClassLoaderResolver>	classLoaderResolverMap Map of the ClassLoaderResolver, keyed by the clr class and the primaryLoader name.
protected Configuration	config Configuration for this context.
protected MetaDataManager	metaDataManager MetaDataManager for handling the MetaData.
protected PluginManager	pluginManager Manager for plug-ins.
static Set<String>	STARTUP_PROPERTIES
protected TypeManager	typeManager Manager for java types.

Constructor Summary

Constructors

Constructor and Description
AbstractNucleusContext(String apiName, Map startupProps, PluginManager pluginMgr)

Method Summary

Modifier and Type	Method and Description
void	applyDefaultProperties(Configuration conf) Method called when initialising the Configuration to load up defaults for the properties appropriate for this NucleusContext.
abstract void	close() Clear out resources for the supported services.
ApiAdapter	getApiAdapter()
String	getApiName() Accessor for the name of the API (JDO, JPA, etc).
ClassLoaderResolver	getClassLoaderResolver(ClassLoader primaryLoader) Accessor for a ClassLoaderResolver to use in resolving classes.
Configuration	getConfiguration()
MetaDataManager	getMetaDataManager()
PluginManager	getPluginManager()
TypeManager	getTypeManager()
void	initialise() Method to initialise the context for use.
protected void	logConfiguration() Method to log the configuration of this context.
protected abstract void	logConfigurationDetails() Convenience method so that extending implementations can log their own configuration.
boolean	supportsORMMetaData()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

config

protected final Configuration config

Configuration for this context.

pluginManager

protected final PluginManager pluginManager

Manager for plug-ins.

metaDataManager

protected MetaDataManager metaDataManager

MetaDataManager for handling the MetaData.

apiAdapter

protected final ApiAdapter apiAdapter

API adapter used by the context.

typeManager

protected TypeManager typeManager

Manager for java types.

classLoaderResolverClassName

protected final String classLoaderResolverClassName

Name of the class providing the ClassLoaderResolver.

classLoaderResolverMap

protected transient Map<String,ClassLoaderResolver> classLoaderResolverMap

Map of the ClassLoaderResolver, keyed by the clr class and the primaryLoader name.

STARTUP_PROPERTIES

public static final Set<String> STARTUP_PROPERTIES

Constructor Detail

AbstractNucleusContext

public AbstractNucleusContext(String apiName,
                              Map startupProps,
                              PluginManager pluginMgr)

Method Detail

applyDefaultProperties

public void applyDefaultProperties(Configuration conf)

Description copied from interface: NucleusContext

Method called when initialising the Configuration to load up defaults for the properties appropriate for this NucleusContext.

Specified by:

applyDefaultProperties in interface NucleusContext

Parameters:

conf - The configuration

initialise

public void initialise()

Description copied from interface: NucleusContext

Method to initialise the context for use. If any services are considered essential for operation then they will be enabled here, otherwise left for lazy initialisation.

Specified by:

initialise in interface NucleusContext

close

public abstract void close()

Description copied from interface: NucleusContext

Clear out resources for the supported services.

Specified by:

close in interface NucleusContext

getApiAdapter

public ApiAdapter getApiAdapter()

Specified by:

getApiAdapter in interface NucleusContext

getApiName

public String getApiName()

Description copied from interface: NucleusContext

Accessor for the name of the API (JDO, JPA, etc).

Specified by:

getApiName in interface NucleusContext

Returns:

the api

getConfiguration

public Configuration getConfiguration()

Specified by:

getConfiguration in interface NucleusContext

getPluginManager

public PluginManager getPluginManager()

Specified by:

getPluginManager in interface NucleusContext

getMetaDataManager

public MetaDataManager getMetaDataManager()

Specified by:

getMetaDataManager in interface NucleusContext

supportsORMMetaData

public boolean supportsORMMetaData()

Specified by:

supportsORMMetaData in interface NucleusContext

getTypeManager

public TypeManager getTypeManager()

Specified by:

getTypeManager in interface NucleusContext

getClassLoaderResolver

public ClassLoaderResolver getClassLoaderResolver(ClassLoader primaryLoader)

Description copied from interface: NucleusContext

Accessor for a ClassLoaderResolver to use in resolving classes. Caches the resolver for the specified primary loader, and hands it out if present.

Specified by:

getClassLoaderResolver in interface NucleusContext

Parameters:

primaryLoader - Loader to use as the primary loader (or null)

Returns:

The ClassLoader resolver

logConfiguration

protected void logConfiguration()

Method to log the configuration of this context.

logConfigurationDetails

protected abstract void logConfigurationDetails()

Convenience method so that extending implementations can log their own configuration.