Package de.fraunhofer.iese.mydata.user

Interface IUserService

All Known Subinterfaces:

IManagementService

public interface IUserService

The Interface IUserService.

Method Summary

Modifier and Type	Method	Description
String	addSuperAdmin(User userModel)	Adds the super admin.
String	addUser(User userModel, AffiliationId affiliationId)	Adds the user.
void	deleteUser(String userId)	Delete user.
User	getUser(String userId)	Gets the user.
User	getUserByName(String username)	Get a user by user name
Set<User>	getUsers(boolean includeLocked)
Set<User>	getUsers(AffiliationId affiliationId, boolean includeLocked)	Gets the users.
Set<User>	getUsers(SolutionId solutionId, boolean includeLocked)	Gets the users.
Set<String>	listUsers(boolean includeLocked)
Set<String>	listUsers(AffiliationId affiliationId, boolean includeLocked)	Set users.
Set<String>	listUsers(SolutionId solutionId, boolean includeLocked)	List users.
void	lockUser(String userId)	Lock user.
void	setPassword(String userId, String newPassword)	Set password from static call.
void	unlockUser(String userId)	Unlock user.
void	updatePassword(String userId, String oldPassword, String newPassword)	Update password.
void	updateRole(String userId, MyDataRole newRole)	update the role of a user
void	updateUser(User userModel)	Update user.
boolean	userIdExists(String userId)	User id exists.
boolean	usernameExists(String username)	Username exists.

Method Detail

addUser

String addUser(User userModel,
               AffiliationId affiliationId)
        throws IOException,
               ConflictingResourceException,
               ResourceUpdateException,
               InvalidEntityException,
               NoSuchEntityException,
               MessagingException

Adds the user.

Parameters:

userModel - the user

affiliationId - the affiliation id

Returns:

the string

Throws:

IOException - Signals that an I/O exception has occurred.

ConflictingResourceException - the conflicting resource exception

ResourceUpdateException - the resource update exception

InvalidEntityException

NoSuchEntityException - if the affiliation does not exist

MessagingException - if the account created user could not be sent

userIdExists

boolean userIdExists(String userId)
              throws IOException,
                     NoSuchEntityException

User id exists.

Parameters:

userId - the user id

Returns:

true, if successful

Throws:

IOException

NoSuchEntityException

usernameExists

boolean usernameExists(String username)
                throws IOException,
                       NoSuchEntityException

Username exists.

Parameters:

username - the username

Returns:

true, if successful

Throws:

IOException

NoSuchEntityException - if the username does not exist

updateUser

void updateUser(User userModel)
         throws IOException,
                ResourceUpdateException,
                NoSuchEntityException,
                InvalidEntityException

Update user.

Parameters:

userModel - the user

Throws:

IOException - Signals that an I/O exception has occurred.

ResourceUpdateException - the resource update exception

NoSuchEntityException - the no such element exception

InvalidEntityException

getUser

User getUser(String userId)
      throws IOException,
             NoSuchEntityException

Gets the user.

Parameters:

userId - the user id

Returns:

the user

Throws:

IOException - Signals that an I/O exception has occurred.

NoSuchEntityException - the no such element exception

listUsers

Set<String> listUsers(boolean includeLocked)
               throws IOException

Throws:

IOException

listUsers

Set<String> listUsers(AffiliationId affiliationId,
                      boolean includeLocked)
               throws IOException,
                      NoSuchEntityException,
                      InvalidEntityException

Set users.

Parameters:

affiliationId - the affiliation component_id

includeLocked - the include locked

Returns:

the list

Throws:

IOException - Signals that an I/O exception has occurred.

NoSuchEntityException - the no such element exception

InvalidEntityException

listUsers

Set<String> listUsers(SolutionId solutionId,
                      boolean includeLocked)
               throws IOException,
                      InvalidEntityException,
                      NoSuchEntityException

List users.

Parameters:

solutionId - the solution id

includeLocked - the include locked

Returns:

the sets the

Throws:

