fr.cnes.doi.plugin.impl.db

Class DefaultProjectSuffixImpl

java.lang.Object

fr.cnes.doi.db.AbstractProjectSuffixDBHelper

fr.cnes.doi.plugin.AbstractProjectSuffixPluginHelper

fr.cnes.doi.plugin.impl.db.DefaultProjectSuffixImpl

All Implemented Interfaces:

PluginConfiguration, PluginMetadata

public final class DefaultProjectSuffixImpl
extends AbstractProjectSuffixPluginHelper

Default implementation of the project suffix database.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
private static String	AUTHOR Plugin author.
private Map<String,String>	conf Configuration file.
private boolean	configured Status of the plugin configuration.
private DOIDbDataAccessService	das DOI database access.
private static String	DESCRIPTION Plugin description.
private static String	LICENSE Plugin license.
private static org.apache.logging.log4j.Logger	LOG Logger.
private String	NAME Plugin name.
private Map<String,Integer>	options options for JDBC.
private static String	OWNER Plugin owner.
private static String	VERSION Plugin version.

Constructor Summary

Constructors

Constructor and Description
DefaultProjectSuffixImpl()

Method Summary

Modifier and Type	Method and Description
boolean	addProjectSuffix(int projectID, String projectName) Adds a suffix project in the database.
boolean	deleteProject(int projectID) Deletes a suffix project from the database.
List<DOIUser>	getAllDOIUsersForProject(int doiSuffix) Returns the users related to a project.
String	getAuthor() Returns the author of the plugin.
String	getDescription() Returns the description of the plugin
int	getIDFrom(String projectName) Returns the project suffix based on the project name.
String	getLicense() Returns the license of the plugin.
String	getName() Returns the name of the plugin.
String	getOwner() Returns the owner of the plugin.
String	getProjectFrom(int projectID) Returns the project name based on the suffix project.
List<DOIProject>	getProjects() Returns the database records.
List<DOIProject>	getProjectsFromUser(String userName) Returns the projects related to a specific user.
String	getVersion() Returns the version of the plugin.
void	initConnection() Inits the connection
boolean	isConfigured() Checks if the plugin is already configured
boolean	isExistID(int projectID) Tests is a suffix project exists in the database.
boolean	isExistProjectName(String projectName) Tests is the project name exists in the database.
static boolean	isPassword(String key) Checks if the keyword is a password.
void	release() Release the plugin.
boolean	renameProject(int projectId, String newProjectName) Rename a project in the database.
void	setConfiguration(Object configuration) Sets the configuration.
StringBuilder	validate() Validates the parameters in the configuration file.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.apache.logging.log4j.Logger LOG

Logger.

DESCRIPTION

private static final String DESCRIPTION

Plugin description.

See Also:

Constant Field Values

VERSION

private static final String VERSION

Plugin version.

See Also:

Constant Field Values

OWNER

private static final String OWNER

Plugin owner.

See Also:

Constant Field Values

AUTHOR

private static final String AUTHOR

Plugin author.

See Also:

Constant Field Values

LICENSE

private static final String LICENSE

Plugin license.

See Also:

Constant Field Values

NAME

private final String NAME

Plugin name.

das

private DOIDbDataAccessService das

DOI database access.

conf

private Map<String,String> conf

Configuration file.

options

private final Map<String,Integer> options

options for JDBC.

configured

private boolean configured

Status of the plugin configuration.

Constructor Detail

DefaultProjectSuffixImpl

public DefaultProjectSuffixImpl()

Method Detail

setConfiguration

public void setConfiguration(Object configuration)

Sets the configuration.

Parameters:

configuration - configuration parameters

initConnection

public void initConnection()
                    throws DoiRuntimeException

Description copied from interface: PluginConfiguration

Inits the connection

Throws:

DoiRuntimeException - When an connection error happens

addProjectSuffix

public boolean addProjectSuffix(int projectID,
                                String projectName)

Adds a suffix project in the database.

Specified by:

addProjectSuffix in class AbstractProjectSuffixDBHelper

Parameters:

projectID - suffix project

projectName - project name

Returns:

True when the suffix project is added otherwise False

deleteProject

public boolean deleteProject(int projectID)

Deletes a suffix project from the database.

Specified by:

deleteProject in class AbstractProjectSuffixDBHelper

Parameters:

projectID - the suffix project

Returns:

True when the suffix project has been deleted otherwise False

isExistID

public boolean isExistID(int projectID)

Tests is a suffix project exists in the database.

Specified by:

isExistID in class AbstractProjectSuffixDBHelper

Parameters:

projectID - suffix project

Returns:

True when the suffix project exists otherwise False

isExistProjectName

public boolean isExistProjectName(String projectName)

Tests is the project name exists in the database.

Specified by:

isExistProjectName in class AbstractProjectSuffixDBHelper

Parameters:

projectName - the project name

Returns:

True when the project name exists otherwise False.

getProjectFrom

public String getProjectFrom(int projectID)
                      throws DOIDbException

Returns the project name based on the suffix project.

Specified by:

getProjectFrom in class AbstractProjectSuffixDBHelper

Parameters:

projectID - the suffix project

Returns:

the project name

Throws:

DOIDbException - when an error occurs

getIDFrom

public int getIDFrom(String projectName)
              throws DOIDbException

Returns the project suffix based on the project name.

Specified by:

getIDFrom in class AbstractProjectSuffixDBHelper

Parameters:

projectName - the project name

Returns:

the suffix project

Throws:

DOIDbException - When an error occurs

getProjects

public List<DOIProject> getProjects()
                             throws DOIDbException

Returns the database records.

Specified by:

getProjects in class AbstractProjectSuffixDBHelper

Returns:

the database records

Throws:

DOIDbException - When an error occurs

getProjectsFromUser

public List<DOIProject> getProjectsFromUser(String userName)
                                     throws DOIDbException

Returns the projects related to a specific user.

Specified by:

getProjectsFromUser in class AbstractProjectSuffixDBHelper

Parameters:

userName - username

Returns:

the projected to an user

Throws:

DOIDbException - When an error occurs

renameProject

public boolean renameProject(int projectId,
                             String newProjectName)

Rename a project in the database.

Specified by:

renameProject in class AbstractProjectSuffixDBHelper

Parameters:

projectId - suffix project to be renamed

newProjectName - the new project name

Returns:

True when the project has been renamed otherwise False

getName

public String getName()

Returns the name of the plugin.

Returns:

the name

getDescription

public String getDescription()

Returns the description of the plugin

Returns:

description

getVersion

public String getVersion()

Returns the version of the plugin.

Returns:

the version

getAuthor

public String getAuthor()

Returns the author of the plugin.

Returns:

the author

getOwner

public String getOwner()

Returns the owner of the plugin.

Returns:

the owner

getLicense

public String getLicense()

Returns the license of the plugin.

Returns:

the license

getAllDOIUsersForProject

public List<DOIUser> getAllDOIUsersForProject(int doiSuffix)

Returns the users related to a project.

Specified by:

getAllDOIUsersForProject in class AbstractProjectSuffixDBHelper

Parameters:

doiSuffix - project

Returns:

the users

validate

public StringBuilder validate()

Validates the parameters in the configuration file.

Returns:

the error messages.

isPassword

public static boolean isPassword(String key)

Checks if the keyword is a password.

Parameters:

key - keyword to check

Returns:

True when the keyword is a password otherwise False

release

public void release()

Release the plugin.

isConfigured

public boolean isConfigured()

Description copied from interface: PluginConfiguration

Checks if the plugin is already configured

Returns:

True when the plugin is already configured otherwise false