fr.cnes.doi.plugin.impl.db

Class DefaultTokenImpl

java.lang.Object

fr.cnes.doi.db.AbstractTokenDBHelper

fr.cnes.doi.plugin.AbstractTokenDBPluginHelper

fr.cnes.doi.plugin.impl.db.DefaultTokenImpl

All Implemented Interfaces:

PluginConfiguration, PluginMetadata

public final class DefaultTokenImpl
extends AbstractTokenDBPluginHelper

Default implementation of the token 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 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 Name of the class.
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
DefaultTokenImpl()

Method Summary

Modifier and Type	Method and Description
boolean	addToken(String jwt) Adds a token in the database
boolean	deleteToken(String jwt) Deletes a token from the database.
String	getAuthor() Returns the author of the plugin.
String	getDescription() Returns the description of the plugin
String	getLicense() Returns the license of the plugin.
String	getName() Returns the name of the plugin.
String	getOwner() Returns the owner of the plugin.
List<String>	getTokens() Return the token list from database.
String	getVersion() Returns the version of the plugin.
void	initConnection() Inits the connection
boolean	isConfigured() Checks if the plugin is already configured
boolean	isExist(String jwt) Tests if the token exists in the database.
static boolean	isPassword(String key) Checks if the keyword is a password.
void	release() Release the plugin.
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

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

LOG

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

Logger.

NAME

private final String NAME

Name of the class.

das

private DOIDbDataAccessService das

Database access.

conf

private Map<String,String> conf

Configuration file.

configured

private boolean configured

Status of the plugin configuration.

options

private final Map<String,Integer> options

Options for JDBC.

Constructor Detail

DefaultTokenImpl

public DefaultTokenImpl()

Method Detail

setConfiguration

public void setConfiguration(Object configuration)

Sets the configuration.

Parameters:

configuration - configuration parameters

initConnection

public void initConnection()
                    throws DoiRuntimeException

Inits the connection

Throws:

DoiRuntimeException - When an connection error happens

addToken

public boolean addToken(String jwt)

Adds a token in the database

Specified by:

addToken in class AbstractTokenDBHelper

Parameters:

jwt - a token

Returns:

True when the token is added to the database otherwise False

deleteToken

public boolean deleteToken(String jwt)

Deletes a token from the database.

Specified by:

deleteToken in class AbstractTokenDBHelper

Parameters:

jwt - the token

Returns:

True when the token is deletes otherwise false

isExist

public boolean isExist(String jwt)

Tests if the token exists in the database.

Specified by:

isExist in class AbstractTokenDBHelper

Parameters:

jwt - the token

Returns:

True when the token exists in the database otherwise False

getTokens

public List<String> getTokens()
                       throws DOIDbException

Return the token list from database.

Specified by:

getTokens in class AbstractTokenDBHelper

Returns:

the list of tokens

Throws:

DOIDbException - when an error occurs

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

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()

Checks if the plugin is already configured

Returns:

True when the plugin is already configured otherwise false