Module org.datanucleus

Package org.datanucleus.plugin

Class NonManagedPluginRegistry

java.lang.Object

org.datanucleus.plugin.NonManagedPluginRegistry

All Implemented Interfaces:

PluginRegistry

public class NonManagedPluginRegistry
extends Object
implements PluginRegistry

Manages the registry of Extensions and Extension Points outside any OSGI container. This implementation cannot handle multiple versions of the same plugin, so it either raises an exception or logs the issue as a warning. This is different to that mandated by the OSGi specification 3.0 $3.5.2.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	NonManagedPluginRegistry.ExtensionSorter	Sorter for extensions that puts DataNucleus extensions first, then any vendor extension.

Constructor Summary

Constructors

Constructor	Description
NonManagedPluginRegistry(ClassLoaderResolver clr, String bundleCheckType, boolean allowUserBundles)	Constructor.

Method Summary

Modifier and Type	Method	Description
Object	createExecutableExtension(ConfigurationElement confElm, String name, Class[] argsClass, Object[] args)	Loads a class (do not initialize) from an attribute of ConfigurationElement
Bundle[]	getBundles()	Accessor for all registered bundles
ExtensionPoint	getExtensionPoint(String id)	Accessor for the ExtensionPoint with the specified id.
ExtensionPoint[]	getExtensionPoints()	Accessor for the currently registered ExtensionPoints.
Class	loadClass(String pluginId, String className)	Loads a class (do not initialize)
protected Bundle	registerBundle(URL manifest)	Register the plugin bundle.
protected Bundle	registerBundle(Manifest mf, URL manifest)	Register the plugin bundle.
void	registerExtensionPoints()	Look for Bundles/Plugins and register them.
protected void	registerExtensionPointsForPluginInternal(List extPoints, boolean updateExtensionPointsArray)	Register extension-points for the specified plugin.
void	registerExtensions()	Look for Bundles/Plugins and register them.
void	registerExtensionsForPlugin(URL pluginURL, Bundle bundle)	Register extension and extension points for the specified plugin.
void	resolveConstraints()	Resolve constraints declared in bundle manifest.mf files.
URL	resolveURLAsFileURL(URL url)	Converts a URL that uses a user-defined protocol into a URL that uses the file protocol.

Methods inherited from class java.lang.Object

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

Constructor Detail

NonManagedPluginRegistry

public NonManagedPluginRegistry(ClassLoaderResolver clr,
                                String bundleCheckType,
                                boolean allowUserBundles)

Constructor.

Parameters:

clr - the ClassLoaderResolver

bundleCheckType - Type of check on bundles (EXCEPTION, LOG, NONE)

allowUserBundles - Whether to only load DataNucleus bundles (org.datanucleus).

Method Detail

getExtensionPoint

public ExtensionPoint getExtensionPoint(String id)

Accessor for the ExtensionPoint with the specified id.

Specified by:

getExtensionPoint in interface PluginRegistry

Parameters:

id - the unique id of the extension point

Returns:

null if the ExtensionPoint is not registered

getExtensionPoints

public ExtensionPoint[] getExtensionPoints()

Accessor for the currently registered ExtensionPoints.

Specified by:

getExtensionPoints in interface PluginRegistry

Returns:

array of ExtensionPoints

registerExtensionPoints

public void registerExtensionPoints()

Look for Bundles/Plugins and register them. Register also ExtensionPoints and Extensions declared in "/plugin.xml" files

Specified by:

registerExtensionPoints in interface PluginRegistry

registerExtensionsForPlugin

public void registerExtensionsForPlugin(URL pluginURL,
                                        Bundle bundle)

Register extension and extension points for the specified plugin.

Parameters:

pluginURL - the URL to the plugin

bundle - the bundle

registerExtensions

public void registerExtensions()

Look for Bundles/Plugins and register them. Register also ExtensionPoints and Extensions declared in "/plugin.xml" files.

Specified by:

registerExtensions in interface PluginRegistry

registerExtensionPointsForPluginInternal

protected void registerExtensionPointsForPluginInternal(List extPoints,
                                                        boolean updateExtensionPointsArray)

Register extension-points for the specified plugin.

Parameters:

extPoints - ExtensionPoints for this plugin

updateExtensionPointsArray - Whether to update "extensionPoints" array

registerBundle

protected Bundle registerBundle(URL manifest)

Register the plugin bundle.

Parameters:

manifest - the url to the "meta-inf/manifest.mf" file or a jar file

Returns:

the Plugin

registerBundle

protected Bundle registerBundle(Manifest mf,
                                URL manifest)

Register the plugin bundle.

Parameters:

mf - the Manifest

manifest - the url to the "meta-inf/manifest.mf" file or a jar file

Returns:

the Plugin

createExecutableExtension

public Object createExecutableExtension(ConfigurationElement confElm,
                                        String name,
                                        Class[] argsClass,
                                        Object[] args)
                                 throws ClassNotFoundException,
                                        SecurityException,
                                        NoSuchMethodException,
                                        IllegalArgumentException,
                                        InstantiationException,
                                        IllegalAccessException,
                                        InvocationTargetException

Loads a class (do not initialize) from an attribute of ConfigurationElement

Specified by:

createExecutableExtension in interface PluginRegistry

Parameters:

confElm - the configuration element

name - the attribute name

argsClass - Classes of the args

args - The arguments

Returns:

the Class

Throws:

ClassNotFoundException - If an error occurs

SecurityException - If an error occurs

NoSuchMethodException - If an error occurs

IllegalArgumentException - If an error occurs

InstantiationException - If an error occurs

IllegalAccessException - If an error occurs

InvocationTargetException - If an error occurs

loadClass

public Class loadClass(String pluginId,
                       String className)
                throws ClassNotFoundException

Loads a class (do not initialize)

Specified by:

loadClass in interface PluginRegistry

Parameters:

pluginId - the plugin id

className - the class name

Returns:

the Class

Throws:

ClassNotFoundException - if an error occurs in loading

resolveURLAsFileURL

public URL resolveURLAsFileURL(URL url)
                        throws IOException

Converts a URL that uses a user-defined protocol into a URL that uses the file protocol.

Specified by:

resolveURLAsFileURL in interface PluginRegistry

Parameters:

url - the url to be converted

Returns:

the converted URL

Throws:

IOException - if an error occurs

resolveConstraints

public void resolveConstraints()

Resolve constraints declared in bundle manifest.mf files. This must be invoked after registering all bundles. Should log errors if bundles are not resolvable, or raise runtime exceptions.

Specified by:

resolveConstraints in interface PluginRegistry

getBundles

public Bundle[] getBundles()

Accessor for all registered bundles

Specified by:

getBundles in interface PluginRegistry

Returns:

the bundles

Throws:

UnsupportedOperationException - if this operation is not supported by the implementation