2 * Copyright (C) 2016 Roland Haeder
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU Affero General Public License as
6 * published by the Free Software Foundation, either version 3 of the
7 * License, or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU Affero General Public License for more details.
14 * You should have received a copy of the GNU Affero General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 package org.mxchange.jusercore.model.user;
19 import java.text.MessageFormat;
20 import java.util.GregorianCalendar;
21 import java.util.List;
23 import javax.ejb.EJBException;
24 import javax.ejb.Stateless;
25 import javax.persistence.NoResultException;
26 import javax.persistence.PersistenceException;
27 import javax.persistence.Query;
28 import org.mxchange.jcontacts.contact.Contact;
29 import org.mxchange.jphone.phonenumbers.cellphone.DialableCellphoneNumber;
30 import org.mxchange.jphone.phonenumbers.fax.DialableFaxNumber;
31 import org.mxchange.jphone.phonenumbers.landline.DialableLandLineNumber;
32 import org.mxchange.jusercore.exceptions.EmailAddressAlreadyRegisteredException;
33 import org.mxchange.jusercore.exceptions.UserNameAlreadyRegisteredException;
34 import org.mxchange.jusercore.exceptions.UserNotFoundException;
35 import org.mxchange.jusercore.model.register.UserRegistrationSessionBeanRemote;
36 import org.mxchange.jusercore.model.user.profilemodes.ProfileMode;
37 import org.mxchange.jusercore.model.user.status.UserAccountStatus;
38 import org.mxchange.pizzaaplication.database.BasePizzaDatabaseBean;
43 * @author Roland Haeder<roland@mxchange.org>
45 @Stateless (name = "user", description = "A bean handling the user data")
46 public class PizzaUserSessionBean extends BasePizzaDatabaseBean implements UserSessionBeanRemote {
51 private static final long serialVersionUID = 542_145_347_916L;
57 private UserRegistrationSessionBeanRemote registerBean;
62 public PizzaUserSessionBean () {
66 public User addUser (final User user) throws UserNameAlreadyRegisteredException, EmailAddressAlreadyRegisteredException {
68 this.getLoggerBeanLocal().logTrace(MessageFormat.format("addUser: user={0} - CALLED!", user)); //NOI18N
70 // userId should not be null
73 throw new NullPointerException("user is null"); //NOI18N
74 } else if (user.getUserId() == null) {
76 throw new NullPointerException("user.userId is null"); //NOI18N
77 } else if (user.getUserId() < 1) {
79 throw new IllegalArgumentException(MessageFormat.format("userId is not valid: {0}", user.getUserId())); //NOI18N
82 // Check if user is registered
83 if (this.registerBean.isUserNameRegistered(user)) {
85 throw new UserNameAlreadyRegisteredException(user);
86 } else if (this.registerBean.isEmailAddressRegistered(user)) {
88 throw new EmailAddressAlreadyRegisteredException(user);
91 // Set created timestamp
92 user.setUserCreated(new GregorianCalendar());
93 user.getUserContact().setContactCreated(new GregorianCalendar());
95 // Update cellphone, land-line and fax instance
96 this.setAllContactPhoneEntriesCreated(user.getUserContact());
99 this.getEntityManager().persist(user);
101 // Flush to get id back
102 this.getEntityManager().flush();
105 this.getLoggerBeanLocal().logTrace(MessageFormat.format("addUser: user={0},user.id={1} - EXIT!", user, user.getUserId())); //NOI18N
112 @SuppressWarnings ("unchecked")
113 public List<User> allMemberPublicVisibleUsers () {
115 this.getLoggerBeanLocal().logTrace("allMemberPublicVisibleUsers: CALLED!"); //NOI18N
118 Query query = this.getEntityManager().createNamedQuery("AllMemberPublicUsers", List.class); //NOI18N
121 query.setParameter("status", UserAccountStatus.CONFIRMED); //NOI18N
122 query.setParameter("members", ProfileMode.MEMBERS); //NOI18N
123 query.setParameter("public", ProfileMode.PUBLIC); //NOI18N
126 List<User> users = query.getResultList();
129 this.getLoggerBeanLocal().logTrace(MessageFormat.format("allMemberPublicVisibleUsers: users.size()={0} - EXIT!", users.size())); //NOI18N
136 @SuppressWarnings ("unchecked")
137 public List<User> allPublicUsers () {
139 this.getLoggerBeanLocal().logTrace("allPublicUsers: CALLED!"); //NOI18N
142 Query query = this.getEntityManager().createNamedQuery("AllPublicUsers", List.class); //NOI18N
145 query.setParameter("status", UserAccountStatus.CONFIRMED); //NOI18N
146 query.setParameter("mode", ProfileMode.PUBLIC); //NOI18N
149 List<User> users = query.getResultList();
152 this.getLoggerBeanLocal().logTrace(MessageFormat.format("allPublicUsers: users.size()={0} - EXIT!", users.size())); //NOI18N
159 @SuppressWarnings ("unchecked")
160 public List<User> allUsers () {
162 this.getLoggerBeanLocal().logTrace("allUsers: CALLED!"); //NOI18N
165 Query query = this.getEntityManager().createNamedQuery("AllUsers", List.class); //NOI18N
168 List<User> users = query.getResultList();
171 this.getLoggerBeanLocal().logTrace(MessageFormat.format("allUsers: users.size()={0} - EXIT!", users.size())); //NOI18N
178 public User fillUserData (final User user) {
180 this.getLoggerBeanLocal().logTrace(MessageFormat.format("fillUserData: user={0} - CALLED!", user)); //NOI18N
182 // user should not be null
185 throw new NullPointerException("user is null"); //NOI18N
189 Query query = this.getEntityManager().createNamedQuery("SearchUserByName", User.class); //NOI18N
192 query.setParameter("param", user.getUserName()); //NOI18N
194 // Initialize variable
195 User foundUser = null;
199 // Try to get single result
200 foundUser = (User) query.getSingleResult();
201 } catch (final NoResultException ex) {
203 this.getLoggerBeanLocal().logException(ex);
207 this.getLoggerBeanLocal().logTrace(MessageFormat.format("fillUserData: foundUser={0} - EXIT!", foundUser)); //NOI18N
209 // Return prepared instance
214 public User findUserById (final Long userId) throws UserNotFoundException {
216 this.getLoggerBeanLocal().logTrace(MessageFormat.format("findUserById: userId={0} - CALLED!", userId)); //NOI18N
218 // Is the parameter valid?
219 if (null == userId) {
221 throw new NullPointerException("userId is null"); //NOI18N
222 } else if (userId < 1) {
224 throw new IllegalArgumentException(MessageFormat.format("userId={0} is not valid.", userId)); //NOI18N
225 } else if (!this.ifUserIdExists(userId)) {
227 throw new UserNotFoundException(userId);
230 // Create query instance
231 Query query = this.getEntityManager().createNamedQuery("SearchUserById", User.class); //NOI18N
234 query.setParameter("id", userId); //NOI18N
236 // Fetch the result, it should be there by now
237 User user = (User) query.getSingleResult();
240 // @TODO This assertion tests the JPA
241 assert (user instanceof User) : "user is null"; //NOI18N
244 this.getLoggerBeanLocal().logTrace(MessageFormat.format("findUserById: user={0} - EXIT!", user)); //NOI18N
251 public String generateRandomUserName () {
253 this.getLoggerBeanLocal().logTrace("generateRandomUserName - CALLED!"); //NOI18N
256 List<String> userList = this.getUserNameList();
259 String userName = null;
261 // Loop until a user name is found
262 while ((userName == null) || (userList.contains(userName))) {
263 // Generate random name
264 userName = UserUtils.generateRandomUserName();
268 this.getLoggerBeanLocal().logTrace(MessageFormat.format("generateRandomUserName: userName={0} - EXIT!", userName)); //NOI18N
270 // Found one, so return it
275 @SuppressWarnings ("unchecked")
276 public List<String> getEmailAddressList () {
278 Query query = this.getEntityManager().createNamedQuery("AllEmailAddresses", String.class); //NOI18N
281 List<String> emailAddressList = query.getResultList();
284 return emailAddressList;
288 @SuppressWarnings ("unchecked")
289 public List<String> getUserNameList () {
291 Query query = this.getEntityManager().createNamedQuery("AllUserNames", String.class); //NOI18N
294 List<String> userNameList = query.getResultList();
301 public boolean ifUserExists (final User user) {
303 this.getLoggerBeanLocal().logTrace(MessageFormat.format("ifUserExists: user={0} - CALLED!", user)); //NOI18N
305 // userId should not be null
308 throw new NullPointerException("user is null"); //NOI18N
309 } else if (user.getUserId() == null) {
311 throw new NullPointerException("user.userId is null"); //NOI18N
312 } else if (user.getUserId() < 1) {
314 throw new IllegalArgumentException(MessageFormat.format("userId is not valid: {0}", user.getUserId())); //NOI18N
318 Query query = this.getEntityManager().createNamedQuery("SearchUserById", User.class); //NOI18N
321 query.setParameter("id", user.getUserId()); //NOI18N
325 User dummy = (User) query.getSingleResult();
328 this.getLoggerBeanLocal().logDebug(MessageFormat.format("ifUserExists: dummy.id={0} found.", dummy.getUserId())); //NOI18N
329 } catch (final NoResultException ex) {
331 this.getLoggerBeanLocal().logDebug(MessageFormat.format("ifUserExists: getSingleResult() returned no result: {0}", ex)); //NOI18N
333 // User name does not exist
335 } catch (final PersistenceException ex) {
336 // Something bad happened
337 this.getLoggerBeanLocal().logWarning(MessageFormat.format("More than one user {0} found.", user, ex)); //NOI18N
344 this.getLoggerBeanLocal().logTrace(MessageFormat.format("ifUserExists: Found user {0} - EXIT!", user)); //NOI18N
351 public boolean ifUserIdExists (final Long userId) {
353 this.getLoggerBeanLocal().logTrace(MessageFormat.format("ifUserIdExists: userId={0} - CALLED!", userId)); //NOI18N
355 // userId should not be null
356 if (null == userId) {
358 throw new NullPointerException("userId is null"); //NOI18N
359 } else if (userId < 1) {
361 throw new IllegalArgumentException(MessageFormat.format("userId is not valid: {0}", userId)); //NOI18N
365 Query query = this.getEntityManager().createNamedQuery("SearchUserById", User.class); //NOI18N
368 query.setParameter("id", userId); //NOI18N
372 User dummy = (User) query.getSingleResult();
375 this.getLoggerBeanLocal().logDebug(MessageFormat.format("ifUserIdExists: dummy.id={0} found.", dummy.getUserId())); //NOI18N
376 } catch (final NoResultException ex) {
378 this.getLoggerBeanLocal().logDebug(MessageFormat.format("ifUserIdExists: getSingleResult() returned no result: {0}", ex)); //NOI18N
380 // User name does not exist
382 } catch (final PersistenceException ex) {
383 // Something bad happened
384 this.getLoggerBeanLocal().logWarning(MessageFormat.format("More than one user id {0} found.", userId, ex)); //NOI18N
391 this.getLoggerBeanLocal().logTrace(MessageFormat.format("ifUserIdExists: Found user id {0} - EXIT!", userId)); //NOI18N
398 public boolean ifUserNameExists (final String userName) {
400 this.getLoggerBeanLocal().logTrace(MessageFormat.format("ifUserNameExists: userName={0} - CALLED!", userName)); //NOI18N
402 // userId should not be null
403 if (null == userName) {
405 throw new NullPointerException("userName is null"); //NOI18N
406 } else if (userName.isEmpty()) {
408 throw new NullPointerException("userName is empty"); //NOI18N
412 Query query = this.getEntityManager().createNamedQuery("SearchUserByName", User.class); //NOI18N
415 query.setParameter("param", userName); //NOI18N
419 User dummy = (User) query.getSingleResult();
422 this.getLoggerBeanLocal().logDebug(MessageFormat.format("ifUserNameExists: dummy.id={0} found.", dummy.getUserId())); //NOI18N
423 } catch (final NoResultException ex) {
425 this.getLoggerBeanLocal().logDebug(MessageFormat.format("ifUserNameExists: getSingleResult() returned no result: {0}", ex)); //NOI18N
427 // User name does not exist
432 this.getLoggerBeanLocal().logTrace(MessageFormat.format("ifUserNameExists: Found user name {0} - EXIT!", userName)); //NOI18N
439 public boolean isEmailAddressRegistered (final User user) {
441 this.getLoggerBeanLocal().logTrace(MessageFormat.format("isEmailAddressRegistered: user={0} - CALLED!", user)); //NOI18N
443 // user should not be null
446 throw new NullPointerException("user is null"); //NOI18N
450 Query query = this.getEntityManager().createNamedQuery("SearchUserByEmailAddress", User.class); //NOI18N
453 query.setParameter("param", user.getUserContact().getContactEmailAddress()); //NOI18N
457 User dummy = (User) query.getSingleResult();
460 this.getLoggerBeanLocal().logDebug(MessageFormat.format("isEmailAddressRegistered: dummy.id={0} found.", dummy.getUserId())); //NOI18N
461 } catch (final NoResultException ex) {
463 this.getLoggerBeanLocal().logDebug(MessageFormat.format("isEmailAddressRegistered: getSingleResult() returned no result: {0}", ex)); //NOI18N
465 // Email address does not exist
467 } catch (final PersistenceException ex) {
468 // Something bad happened
469 this.getLoggerBeanLocal().logWarning(MessageFormat.format("More than one email address {0} found.", user.getUserContact().getContactEmailAddress()), ex); //NOI18N
480 public boolean isUserNameRegistered (final User user) {
482 this.getLoggerBeanLocal().logTrace(MessageFormat.format("isUserNameRegistered: user={0} - CALLED!", user)); //NOI18N
484 // user should not be null
487 throw new NullPointerException("user is null"); //NOI18N
491 Query query = this.getEntityManager().createNamedQuery("SearchUserByName", User.class); //NOI18N
494 query.setParameter("param", user.getUserName()); //NOI18N
498 User dummy = (User) query.getSingleResult();
501 this.getLoggerBeanLocal().logDebug(MessageFormat.format("isUserNameRegistered: dummy.id={0} found.", dummy.getUserId())); //NOI18N
502 } catch (final NoResultException ex) {
504 this.getLoggerBeanLocal().logDebug(MessageFormat.format("isUserNameRegistered: getSingleResult() returned no result: {0}", ex)); //NOI18N
506 // User name does not exist
508 } catch (final PersistenceException ex) {
509 // Something bad happened
510 this.getLoggerBeanLocal().logWarning(MessageFormat.format("More than one email address {0} found.", user.getUserContact().getContactEmailAddress()), ex); //NOI18N
521 public User linkUser (final User user) throws UserNameAlreadyRegisteredException, EmailAddressAlreadyRegisteredException {
523 this.getLoggerBeanLocal().logTrace(MessageFormat.format("linkUser: user={0} - CALLED!", user)); //NOI18N
525 // user should not be null
526 // @TODO Add check for email address
529 throw new NullPointerException("user is null"); //NOI18N
530 } else if (user.getUserId() instanceof Long) {
532 throw new IllegalArgumentException("user.userId is not null"); //NOI18N
533 } else if (user.getUserContact() == null) {
535 throw new NullPointerException("user.userContact is null"); //NOI18N
536 } else if (user.getUserContact().getContactId() == null) {
538 throw new NullPointerException("user.userContact.contactId is null"); //NOI18N
539 } else if (user.getUserContact().getContactId() < 1) {
540 // Not valid id number
541 throw new IllegalArgumentException(MessageFormat.format("user.userContact.contactId={0} is not valid", user.getUserContact().getContactId())); //NOI18N
542 } else if (user.getUserAccountStatus() == null) {
544 throw new NullPointerException("user.userAccountStatus is null"); //NOI18N
545 } else if (this.ifUserNameExists(user.getUserName())) {
546 // Name already found
547 throw new UserNameAlreadyRegisteredException(user.getUserName());
548 } else if (this.ifUserExists(user)) {
549 // User does not exist
550 throw new IllegalStateException("User does already exist."); //NOI18N
553 // Try to find the contact
554 Contact foundContact = this.getEntityManager().find(user.getUserContact().getClass(), user.getUserContact().getContactId());
556 // Set detached object in rexcruiter instance
557 user.setUserContact(foundContact);
560 user.setUserCreated(new GregorianCalendar());
563 this.getEntityManager().persist(user);
565 // Flush it to get updated instance back
566 this.getEntityManager().flush();
569 this.getLoggerBeanLocal().logTrace(MessageFormat.format("linkUser: user={0} - EXIT!", user)); //NOI18N
571 // Return updated instanc
576 public User updateUserData (final User user) {
578 this.getLoggerBeanLocal().logTrace(MessageFormat.format("updateUserData: user={0} - CALLED!", user)); //NOI18N
580 // user should not be null
583 throw new NullPointerException("user is null"); //NOI18N
584 } else if (user.getUserId() == null) {
586 throw new NullPointerException("user.userId is null"); //NOI18N
587 } else if (user.getUserId() < 1) {
589 throw new IllegalArgumentException(MessageFormat.format("user.userId={0} is not valid.", user.getUserId())); //NOI18N
590 } else if (user.getUserAccountStatus() == null) {
592 throw new NullPointerException("user.userAccountStatus is null"); //NOI18N
593 } else if (!this.ifUserExists(user)) {
594 // User does not exist
595 throw new EJBException(MessageFormat.format("User with id {0} does not exist.", user.getUserId())); //NOI18N
598 // Remove contact instance as this is not updatedf
599 user.setUserContact(null);
602 User foundUser = this.getEntityManager().find(user.getClass(), user.getUserId());
605 assert (foundUser instanceof User) : MessageFormat.format("User with id {0} not found, but should be.", user.getUserId()); //NOI18N
608 User detachedUser = this.getEntityManager().merge(foundUser);
611 assert (detachedUser instanceof User) : MessageFormat.format("User with id {0} not merged, but should be.", user.getUserId()); //NOI18N
614 detachedUser.copyAll(user);
617 detachedUser.setUserUpdated(new GregorianCalendar());
619 // Return updated instance
624 public User updateUserPersonalData (final User user) {
626 this.getLoggerBeanLocal().logTrace(MessageFormat.format("updateUserPersonalData: user={0} - CALLED!", user)); //NOI18N
628 // user should not be null
631 throw new NullPointerException("user is null"); //NOI18N
632 } else if (user.getUserId() == null) {
634 throw new NullPointerException("user.userId is null"); //NOI18N
635 } else if (user.getUserId() < 1) {
637 throw new IllegalArgumentException(MessageFormat.format("user.userId={0} is not valid.", user.getUserId())); //NOI18N
638 } else if (user.getUserAccountStatus() == null) {
640 throw new NullPointerException("user.userAccountStatus is null"); //NOI18N
641 } else if (!this.ifUserExists(user)) {
642 // User does not exist
643 throw new EJBException(MessageFormat.format("User with id {0} does not exist.", user.getUserId())); //NOI18N
647 User foundUser = this.getEntityManager().find(user.getClass(), user.getUserId());
650 assert (foundUser instanceof User) : MessageFormat.format("User with id {0} not found, but should be.", user.getUserId()); //NOI18N
653 User detachedUser = this.getEntityManager().merge(foundUser);
656 assert (detachedUser instanceof User) : MessageFormat.format("User with id {0} not merged, but should be.", user.getUserId()); //NOI18N
659 detachedUser.copyAll(user);
662 detachedUser.setUserUpdated(new GregorianCalendar());
663 detachedUser.getUserContact().setContactUpdated(new GregorianCalendar());
665 // Get contact from it and find it
666 Contact foundContact = this.getEntityManager().find(user.getUserContact().getClass(), user.getUserContact().getContactId());
669 assert (foundContact instanceof Contact) : MessageFormat.format("Contact with id {0} not found, but should be.", user.getUserContact().getContactId()); //NOI18N
672 this.getLoggerBeanLocal().logDebug(MessageFormat.format("updateUserPersonalData: contact.contactId={0}", foundContact.getContactId())); //NOI18N
674 // Merge contact instance
675 Contact detachedContact = this.getEntityManager().merge(foundContact);
678 detachedContact.copyAll(user.getUserContact());
680 // Set it back in user
681 user.setUserContact(detachedContact);
684 assert (detachedContact instanceof Contact) : MessageFormat.format("Contact with id {0} not merged, but should be.", user.getUserContact().getContactId()); //NOI18N
686 // Get cellphone instance
687 DialableCellphoneNumber cellphone = detachedContact.getContactCellphoneNumber();
689 // Is there a cellphone instance set?
690 if (cellphone instanceof DialableCellphoneNumber) {
692 this.getLoggerBeanLocal().logDebug(MessageFormat.format("updateUserPersonalData: cellphone.phoneId={0} is being updated ...", cellphone.getPhoneId())); //NOI18N
695 DialableCellphoneNumber foundCellphone = this.getEntityManager().find(cellphone.getClass(), cellphone.getPhoneId());
698 assert (foundCellphone instanceof DialableCellphoneNumber) : MessageFormat.format("Cellphone number with id {0} not found but should be.", foundCellphone.getPhoneId()); //NOI18N
700 // Then merge it, too
701 DialableCellphoneNumber detachedCellphone = this.getEntityManager().merge(foundCellphone);
704 assert (detachedCellphone instanceof DialableCellphoneNumber) : MessageFormat.format("Cellphone number with id {0} not found but should be.", detachedCellphone.getPhoneId()); //NOI18N
707 detachedCellphone.copyAll(user.getUserContact().getContactCellphoneNumber());
710 detachedContact.setContactCellphoneNumber(detachedCellphone);
713 // Get cellphone instance
714 DialableFaxNumber fax = detachedContact.getContactFaxNumber();
716 // Is there a fax instance set?
717 if (fax instanceof DialableFaxNumber) {
719 this.getLoggerBeanLocal().logDebug(MessageFormat.format("updateUserPersonalData: fax.phoneId={0} is being updated ...", fax.getPhoneId())); //NOI18N
722 DialableFaxNumber foundFax = this.getEntityManager().find(fax.getClass(), fax.getPhoneId());
725 assert (foundFax instanceof DialableFaxNumber) : MessageFormat.format("Fax number with id {0} not found but should be.", foundFax.getPhoneId()); //NOI18N
727 // Then merge it, too
728 DialableFaxNumber detachedFax = this.getEntityManager().merge(foundFax);
731 assert (detachedFax instanceof DialableFaxNumber) : MessageFormat.format("Fax number with id {0} not found but should be.", detachedFax.getPhoneId()); //NOI18N
734 detachedFax.copyAll(user.getUserContact().getContactFaxNumber());
737 detachedContact.setContactFaxNumber(detachedFax);
740 // Get cellphone instance
741 DialableLandLineNumber landLine = detachedContact.getContactLandLineNumber();
743 // Is there a fax instance set?
744 if (landLine instanceof DialableLandLineNumber) {
746 this.getLoggerBeanLocal().logDebug(MessageFormat.format("updateUserPersonalData: landLine.phoneId={0} is being updated ...", landLine.getPhoneId())); //NOI18N
749 DialableLandLineNumber foundLandLine = this.getEntityManager().find(landLine.getClass(), landLine.getPhoneId());
752 assert (foundLandLine instanceof DialableLandLineNumber) : MessageFormat.format("Land line number with id {0} not found but should be.", foundLandLine.getPhoneId()); //NOI18N
754 // Then merge it, too
755 DialableLandLineNumber detachedLandLine = this.getEntityManager().merge(foundLandLine);
758 assert (detachedLandLine instanceof DialableLandLineNumber) : MessageFormat.format("Land line number with id {0} not found but should be.", detachedLandLine.getPhoneId()); //NOI18N
761 detachedLandLine.copyAll(user.getUserContact().getContactLandLineNumber());
764 detachedContact.setContactLandLineNumber(detachedLandLine);
767 // Return updated user instance