IOException - Signals that an I/O exception has occurred.

InvalidEntityException

NoSuchEntityException

getUsers

Set<User> getUsers(boolean includeLocked)
            throws IOException

Throws:

IOException

getUsers

Set<User> getUsers(AffiliationId affiliationId,
                   boolean includeLocked)
            throws IOException,
                   NoSuchEntityException,
                   InvalidEntityException

Gets the users.

Parameters:

affiliationId - the affiliation id

includeLocked - the include locked

Returns:

the users

Throws:

IOException - Signals that an I/O exception has occurred.

NoSuchEntityException - the no such element exception

InvalidEntityException

getUsers

Set<User> getUsers(SolutionId solutionId,
                   boolean includeLocked)
            throws IOException,
                   InvalidEntityException,
                   NoSuchEntityException

Gets the users.

Parameters:

solutionId - the solution id

includeLocked - the include locked

Returns:

the users

Throws:

IOException - Signals that an I/O exception has occurred.

InvalidEntityException

NoSuchEntityException

lockUser

void lockUser(String userId)
       throws IOException,
              ResourceUpdateException,
              NoSuchEntityException

Lock user.

Parameters:

userId - the user id

Throws:

IOException - Signals that an I/O exception has occurred.

ResourceUpdateException - the resource update exception

NoSuchEntityException - the no such element exception

unlockUser

void unlockUser(String userId)
         throws IOException,
                ResourceUpdateException,
                NoSuchEntityException

Unlock user.

Parameters:

userId - the user id

Throws:

IOException - Signals that an I/O exception has occurred.

ResourceUpdateException - the resource update exception

NoSuchEntityException - the no such element exception

deleteUser

void deleteUser(String userId)
         throws IOException,
                ResourceUpdateException,
                NoSuchEntityException

Delete user.

Parameters:

userId - the user id

Throws:

IOException - Signals that an I/O exception has occurred.

ResourceUpdateException - the resource update exception

NoSuchEntityException - the no such element exception

updatePassword

void updatePassword(String userId,
                    String oldPassword,
                    String newPassword)
             throws IOException,
                    ResourceUpdateException,
                    NoSuchEntityException,
                    MessagingException

Update password.

Parameters:

userId - the user id

oldPassword - the old password

newPassword - the new password

newPasswordRepeat - the new password repeat

Throws:

IOException - Signals that an I/O exception has occurred.

ResourceUpdateException - the resource update exception

NoSuchEntityException - the no such element exception

MessagingException - if the password updated message could not be sent

setPassword

void setPassword(String userId,
                 String newPassword)
          throws IOException,
                 ResourceUpdateException,
                 NoSuchEntityException,
                 MessagingException

Set password from static call.

Parameters:

userId - the user UUID

newPassword - the new password

newPasswordRepeat - the new password repeat

Throws:

IOException - Signals that an I/O exception has occurred.

ResourceUpdateException - the resource update exception

NoSuchEntityException - the no such element exception

MessagingException - if the password updated message could not be sent

addSuperAdmin

String addSuperAdmin(User userModel)
              throws IOException,
                     ConflictingResourceException,
                     ResourceUpdateException,
                     InvalidEntityException,
                     MessagingException

Adds the super admin.

Parameters:

userModel - the user

loggedUser - the logged user

Returns:

the string

Throws:

IOException - Signals that an I/O exception has occurred.

ConflictingResourceException - the conflicting resource exception

ResourceUpdateException - the resource update exception

InvalidEntityException

MessagingException - if the account created message could not be sent

getUserByName

User getUserByName(String username)
            throws NoSuchEntityException,
                   IOException

Get a user by user name

Parameters:

username - Name of the user

Returns:

Throws:

NoSuchEntityException

IOException

updateRole

void updateRole(String userId,
                MyDataRole newRole)
         throws NoSuchEntityException,
                InvalidEntityException,
                IOException

update the role of a user

Parameters:

userId -

newRole -

Throws:

NoSuchEntityException

IllegalArgumentException

InvalidEntityException

IOException