fr.cnes.doi.plugin

Interface PluginConfiguration

All Known Implementing Classes:

AbstractAuthenticationPluginHelper, AbstractProjectSuffixPluginHelper, AbstractTokenDBPluginHelper, AbstractUserRolePluginHelper, DefaultLDAPImpl, DefaultProjectSuffixImpl, DefaultTokenImpl, DefaultUserRoleImpl

public interface PluginConfiguration

Provides validation for plugin configuration.

Author:

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

Method Summary

Modifier and Type	Method and Description
void	initConnection() Inits the connection
boolean	isConfigured() Checks if the plugin is already configured
void	release() Release the plugin.
void	setConfiguration(Object configuration) Sets the configuration.
StringBuilder	validate() Validates the parameters in the configuration file.

Method Detail

validate

StringBuilder validate()

Validates the parameters in the configuration file.

Returns:

the error messages.

setConfiguration

void setConfiguration(Object configuration)

Sets the configuration.

Parameters:

configuration - configuration parameters

isConfigured

boolean isConfigured()

Checks if the plugin is already configured

Returns:

True when the plugin is already configured otherwise false

initConnection

void initConnection()
             throws DoiRuntimeException

Inits the connection

Throws:

DoiRuntimeException - When an connection error happens

release

void release()

Release the plugin.