fr.cnes.doi.plugin.impl.db

Class DefaultUserRoleImpl

java.lang.Object

fr.cnes.doi.db.AbstractUserRoleDBHelper

fr.cnes.doi.plugin.AbstractUserRolePluginHelper

fr.cnes.doi.plugin.impl.db.DefaultUserRoleImpl

All Implemented Interfaces:

PluginConfiguration, PluginMetadata

public final class DefaultUserRoleImpl
extends AbstractUserRolePluginHelper

Default implementation of the authentication plugin. This implementation defines users/groups/roles.

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 Class name.
private Map<String,Integer>	options Options for JDBC.
private static String	OWNER Plugin owner.
private MyMemoryRealm	REALM User/Role realm
private static String	VERSION Plugin version.

Fields inherited from class fr.cnes.doi.db.AbstractUserRoleDBHelper

ADD_USER_NOTIFICATION, REMOVE_USER_NOTIFICATION

Constructor Summary

Constructors

Constructor and Description
DefaultUserRoleImpl()

Method Summary

Modifier and Type	Method and Description
boolean	addDOIUser(String username, Boolean admin) Add a DOI user
boolean	addDOIUser(String username, Boolean admin, String email) Add a DOI user
boolean	addUserToRole(String user, int role) Adds an user to a specific role.
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<DOIUser>	getUsers() Returns the allowed users for authentication.
List<DOIUser>	getUsersFromRole(int roleName) Get users from a specific role.
String	getVersion() Returns the version of the plugin.
void	initConnection() Inits the connection
boolean	isConfigured() Checks if the plugin is already configured
static boolean	isPassword(String key) Checks if the keyword is a password.
boolean	isUserExist(String username) Tests if the user exists.
void	release() Release the plugin.
boolean	removeDOIUser(String username) Removes the user
boolean	removeUserToRole(String user, int role) Removes an user from a specific role.
void	setConfiguration(Object configuration) Sets the configuration.
boolean	setUserToAdminGroup(String user) Add user to Administrators group
private void	setUserToAdminGroupInDB(String user) Sets the user to the admin group.
boolean	unsetUserFromAdminGroup(String user) Remove user to Administrators group
StringBuilder	validate() Validates the parameters in the configuration file.

Methods inherited from class fr.cnes.doi.db.AbstractUserRoleDBHelper

getRealm

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

Class name.

REALM

private final MyMemoryRealm REALM

User/Role realm

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

DefaultUserRoleImpl

public DefaultUserRoleImpl()

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

getUsers

public List<DOIUser> getUsers()
                       throws DOIDbException

Returns the allowed users for authentication.

Specified by:

getUsers in class AbstractUserRoleDBHelper

Returns:

List of users to add for the authentication

Throws:

DOIDbException - When an error occurs

getUsersFromRole

public List<DOIUser> getUsersFromRole(int roleName)
                               throws DOIDbException

Get users from a specific role.

Specified by:

getUsersFromRole in class AbstractUserRoleDBHelper

Parameters:

roleName - role name

Returns:

The users related to a specific role

Throws:

DOIDbException - When an error occurs

addUserToRole

public boolean addUserToRole(String user,
                             int role)

Adds an user to a specific role.

Specified by:

addUserToRole in class AbstractUserRoleDBHelper

Parameters:

user - user to add

role - role

Returns:

True when the user is added otherwise False

removeUserToRole

public boolean removeUserToRole(String user,
                                int role)

Removes an user from a specific role.

Specified by:

removeUserToRole in class AbstractUserRoleDBHelper

Parameters:

user - user to remove

role - role

Returns:

True when the user is removed otherwise False

setUserToAdminGroupInDB

private void setUserToAdminGroupInDB(String user)
                              throws DOIDbException

Sets the user to the admin group.

Parameters:

user - username

Throws:

DOIDbException - - if a Database error occurs

setUserToAdminGroup

public boolean setUserToAdminGroup(String user)

Add user to Administrators group

Specified by:

setUserToAdminGroup in class AbstractUserRoleDBHelper

Parameters:

user - user to add

Returns:

True when the user is added in the admin group otherwise False

unsetUserFromAdminGroup

public boolean unsetUserFromAdminGroup(String user)

Remove user to Administrators group

Specified by:

unsetUserFromAdminGroup in class AbstractUserRoleDBHelper

Parameters:

user - user to add

Returns:

True when the user is removed from the admin group otherwise False

isUserExist

public boolean isUserExist(String username)

Tests if the user exists.

Specified by:

isUserExist in class AbstractUserRoleDBHelper

Parameters:

username - the user

Returns:

True when the user exists otherwise False

addDOIUser

public boolean addDOIUser(String username,
                          Boolean admin)

Add a DOI user

Specified by:

addDOIUser in class AbstractUserRoleDBHelper

Parameters:

username - username

admin - True when the user must be added in the admin group otherwise False

Returns:

True when the user is added otherwise False

addDOIUser

public boolean addDOIUser(String username,
                          Boolean admin,
                          String email)

Add a DOI user

Specified by:

addDOIUser in class AbstractUserRoleDBHelper

Parameters:

username - username

admin - True when the user must be added in the admin group otherwise False

email - email

Returns:

True when the the user is added otherwise false

removeDOIUser

public boolean removeDOIUser(String username)

Removes the user

Specified by:

removeDOIUser in class AbstractUserRoleDBHelper

Parameters:

username - user

Returns:

True when the user is removed 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

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