fr.cnes.doi.db

Class AbstractUserRoleDBHelper

java.lang.Object

fr.cnes.doi.db.AbstractUserRoleDBHelper

Direct Known Subclasses:

AbstractUserRolePluginHelper

@Requirement(reqId="DOI_INTER_050",
             reqName="Interface avec la base de donn\u00e9es de gestion des utilisateurs")
public abstract class AbstractUserRoleDBHelper
extends Object

Interface for handling users and role database. This database is used to authenticate the requests.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADD_USER_NOTIFICATION Notification message when an user is added "AddUserNotification".
private static MyMemoryRealm	REALM Realm.
static String	REMOVE_USER_NOTIFICATION Notification message when an user is deleted "RemoveUserNotification".

Constructor Summary

Constructors

Constructor and Description
AbstractUserRoleDBHelper()

Method Summary

Modifier and Type	Method and Description
abstract boolean	addDOIUser(String username, Boolean admin) Add a DOI user
abstract boolean	addDOIUser(String username, Boolean admin, String email) Add a DOI user
abstract boolean	addUserToRole(String user, int role) Adds an user to a specific role.
MyMemoryRealm	getRealm() Returns the realm.
abstract List<DOIUser>	getUsers() Returns the allowed users for authentication.
abstract List<DOIUser>	getUsersFromRole(int roleName) Get users from a specific role.
abstract boolean	isUserExist(String username) Tests if the user exists.
abstract boolean	removeDOIUser(String username) Removes the user
abstract boolean	removeUserToRole(String user, int role) Removes an user from a specific role.
abstract boolean	setUserToAdminGroup(String admin) Add user to Administrators group
abstract boolean	unsetUserFromAdminGroup(String admin) Remove user to Administrators group

Methods inherited from class java.lang.Object

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

Field Detail

ADD_USER_NOTIFICATION

public static final String ADD_USER_NOTIFICATION

Notification message when an user is added "AddUserNotification".

See Also:

Constant Field Values

REMOVE_USER_NOTIFICATION

public static final String REMOVE_USER_NOTIFICATION

Notification message when an user is deleted "RemoveUserNotification".

See Also:

Constant Field Values

REALM

private static final MyMemoryRealm REALM

Realm.

Constructor Detail

AbstractUserRoleDBHelper

public AbstractUserRoleDBHelper()

Method Detail

getRealm

public MyMemoryRealm getRealm()

Returns the realm.

Returns:

the realm

getUsers

public abstract List<DOIUser> getUsers()
                                throws DOIDbException

Returns the allowed users for authentication.

Returns:

List of users to add for the authentication

Throws:

DOIDbException - When an error occurs

getUsersFromRole

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

Get users from a specific role.

Parameters:

roleName - role name

Returns:

The users related to a specific role

Throws:

DOIDbException - When an error occurs

addUserToRole

public abstract boolean addUserToRole(String user,
                                      int role)

Adds an user to a specific role.

Parameters:

user - user to add

role - role

Returns:

True when the user is added otherwise False

removeUserToRole

public abstract boolean removeUserToRole(String user,
                                         int role)

Removes an user from a specific role.

Parameters:

user - user to remove

role - role

Returns:

True when the user is removed otherwise False

setUserToAdminGroup

public abstract boolean setUserToAdminGroup(String admin)

Add user to Administrators group

Parameters:

admin - user to add

Returns:

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

unsetUserFromAdminGroup

public abstract boolean unsetUserFromAdminGroup(String admin)

Remove user to Administrators group

Parameters:

admin - user to add

Returns:

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

addDOIUser

public abstract boolean addDOIUser(String username,
                                   Boolean admin)

Add a DOI user

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 abstract boolean addDOIUser(String username,
                                   Boolean admin,
                                   String email)

Add a DOI user

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

isUserExist

public abstract boolean isUserExist(String username)

Tests if the user exists.

Parameters:

username - the user

Returns:

True when the user exists otherwise False

removeDOIUser

public abstract boolean removeDOIUser(String username)

Removes the user

Parameters:

username - user

Returns:

True when the user is removed otherwise false