fr.cnes.doi.plugin

Class PluginFactory

java.lang.Object

fr.cnes.doi.plugin.PluginFactory

@Requirement(reqId="DOI_ARCHI_030",
             reqName="Plugins")
public final class PluginFactory
extends Object

Author:

Jean-Christophe Malapert (jean-christophe.malapert@cnes.fr)

Field Summary

Fields

Modifier and Type	Field and Description
private static Map<String,Object>	CONFIG Stores the instances of plugin.
private static Map<String,String>	PLUGINS_IMPL Map the name of an interface to the name of a corresponding concrete implementation class.
private static Map<String,String>	SETTINGS Settings.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PluginFactory() "Static" class cannot be instantiated

Method Summary

Modifier and Type	Method and Description
private static Object	buildObject(String aClassName) instantiates the plugin.
static AbstractAuthenticationPluginHelper	getAuthenticationSystem() Returns the concrete implementation of the authentication system.
private static <T> T	getPlugin(String implClassName) Returns the plugin according to its implementation class.
static AbstractProjectSuffixPluginHelper	getProjectSuffix() Returns the concrete implementation of the suffix project db.
static AbstractTokenDBPluginHelper	getToken() Returns the concrete implementation of the token db.
static AbstractUserRolePluginHelper	getUserManagement() Returns the concrete implementation of the user management interface.
static void	init(Map<String,String> settings) Loads the path of plugins from Settings.
static boolean	isPassword(String keywordClassName, String key) Checks if the key is a password in the class keywordClassName related to the configuration file

Methods inherited from class java.lang.Object

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

Field Detail

PLUGINS_IMPL

private static final Map<String,String> PLUGINS_IMPL

Map the name of an interface to the name of a corresponding concrete implementation class.

SETTINGS

private static final Map<String,String> SETTINGS

Settings.

CONFIG

private static final Map<String,Object> CONFIG

Stores the instances of plugin.

Constructor Detail

PluginFactory

private PluginFactory()

"Static" class cannot be instantiated

Method Detail

init

public static void init(Map<String,String> settings)

Loads the path of plugins from Settings.

Parameters:

settings - config settings

getUserManagement

public static AbstractUserRolePluginHelper getUserManagement()

Returns the concrete implementation of the user management interface.

Returns:

the plugin

getProjectSuffix

public static AbstractProjectSuffixPluginHelper getProjectSuffix()

Returns the concrete implementation of the suffix project db.

Returns:

the plugin

getToken

public static AbstractTokenDBPluginHelper getToken()

Returns the concrete implementation of the token db.

Returns:

the plugin

getAuthenticationSystem

public static AbstractAuthenticationPluginHelper getAuthenticationSystem()

Returns the concrete implementation of the authentication system.

Returns:

the plugin

isPassword

public static boolean isPassword(String keywordClassName,
                                 String key)
                          throws DoiRuntimeException

Checks if the key is a password in the class keywordClassName related to the configuration file

Parameters:

keywordClassName - plugin related to the configuration file

key - keyword

Returns:

True when key is a password otherwise false

Throws:

DoiRuntimeException - When an error occurs

getPlugin

private static <T> T getPlugin(String implClassName)

Returns the plugin according to its implementation class.

Type Parameters:

T - the plugin

Parameters:

implClassName - implementation class

Returns:

the plugin

buildObject

private static Object buildObject(String aClassName)
                           throws DoiRuntimeException

instantiates the plugin.

Parameters:

aClassName - the plugin name

Returns:

instance of aClassName

Throws:

DoiRuntimeException - - if aClassName cannot be instantiated