es.uvigo.esei.dgss.letta.service

Class UserEJB

java.lang.Object

es.uvigo.esei.dgss.letta.service.UserEJB

public class UserEJB
extends Object

UserEJB is a service bean providing all the required user-related methods.

Author:

Jesús Álvarez Casanova, Adrián Rodríguez Fariña

Constructor Summary

Constructors

Constructor and Description
UserEJB()

Method Summary

Modifier and Type	Method and Description
Long	countUnreadNotifications() Count the unread UserNotifications by the current User.
Optional<es.uvigo.esei.dgss.letta.domain.entities.User>	get(String login) Retrieves the User associated with the received login name, returned as an Optional value that will be empty if the user is not found.
Optional<es.uvigo.esei.dgss.letta.domain.entities.User>	getByEmail(String email) Retrieves the User associated with the received email, returned as an Optional value that will be empty if the user is not found.
es.uvigo.esei.dgss.letta.domain.entities.UserNotifications	getNotification(int notificationId) Find a UserNotifications in the database.
List<es.uvigo.esei.dgss.letta.domain.entities.UserNotifications>	getNotifications() Get all the UserNotifications by the current User.
List<es.uvigo.esei.dgss.letta.domain.entities.User>	getUsers() Gets all the User in the database.
void	registerUser(es.uvigo.esei.dgss.letta.domain.entities.Registration registration) Register an user
es.uvigo.esei.dgss.letta.domain.entities.Registration	registrationWithLogin(String login) Finds a registration by login
void	removeUser(String login) Remove the User in the database.
es.uvigo.esei.dgss.letta.domain.entities.User	update(es.uvigo.esei.dgss.letta.domain.entities.User user)
boolean	userConfirmation(String uuid) Confirms a user registration
es.uvigo.esei.dgss.letta.domain.entities.User	userWithLogin(String login) Deprecated. Consider using get(String) instead, as it already checks the failure case where the User is not found, by returning it as an Optional value.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserEJB

public UserEJB()

Method Detail

get

@PermitAll
public Optional<es.uvigo.esei.dgss.letta.domain.entities.User> get(String login)
                                                                       throws IllegalArgumentException

Retrieves the User associated with the received login name, returned as an Optional value that will be empty if the user is not found. If the login is null, a NullPointerException will be thrown.

Parameters:

login - The login String to find in the database.

Returns:

An Optional value holding the uniquely found User object, or empty otherwise.

Throws:

IllegalArgumentException - if the received login is null.

getByEmail

@PermitAll
public Optional<es.uvigo.esei.dgss.letta.domain.entities.User> getByEmail(String email)
                                                                              throws IllegalArgumentException

Retrieves the User associated with the received email, returned as an Optional value that will be empty if the user is not found. If the email is null, a NullPointerException will be thrown/

Parameters:

email - The email String to find in the database.

Returns:

An Optional value holding the uniquely found User, or empty otherwise.

Throws:

IllegalArgumentException - if the received email is null.

registerUser

@PermitAll
public void registerUser(es.uvigo.esei.dgss.letta.domain.entities.Registration registration)
                             throws LoginDuplicateException,
                                    EmailDuplicateException,
                                    javax.mail.MessagingException

Register an user

Parameters:

registration - indicates the user to register

Throws:

LoginDuplicateException - if the user login already exists

EmailDuplicateException - if the user email already exists

javax.mail.MessagingException - exception thrown by the Messaging classes

userConfirmation

@PermitAll
public boolean userConfirmation(String uuid)

Confirms a user registration

Parameters:

uuid - indicates the user uuid

Returns:

true if the uuid doesn't exist

userWithLogin

@Deprecated
public es.uvigo.esei.dgss.letta.domain.entities.User userWithLogin(String login)

Deprecated. Consider using get(String) instead, as it already checks the failure case where the User is not found, by returning it as an Optional value.

Finds a user by login in the User table

Parameters:

login - indicates the user with login

Returns:

the result list if it is found

registrationWithLogin

@PermitAll
public es.uvigo.esei.dgss.letta.domain.entities.Registration registrationWithLogin(String login)

Finds a registration by login

Parameters:

login - indicates the user with login

Returns:

the result list of registrations

update

@RolesAllowed(value={"ADMIN","USER"})
public es.uvigo.esei.dgss.letta.domain.entities.User update(es.uvigo.esei.dgss.letta.domain.entities.User user)
                                                                                           throws IllegalArgumentException,
                                                                                                  SecurityException,
                                                                                                  EmailDuplicateException

Throws:

IllegalArgumentException

SecurityException

EmailDuplicateException

getUsers

@RolesAllowed(value="ADMIN")
public List<es.uvigo.esei.dgss.letta.domain.entities.User> getUsers()

Gets all the User in the database.

Returns:

The List with all the User sorted alphabetically.

removeUser

@RolesAllowed(value="ADMIN")
public void removeUser(String login)
                                             throws IllegalArgumentException,
                                                    SecurityException

Remove the User in the database.

Parameters:

login - the User login.

Throws:

IllegalArgumentException - if the User is null.

SecurityException - if the currently identified User is not found in the database.

getNotifications

@RolesAllowed(value={"ADMIN","USER"})
public List<es.uvigo.esei.dgss.letta.domain.entities.UserNotifications> getNotifications()

Get all the UserNotifications by the current User.

Returns:

a list with UserNotifications.

countUnreadNotifications

@RolesAllowed(value={"ADMIN","USER"})
public Long countUnreadNotifications()

Count the unread UserNotifications by the current User.

Returns:

a number of unread UserNotifications

getNotification

@RolesAllowed(value={"ADMIN","USER"})
public es.uvigo.esei.dgss.letta.domain.entities.UserNotifications getNotification(int notificationId)

Find a UserNotifications in the database.

Parameters:

notificationId - the id of the UserNotifications.

Returns:

the UserNotifications.