fr.cnes.doi.plugin.impl.db.service

Interface DOIDbDataAccessService

All Known Implementing Classes:

DOIDbDataAccessServiceImpl

public interface DOIDbDataAccessService

Interface between server and database

Method Summary

Modifier and Type	Method and Description
void	addDOIProject(int suffix, String projectname) Add a DOI project
void	addDOIProjectToUser(String username, int suffix) Assign a DOI project to a user
void	addDOIUser(String username, Boolean admin) Add a DOI user
void	addDOIUser(String username, Boolean admin, String email) Add a DOI user
void	addToken(String token) Add token
void	close() Close and release all the Data access connections.
void	deleteToken(String token) Delete token
List<DOIProject>	getAllDOIProjects() Get all DOI projects from data base
List<DOIProject>	getAllDOIProjectsForUser(String username) Get Projects related to a given username
List<DOIUser>	getAllDOIusers() Get all DOI users from data base
List<DOIUser>	getAllDOIUsersForProject(int suffix) Get Users from a given project.
String	getDOIProjectName(int suffix) Get Project name from its suffix.
List<String>	getTokens() Get tokens
boolean	isAdmin(String username) Check if user is an admin user
boolean	isUserExist(String username) Check if user exists in the database
void	removeDOIProject(int suffix) Remove a DOI project
void	removeDOIProjectFromUser(String username, int suffix) Remove a DOI project from a user
void	removeDOIUser(String username) Remove a DOI user
void	renameDOIProject(int suffix, String newprojectname) Rename DOI project from its suffix.
void	setAdmin(String username) Add admin right to a user
void	unsetAdmin(String username) Remove admin right from a user

Method Detail

getAllDOIusers

List<DOIUser> getAllDOIusers()
                      throws DOIDbException

Get all DOI users from data base

Returns:

list of DOIUser

Throws:

DOIDbException - When an Database exception happens

getAllDOIProjects

List<DOIProject> getAllDOIProjects()
                            throws DOIDbException

Get all DOI projects from data base

Returns:

list of DOI projects

Throws:

DOIDbException - When an Database exception happens

getAllDOIProjectsForUser

List<DOIProject> getAllDOIProjectsForUser(String username)
                                   throws DOIDbException

Get Projects related to a given username

Parameters:

username - username

Returns:

List of projects

Throws:

DOIDbException - When an Database exception happens

getAllDOIUsersForProject

List<DOIUser> getAllDOIUsersForProject(int suffix)
                                throws DOIDbException

Get Users from a given project.

Parameters:

suffix - suffix

Returns:

List of DOIUser

Throws:

DOIDbException - When an Database exception happens

addDOIUser

void addDOIUser(String username,
                Boolean admin)
         throws DOIDbException

Add a DOI user

Parameters:

username - username

admin - True when the user is admin otherwise False

Throws:

DOIDbException - When an Database exception happens

addDOIUser

void addDOIUser(String username,
                Boolean admin,
                String email)
         throws DOIDbException

Add a DOI user

Parameters:

username - username

admin - True when the user is admin otherwise False

email - email

Throws:

DOIDbException - When an Database exception happens

removeDOIUser

void removeDOIUser(String username)
            throws DOIDbException

Remove a DOI user

Parameters:

username - username

Throws:

DOIDbException - When an Database exception happens

removeDOIProject

void removeDOIProject(int suffix)
               throws DOIDbException

Remove a DOI project

Parameters:

suffix - suffix

Throws:

DOIDbException - When an Database exception happens

addDOIProject

void addDOIProject(int suffix,
                   String projectname)
            throws DOIDbException

Add a DOI project

Parameters:

suffix - suffix

projectname - project name

Throws:

DOIDbException - When an Database exception happens

addDOIProjectToUser

void addDOIProjectToUser(String username,
                         int suffix)
                  throws DOIDbException

Assign a DOI project to a user

Parameters:

username - user name

suffix - suffix related to a project

Throws:

DOIDbException - When an Database exception happens

removeDOIProjectFromUser

void removeDOIProjectFromUser(String username,
                              int suffix)
                       throws DOIDbException

Remove a DOI project from a user

Parameters:

username - user name

suffix - suffix related to a project

Throws:

DOIDbException - When an Database exception happens

setAdmin

void setAdmin(String username)
       throws DOIDbException

Add admin right to a user

Parameters:

username - user name

Throws:

DOIDbException - When an Database exception happens

unsetAdmin

void unsetAdmin(String username)
         throws DOIDbException

Remove admin right from a user

Parameters:

username - user name

Throws:

DOIDbException - When an Database exception happens

isAdmin

boolean isAdmin(String username)
         throws DOIDbException

Check if user is an admin user

Parameters:

username - user name

Returns:

false if user is not admin or doesn't exist

Throws:

DOIDbException - When an Database exception happens

isUserExist

boolean isUserExist(String username)
             throws DOIDbException

Check if user exists in the database

Parameters:

username - user name

Returns:

false if user does not exist

Throws:

DOIDbException - When an Database exception happens

renameDOIProject

void renameDOIProject(int suffix,
                      String newprojectname)
               throws DOIDbException

Rename DOI project from its suffix.

Parameters:

suffix - suffix

newprojectname - new project name

Throws:

DOIDbException - When an Database exception happens

getDOIProjectName

String getDOIProjectName(int suffix)
                  throws DOIDbException

Get Project name from its suffix.

Parameters:

suffix - suffix

Returns:

project name

Throws:

DOIDbException - When an Database exception happens

addToken

void addToken(String token)
       throws DOIDbException

Add token

Parameters:

token - Adds a token to the database

Throws:

DOIDbException - When an Database exception happens

deleteToken

void deleteToken(String token)
          throws DOIDbException

Delete token

Parameters:

token - token to delete

Throws:

DOIDbException - When an Database exception happens

getTokens

List<String> getTokens()
                throws DOIDbException

Get tokens

Returns:

List of tokens

Throws:

DOIDbException - When an Database exception happens

close

void close()
    throws DOIDbException

Close and release all the Data access connections.

Throws:

DOIDbException - When an error occurs