com.virtuosotechnologies.asaph.xmldatabase
Class XMLDatabasePlugin

java.lang.Object
  extended bycom.virtuosotechnologies.lib.plugin.BasicPluginInitializer
      extended bycom.virtuosotechnologies.asaph.xmldatabase.XMLDatabasePlugin
All Implemented Interfaces:
PluginInitializer

public class XMLDatabasePlugin
extends BasicPluginInitializer

Plugin that provides the XML database implementations.


Constructor Summary
XMLDatabasePlugin()
          Constructor.
 
Method Summary
 Object getAPIImplementation(Class apiClass, PluginLinker linker)
          A plugin must implement this method to provide the implementations of the APIs that it provides.
 void initialize(PluginLinker linker)
          Perform first initialization of the plugin.
 void shutDown(PluginLinker linker)
          Perform finalization and shutdown of the plugin.
 
Methods inherited from class com.virtuosotechnologies.lib.plugin.BasicPluginInitializer
preShutDown
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLDatabasePlugin

public XMLDatabasePlugin()
Constructor.

Method Detail

initialize

public void initialize(PluginLinker linker)
                throws PluginInitializerException
Perform first initialization of the plugin. This is called after the plugin is instantiated, but before it is asked to provide any of its API implementations. Any APIs the plugin declared it needed for initialization will be available through the linker when this method is called.

Plugins should perform any time-consuming initialization in this method, rather than in the constructor or static initializers, and should use this method to report any fatal errors during initialization.

Specified by:
initialize in interface PluginInitializer
Overrides:
initialize in class BasicPluginInitializer
Parameters:
linker - the linker for this plugin.
Throws:
PluginInitializerException - thrown if the plugin could not initialize itself.

getAPIImplementation

public Object getAPIImplementation(Class apiClass,
                                   PluginLinker linker)
                            throws PluginInitializerException
A plugin must implement this method to provide the implementations of the APIs that it provides. This method is called after the initialize() method. Any APIs the plugin declared it needed in to implement this API will be available through the linker when this method is called.

Plugins should perform any time-consuming initialization in this method, rather than in the constructor or static initializers, and should use this method to report any fatal errors during initialization.

Specified by:
getAPIImplementation in interface PluginInitializer
Overrides:
getAPIImplementation in class BasicPluginInitializer
Parameters:
apiClass - the class of the API to implement
linker - the linker for this plugin.
Returns:
an object implementing the API.
Throws:
PluginInitializerException - thrown if the plugin could not implement the API.

shutDown

public void shutDown(PluginLinker linker)
              throws PluginInitializerException
Perform finalization and shutdown of the plugin. This is called when the plugin is being unplugged.

Specified by:
shutDown in interface PluginInitializer
Overrides:
shutDown in class BasicPluginInitializer
Parameters:
linker - the linker for this plugin.
Throws:
PluginInitializerException - thrown if the plugin could not shut down.