org.gcube.vremanagement.executor.pluginmanager

Class PluginManager

java.lang.Object

org.gcube.vremanagement.executor.pluginmanager.PluginManager

public class PluginManager
extends Object

This is a singleton class which discover on classpath the available plugins and map the plugin name to its implementation class. The plugin implementation class can be retrieved using its name.

Author:

Luca Frosini (ISTI - CNR) http://www.lucafrosini.com/

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PluginManager() Used by getInstance() function check the available plugin on classpath and add them on availablePlugins

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,org.gcube.vremanagement.executor.plugin.PluginDeclaration>	getAvailablePlugins()
static PluginManager	getInstance() Get the singleton instance of PluginManager().
org.gcube.vremanagement.executor.plugin.PluginDeclaration	getPlugin(String name)
static org.gcube.vremanagement.executor.plugin.PluginDeclaration	getPluginDeclaration(String pluginName) Retrieve the PluginDeclaration class representing the plugin which have the name provided as input
static org.gcube.vremanagement.executor.plugin.Plugin<? extends org.gcube.vremanagement.executor.plugin.PluginDeclaration>	instantiatePlugin(String pluginName)

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginManager

protected PluginManager()

Used by getInstance() function check the available plugin on classpath and add them on availablePlugins

Method Detail

getPluginDeclaration

public static org.gcube.vremanagement.executor.plugin.PluginDeclaration getPluginDeclaration(String pluginName)
                                                                                      throws org.gcube.vremanagement.executor.exception.PluginNotFoundException

Retrieve the PluginDeclaration class representing the plugin which have the name provided as input

Parameters:

pluginName - the name of the plugin

Returns:

the PluginDeclaration

Throws:

org.gcube.vremanagement.executor.exception.PluginNotFoundException - if the plugin is not available

instantiatePlugin

public static org.gcube.vremanagement.executor.plugin.Plugin<? extends org.gcube.vremanagement.executor.plugin.PluginDeclaration> instantiatePlugin(String pluginName)
                                                                                                                                             throws org.gcube.vremanagement.executor.exception.InputsNullException,
                                                                                                                                                    org.gcube.vremanagement.executor.exception.PluginNotFoundException

Throws:

org.gcube.vremanagement.executor.exception.InputsNullException

org.gcube.vremanagement.executor.exception.PluginNotFoundException

getInstance

public static PluginManager getInstance()

Get the singleton instance of PluginManager(). The first time this function is invoked the instance is null so it is created. Otherwise the already created instance is returned

Returns:

singleton instance of PluginManager()

getPlugin

public org.gcube.vremanagement.executor.plugin.PluginDeclaration getPlugin(String name)

Parameters:

name - The name of the plugin

Returns:

The plugin declaration if available, null otherwise

getAvailablePlugins

public Map<String,org.gcube.vremanagement.executor.plugin.PluginDeclaration> getAvailablePlugins()

Returns:

the availablePlugins