Package com.inesm.KeyManager.services

Class UserManager

java.lang.Object

com.inesm.KeyManager.services.UserManager

@Service
public class UserManager
extends Object

Provides all functionalities regarding user management.

Constructor Summary

Constructors

Constructor	Description
UserManager(UserRepository rep, CryptographyService crypto, SettingsService settings)	Constructor for the User Manager class.

Method Summary

Modifier and Type	Method	Description
void	changePassword(User user)	Updates a user password in the database.
Role	createRole(Role role)	Creates a new role in the database.
User	createUser(User user)	Creates a user in the database.
void	deleteRequest(long requestID)	Deletes a request from the database.
void	deleteRole(long roleID)	Deletes a role from the database.
void	deleteUser(String username)	Deletes a user from the database.
List<Operation>	getOperations()	Gets all available operations from the database.
List<Role>	getRoles()	Gets all roles from the database.
User	getUserByUsername(String username)	Gets a user from the database.
List<User>	getUsers()	Gets all users from the database.
User	loginUser(String username, String password)	Performs a login operation using password authentication.
User	loginUser2FA(String username, String password)	Performs a login operation using password authentication and smartcard authentication.
User	patchUser(User update)	Patches a user.
Role	updateRole(Role role)	Updates a role in the database.

Methods inherited from class java.lang.Object

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

Constructor Details

UserManager

@Autowired
public UserManager(UserRepository rep,
 CryptographyService crypto,
 SettingsService settings)

Constructor for the User Manager class.

Parameters:

rep - the user repository used to interface with the database

crypto - the cryptographic service used to hash and validate user passwords

settings - the settings service that holds user related settings

Method Details

loginUser2FA

public User loginUser2FA(String username,
 String password)
                  throws ObjectNotFoundException,
InvalidLoginException,
LoginAttemptLockedException,
ResourceLockedException

Performs a login operation using password authentication and smartcard authentication. Method currently implemented using the Portuguese Citizen Card for the smartcard authentication. Checks if the smartcard information is valid , and if the supplied password matches the stored password.

Parameters:

username - the username of the user

password - the password of the user

Returns:

the user object of the supplied username

Throws:

ObjectNotFoundException - if the user was not found in the database

InvalidLoginException - if the login operation failed due to password mismatch, citizenCard info mismatch, or smartcard authentication failure or an hashing operation error

LoginAttemptLockedException - if the user is currently locked from attempting logins

ResourceLockedException - if the user is not active

See Also:

• CryptographyService

loginUser

public User loginUser(String username,
 String password)
               throws ObjectNotFoundException,
InvalidLoginException,
LoginAttemptLockedException,
ResourceLockedException

Performs a login operation using password authentication. Checks if the supplied password matches the stored password.

Parameters:

username - the username of the user

password - the password of the user

Returns:

the user object of the supplied username

Throws:

ObjectNotFoundException - if the user was not found in the database

InvalidLoginException - if the login operation failed due to password mismatch, or an hashing operation error

LoginAttemptLockedException - if the user is currently locked from attempting logins

ResourceLockedException - if the user is not active

See Also:

• CryptographyService

getUsers

public List<User> getUsers()

Gets all users from the database.

Returns:

a list contained the retrieved users

getUserByUsername

public User getUserByUsername(String username)
                       throws ObjectNotFoundException

Gets a user from the database.

Parameters:

username - the username of the user

Returns:

the user retrieved

Throws:

ObjectNotFoundException - if the referenced user could not be found

createUser

public User createUser(User user)
                throws InvalidParametersException,
HashingErrorException

Creates a user in the database.

Parameters:

user - the user object to be created

Returns:

the created user

Throws:

InvalidParametersException - if the user object received contained any invalid parameters

HashingErrorException - if an exception occurred when attempting to hash the user password

patchUser

public User patchUser(User update)
               throws ObjectNotFoundException,
InvalidParametersException

Patches a user. Will update all fields set in the update, and replace them with the original user's fields.

Parameters:

update - the user object contained the fields to be updated, not null, must have username set

Returns:

the updated user object

Throws:

ObjectNotFoundException - if the user was not found

InvalidParametersException - if the user update contained invalid parameters

deleteUser

public void deleteUser(String username)
                throws ObjectNotFoundException

Deletes a user from the database.

Parameters:

username - the username of the user to be deleted

Throws:

ObjectNotFoundException - if the user specified could not be found.

changePassword

public void changePassword(User user)
                    throws HashingErrorException,
ObjectNotFoundException

Updates a user password in the database. Sets the temporary password field to false.

Parameters:

user - the user to be updated, not null, must have the username and password fields set.

Throws:

HashingErrorException - if an exception occurred hashing the user password

ObjectNotFoundException - if the user could not be found

getRoles

public List<Role> getRoles()

Gets all roles from the database.

Returns:

a list contained all the retrieved roles

createRole

public Role createRole(Role role)
                throws InvalidParametersException

Creates a new role in the database.

Parameters:

role - the role to be created

Returns:

the created role

Throws:

InvalidParametersException - if the role contained invalid parameters

updateRole

public Role updateRole(Role role)
                throws ObjectNotFoundException,
ResourceLockedException,
InvalidParametersException

Updates a role in the database.

Parameters:

role - the role containing the fields to be updated, not null, must have roleID set

Returns:

the update role

Throws:

ObjectNotFoundException - if the role could not be found

ResourceLockedException - if the role attempting to be updated is the default admin role

InvalidParametersException - if the role contained invalid parameters

deleteRole

public void deleteRole(long roleID)
                throws RoleCurrentlyAssignedException,
ObjectNotFoundException,
ResourceLockedException

Deletes a role from the database.

Parameters:

roleID - the roleID of the role to be deleted

Throws:

RoleCurrentlyAssignedException - if the role is currently assign to a user

ObjectNotFoundException - if the role specified could not be found

ResourceLockedException - if the role is the default admin role (not allowed to be deleted)

getOperations

public List<Operation> getOperations()

Gets all available operations from the database.

Returns:

the list containing all the operations retrieved

deleteRequest

public void deleteRequest(long requestID)
                   throws ObjectNotFoundException

Deletes a request from the database.

Parameters:

requestID - the requestID of the request to be deleted

Throws:

ObjectNotFoundException - if the referenced request could not be found