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.addressbook.database.BaseAddressbookDatabaseBean;
29 import org.mxchange.jcontacts.contact.Contact;
30 import org.mxchange.jphone.phonenumbers.cellphone.DialableCellphoneNumber;
31 import org.mxchange.jphone.phonenumbers.fax.DialableFaxNumber;
32 import org.mxchange.jphone.phonenumbers.landline.DialableLandLineNumber;
33 import org.mxchange.jusercore.exceptions.EmailAddressAlreadyRegisteredException;
34 import org.mxchange.jusercore.exceptions.UserNameAlreadyRegisteredException;
35 import org.mxchange.jusercore.exceptions.UserNotFoundException;
36 import org.mxchange.jusercore.model.register.UserRegistrationSessionBeanRemote;
37 import org.mxchange.jusercore.model.user.profilemodes.ProfileMode;
38 import org.mxchange.jusercore.model.user.status.UserAccountStatus;
43 * @author Roland Haeder<roland@mxchange.org>
45 @Stateless (name = "user", description = "A bean handling the user data")
46 public class AddressbookUserSessionBean extends BaseAddressbookDatabaseBean implements UserSessionBeanRemote {
51 private static final long serialVersionUID = 542_145_347_916L;
57 private UserRegistrationSessionBeanRemote registerBean;
62 public AddressbookUserSessionBean () {
66 public User addUser (final User user) throws UserNameAlreadyRegisteredException, EmailAddressAlreadyRegisteredException {
68 this.getLoggerBeanLocal().logTrace(MessageFormat.format("addUser: user={0} - CALLED!", user)); //NOI18N
70 // user should not be null
73 throw new NullPointerException("user is null"); //NOI18N
74 } else if (user.getUserId() != null) {
76 throw new IllegalStateException(MessageFormat.format("user.userId must be null, is: {0}", user.getUserId())); //NOI18N
79 // Check if user is registered
80 if (this.registerBean.isUserNameRegistered(user)) {
82 throw new UserNameAlreadyRegisteredException(user);
83 } else if (this.registerBean.isEmailAddressRegistered(user)) {
85 throw new EmailAddressAlreadyRegisteredException(user);
88 // Set created timestamp
89 user.setUserCreated(new GregorianCalendar());
90 user.getUserContact().setContactCreated(new GregorianCalendar());
92 // Update cellphone, land-line and fax instance
93 this.setAllContactPhoneEntriesCreated(user.getUserContact());
96 this.getEntityManager().persist(user);
98 // Flush to get id back
99 this.getEntityManager().flush();
102 this.getLoggerBeanLocal().logTrace(MessageFormat.format("addUser: user={0},user.id={1} - EXIT!", user, user.getUserId())); //NOI18N
109 @SuppressWarnings ("unchecked")
110 public List<User> allMemberPublicVisibleUsers () {
112 this.getLoggerBeanLocal().logTrace("allMemberPublicVisibleUsers: CALLED!"); //NOI18N
115 Query query = this.getEntityManager().createNamedQuery("AllMemberPublicUsers", List.class); //NOI18N
118 query.setParameter("status", UserAccountStatus.CONFIRMED); //NOI18N
119 query.setParameter("members", ProfileMode.MEMBERS); //NOI18N
120 query.setParameter("public", ProfileMode.PUBLIC); //NOI18N
123 List<User> users = query.getResultList();
126 this.getLoggerBeanLocal().logTrace(MessageFormat.format("allMemberPublicVisibleUsers: users.size()={0} - EXIT!", users.size())); //NOI18N
133 @SuppressWarnings ("unchecked")
134 public List<User> allPublicUsers () {
136 this.getLoggerBeanLocal().logTrace("allPublicUsers: CALLED!"); //NOI18N
139 Query query = this.getEntityManager().createNamedQuery("AllPublicUsers", List.class); //NOI18N
142 query.setParameter("status", UserAccountStatus.CONFIRMED); //NOI18N
143 query.setParameter("mode", ProfileMode.PUBLIC); //NOI18N
146 List<User> users = query.getResultList();
149 this.getLoggerBeanLocal().logTrace(MessageFormat.format("allPublicUsers: users.size()={0} - EXIT!", users.size())); //NOI18N
156 @SuppressWarnings ("unchecked")
157 public List<User> allUsers () {
159 this.getLoggerBeanLocal().logTrace("allUsers: CALLED!"); //NOI18N
162 Query query = this.getEntityManager().createNamedQuery("AllUsers", List.class); //NOI18N
165 List<User> users = query.getResultList();
168 this.getLoggerBeanLocal().logTrace(MessageFormat.format("allUsers: users.size()={0} - EXIT!", users.size())); //NOI18N
175 public User fillUserData (final User user) {
177 this.getLoggerBeanLocal().logTrace(MessageFormat.format("fillUserData: user={0} - CALLED!", user)); //NOI18N
179 // user should not be null
182 throw new NullPointerException("user is null"); //NOI18N
186 Query query = this.getEntityManager().createNamedQuery("SearchUserByName", User.class); //NOI18N
189 query.setParameter("param", user.getUserName()); //NOI18N
191 // Initialize variable
192 User foundUser = null;
196 // Try to get single result
197 foundUser = (User) query.getSingleResult();
198 } catch (final NoResultException ex) {
200 this.getLoggerBeanLocal().logException(ex);
204 this.getLoggerBeanLocal().logTrace(MessageFormat.format("fillUserData: foundUser={0} - EXIT!", foundUser)); //NOI18N
206 // Return prepared instance
211 public User findUserById (final Long userId) throws UserNotFoundException {
213 this.getLoggerBeanLocal().logTrace(MessageFormat.format("findUserById: userId={0} - CALLED!", userId)); //NOI18N
215 // Is the parameter valid?
216 if (null == userId) {
218 throw new NullPointerException("userId is null"); //NOI18N
219 } else if (userId < 1) {
221 throw new IllegalArgumentException(MessageFormat.format("userId={0} is not valid.", userId)); //NOI18N
222 } else if (!this.ifUserIdExists(userId)) {
224 throw new UserNotFoundException(userId);
227 // Create query instance
228 Query query = this.getEntityManager().createNamedQuery("SearchUserById", User.class); //NOI18N
231 query.setParameter("id", userId); //NOI18N
233 // Fetch the result, it should be there by now
234 User user = (User) query.getSingleResult();
237 assert (user instanceof User) : "user is null"; //NOI18N
240 this.getLoggerBeanLocal().logTrace(MessageFormat.format("findUserById: user={0} - EXIT!!", user)); //NOI18N
247 public String generateRandomUserName () {
249 this.getLoggerBeanLocal().logTrace("generateRandomUserName - CALLED!"); //NOI18N
252 List<String> userList = this.getUserNameList();
255 String userName = null;
257 // Loop until a user name is found
258 while ((userName == null) || (userList.contains(userName))) {
259 // Generate random name
260 userName = UserUtils.generateRandomUserName();
264 this.getLoggerBeanLocal().logTrace(MessageFormat.format("generateRandomUserName: userName={0} - EXIT!", userName)); //NOI18N
266 // Found one, so return it
271 @SuppressWarnings ("unchecked")
272 public List<String> getEmailAddressList () {
274 Query query = this.getEntityManager().createNamedQuery("AllEmailAddresses", String.class); //NOI18N
277 List<String> emailAddressList = query.getResultList();
280 return emailAddressList;
284 @SuppressWarnings ("unchecked")
285 public List<String> getUserNameList () {
287 Query query = this.getEntityManager().createNamedQuery("AllUserNames", String.class); //NOI18N
290 List<String> userNameList = query.getResultList();
297 public boolean ifUserExists (final User user) {
299 this.getLoggerBeanLocal().logTrace(MessageFormat.format("ifUserExists: user={0} - CALLED!", user)); //NOI18N
301 // userId should not be null
304 throw new NullPointerException("user is null"); //NOI18N
305 } else if (user.getUserId() == null) {
307 throw new NullPointerException("user.userId is null"); //NOI18N
308 } else if (user.getUserId() < 1) {
310 throw new IllegalArgumentException(MessageFormat.format("userId is not valid: {0}", user.getUserId())); //NOI18N
314 Query query = this.getEntityManager().createNamedQuery("SearchUserById", User.class); //NOI18N
317 query.setParameter("id", user.getUserId()); //NOI18N
321 User dummy = (User) query.getSingleResult();
324 this.getLoggerBeanLocal().logDebug(MessageFormat.format("ifUserExists: dummy.id={0} found.", dummy.getUserId())); //NOI18N
325 } catch (final NoResultException ex) {
327 this.getLoggerBeanLocal().logDebug(MessageFormat.format("ifUserExists: getSingleResult() returned no result: {0}", ex)); //NOI18N
329 // User name does not exist
331 } catch (final PersistenceException ex) {
332 // Something bad happened
333 this.getLoggerBeanLocal().logWarning(MessageFormat.format("More than one user {0} found.", user, ex)); //NOI18N
340 this.getLoggerBeanLocal().logTrace(MessageFormat.format("ifUserExists: Found user {0} - EXIT!", user)); //NOI18N
347 public boolean ifUserIdExists (final Long userId) {
349 this.getLoggerBeanLocal().logTrace(MessageFormat.format("ifUserIdExists: userId={0} - CALLED!", userId)); //NOI18N
351 // userId should not be null
352 if (null == userId) {
354 throw new NullPointerException("userId is null"); //NOI18N
355 } else if (userId < 1) {
357 throw new IllegalArgumentException(MessageFormat.format("userId is not valid: {0}", userId)); //NOI18N
361 Query query = this.getEntityManager().createNamedQuery("SearchUserById", User.class); //NOI18N
364 query.setParameter("id", userId); //NOI18N
368 User dummy = (User) query.getSingleResult();
371 this.getLoggerBeanLocal().logDebug(MessageFormat.format("ifUserIdExists: dummy.id={0} found.", dummy.getUserId())); //NOI18N
372 } catch (final NoResultException ex) {
374 this.getLoggerBeanLocal().logDebug(MessageFormat.format("ifUserIdExists: getSingleResult() returned no result: {0}", ex)); //NOI18N
376 // User name does not exist
378 } catch (final PersistenceException ex) {
379 // Something bad happened
380 this.getLoggerBeanLocal().logWarning(MessageFormat.format("More than one user id {0} found.", userId, ex)); //NOI18N
387 this.getLoggerBeanLocal().logTrace(MessageFormat.format("ifUserIdExists: Found user id {0} - EXIT!", userId)); //NOI18N
394 public boolean ifUserNameExists (final String userName) {
396 this.getLoggerBeanLocal().logTrace(MessageFormat.format("ifUserNameExists: userName={0} - CALLED!", userName)); //NOI18N
398 // userId should not be null
399 if (null == userName) {
401 throw new NullPointerException("userName is null"); //NOI18N
402 } else if (userName.isEmpty()) {
404 throw new NullPointerException("userName is empty"); //NOI18N
408 Query query = this.getEntityManager().createNamedQuery("SearchUserByName", User.class); //NOI18N
411 query.setParameter("param", userName); //NOI18N
415 User dummy = (User) query.getSingleResult();
418 this.getLoggerBeanLocal().logDebug(MessageFormat.format("ifUserNameExists: dummy.id={0} found.", dummy.getUserId())); //NOI18N
419 } catch (final NoResultException ex) {
421 this.getLoggerBeanLocal().logDebug(MessageFormat.format("ifUserNameExists: getSingleResult() returned no result: {0}", ex)); //NOI18N
423 // User name does not exist
428 this.getLoggerBeanLocal().logTrace(MessageFormat.format("ifUserNameExists: Found user name {0} - EXIT!", userName)); //NOI18N
435 public boolean isEmailAddressRegistered (final User user) {
437 this.getLoggerBeanLocal().logTrace(MessageFormat.format("isEmailAddressRegistered: user={0} - CALLED!", user)); //NOI18N
439 // user should not be null
442 throw new NullPointerException("user is null"); //NOI18N
446 Query query = this.getEntityManager().createNamedQuery("SearchUserByEmailAddress", User.class); //NOI18N
449 query.setParameter("param", user.getUserContact().getContactEmailAddress()); //NOI18N
453 User dummy = (User) query.getSingleResult();
456 this.getLoggerBeanLocal().logDebug(MessageFormat.format("isEmailAddressRegistered: dummy.id={0} found.", dummy.getUserId())); //NOI18N
457 } catch (final NoResultException ex) {
459 this.getLoggerBeanLocal().logDebug(MessageFormat.format("isEmailAddressRegistered: getSingleResult() returned no result: {0}", ex)); //NOI18N
461 // Email address does not exist
463 } catch (final PersistenceException ex) {
464 // Something bad happened
465 this.getLoggerBeanLocal().logWarning(MessageFormat.format("More than one email address {0} found.", user.getUserContact().getContactEmailAddress()), ex); //NOI18N
476 public boolean isUserNameRegistered (final User user) {
478 this.getLoggerBeanLocal().logTrace(MessageFormat.format("isUserNameRegistered: user={0} - CALLED!", user)); //NOI18N
480 // user should not be null
483 throw new NullPointerException("user is null"); //NOI18N
487 Query query = this.getEntityManager().createNamedQuery("SearchUserByName", User.class); //NOI18N
490 query.setParameter("param", user.getUserName()); //NOI18N
494 User dummy = (User) query.getSingleResult();
497 this.getLoggerBeanLocal().logDebug(MessageFormat.format("isUserNameRegistered: dummy.id={0} found.", dummy.getUserId())); //NOI18N
498 } catch (final NoResultException ex) {
500 this.getLoggerBeanLocal().logDebug(MessageFormat.format("isUserNameRegistered: getSingleResult() returned no result: {0}", ex)); //NOI18N
502 // User name does not exist
504 } catch (final PersistenceException ex) {
505 // Something bad happened
506 this.getLoggerBeanLocal().logWarning(MessageFormat.format("More than one email address {0} found.", user.getUserContact().getContactEmailAddress()), ex); //NOI18N
517 public User linkUser (final User user) throws UserNameAlreadyRegisteredException, EmailAddressAlreadyRegisteredException {
519 this.getLoggerBeanLocal().logTrace(MessageFormat.format("linkUser: user={0} - CALLED!", user)); //NOI18N
521 // user should not be null
522 // @TODO Add check for email address
525 throw new NullPointerException("user is null"); //NOI18N
526 } else if (user.getUserId() instanceof Long) {
528 throw new IllegalArgumentException("user.userId is not null"); //NOI18N
529 } else if (user.getUserContact() == null) {
531 throw new NullPointerException("user.userContact is null"); //NOI18N
532 } else if (user.getUserContact().getContactId() == null) {
534 throw new NullPointerException("user.userContact.contactId is null"); //NOI18N
535 } else if (user.getUserContact().getContactId() < 1) {
536 // Not valid id number
537 throw new IllegalArgumentException(MessageFormat.format("user.userContact.contactId={0} is not valid", user.getUserContact().getContactId())); //NOI18N
538 } else if (user.getUserAccountStatus() == null) {
540 throw new NullPointerException("user.userAccountStatus is null"); //NOI18N
541 } else if (this.ifUserNameExists(user.getUserName())) {
542 // Name already found
543 throw new UserNameAlreadyRegisteredException(user.getUserName());
544 } else if (this.ifUserExists(user)) {
545 // User does not exist
546 throw new IllegalStateException("User does already exist."); //NOI18N
549 // Try to find the contact
550 Contact foundContact = this.getEntityManager().find(user.getUserContact().getClass(), user.getUserContact().getContactId());
552 // Merge the contact to get a detached object back
553 Contact detachedContact = this.getEntityManager().merge(foundContact);
555 // Set detached object in rexcruiter instance
556 user.setUserContact(detachedContact);
559 user.setUserCreated(new GregorianCalendar());
562 this.getEntityManager().persist(user);
564 // Flush it to get updated instance back
565 this.getEntityManager().flush();
568 this.getLoggerBeanLocal().logTrace(MessageFormat.format("linkUser: user={0} - EXIT!", user)); //NOI18N
570 // Return updated instanc
575 public User updateUserData (final User user) {
577 this.getLoggerBeanLocal().logTrace(MessageFormat.format("updateUserData: user={0} - CALLED!", user)); //NOI18N
579 // user should not be null
582 throw new NullPointerException("user is null"); //NOI18N
583 } else if (user.getUserId() == null) {
585 throw new NullPointerException("user.userId is null"); //NOI18N
586 } else if (user.getUserId() < 1) {
588 throw new IllegalArgumentException(MessageFormat.format("user.userId={0} is not valid.", user.getUserId())); //NOI18N
589 } else if (user.getUserAccountStatus() == null) {
591 throw new NullPointerException("user.userAccountStatus is null"); //NOI18N
592 } else if (!this.ifUserExists(user)) {
593 // User does not exist
594 throw new EJBException(MessageFormat.format("User with id {0} does not exist.", user.getUserId())); //NOI18N
597 // Remove contact instance as this is not updatedf
598 user.setUserContact(null);
601 User foundUser = this.getEntityManager().find(user.getClass(), user.getUserId());
604 assert (foundUser instanceof User) : MessageFormat.format("User with id {0} not found, but should be.", user.getUserId()); //NOI18N
607 User detachedUser = this.getEntityManager().merge(foundUser);
610 assert (detachedUser instanceof User) : MessageFormat.format("User with id {0} not merged, but should be.", user.getUserId()); //NOI18N
613 detachedUser.copyAll(user);
616 detachedUser.setUserUpdated(new GregorianCalendar());
618 // Return updated instance
623 public User updateUserPersonalData (final User user) {
625 this.getLoggerBeanLocal().logTrace(MessageFormat.format("updateUserPersonalData: user={0} - CALLED!", user)); //NOI18N
627 // user should not be null
630 throw new NullPointerException("user is null"); //NOI18N
631 } else if (user.getUserId() == null) {
633 throw new NullPointerException("user.userId is null"); //NOI18N
634 } else if (user.getUserId() < 1) {
636 throw new IllegalArgumentException(MessageFormat.format("user.userId={0} is not valid.", user.getUserId())); //NOI18N
637 } else if (user.getUserAccountStatus() == null) {
639 throw new NullPointerException("user.userAccountStatus is null"); //NOI18N
640 } else if (!this.ifUserExists(user)) {
641 // User does not exist
642 throw new EJBException(MessageFormat.format("User with id {0} does not exist.", user.getUserId())); //NOI18N
646 User foundUser = this.getEntityManager().find(user.getClass(), user.getUserId());
649 assert (foundUser instanceof User) : MessageFormat.format("User with id {0} not found, but should be.", user.getUserId()); //NOI18N
652 User detachedUser = this.getEntityManager().merge(foundUser);
655 assert (detachedUser instanceof User) : MessageFormat.format("User with id {0} not merged, but should be.", user.getUserId()); //NOI18N
658 detachedUser.copyAll(user);
661 detachedUser.setUserUpdated(new GregorianCalendar());
662 detachedUser.getUserContact().setContactUpdated(new GregorianCalendar());
664 // Get contact from it and find it
665 Contact foundContact = this.getEntityManager().find(user.getUserContact().getClass(), user.getUserContact().getContactId());
668 assert (foundContact instanceof Contact) : MessageFormat.format("Contact with id {0} not found, but should be.", user.getUserContact().getContactId()); //NOI18N
671 this.getLoggerBeanLocal().logDebug(MessageFormat.format("updateUserPersonalData: contact.contactId={0}", foundContact.getContactId())); //NOI18N
673 // Merge contact instance
674 Contact detachedContact = this.getEntityManager().merge(foundContact);
677 detachedContact.copyAll(user.getUserContact());
679 // Set it back in user
680 user.setUserContact(detachedContact);
683 assert (detachedContact instanceof Contact) : MessageFormat.format("Contact with id {0} not merged, but should be.", user.getUserContact().getContactId()); //NOI18N
685 // Get cellphone instance
686 DialableCellphoneNumber cellphone = detachedContact.getContactCellphoneNumber();
688 // Is there a cellphone instance set?
689 if (cellphone instanceof DialableCellphoneNumber) {
691 this.getLoggerBeanLocal().logDebug(MessageFormat.format("updateUserPersonalData: cellphone.phoneId={0} is being updated ...", cellphone.getPhoneId())); //NOI18N
694 DialableCellphoneNumber foundCellphone = this.getEntityManager().find(cellphone.getClass(), cellphone.getPhoneId());
697 assert (foundCellphone instanceof DialableCellphoneNumber) : MessageFormat.format("Cellphone number with id {0} not found but should be.", foundCellphone.getPhoneId()); //NOI18N
699 // Then merge it, too
700 DialableCellphoneNumber detachedCellphone = this.getEntityManager().merge(foundCellphone);
703 assert (detachedCellphone instanceof DialableCellphoneNumber) : MessageFormat.format("Cellphone number with id {0} not found but should be.", detachedCellphone.getPhoneId()); //NOI18N
706 detachedCellphone.copyAll(user.getUserContact().getContactCellphoneNumber());
709 detachedContact.setContactCellphoneNumber(detachedCellphone);
712 // Get cellphone instance
713 DialableFaxNumber fax = detachedContact.getContactFaxNumber();
715 // Is there a fax instance set?
716 if (fax instanceof DialableFaxNumber) {
718 this.getLoggerBeanLocal().logDebug(MessageFormat.format("updateUserPersonalData: fax.phoneId={0} is being updated ...", fax.getPhoneId())); //NOI18N
721 DialableFaxNumber foundFax = this.getEntityManager().find(fax.getClass(), fax.getPhoneId());
724 assert (foundFax instanceof DialableFaxNumber) : MessageFormat.format("Fax number with id {0} not found but should be.", foundFax.getPhoneId()); //NOI18N
726 // Then merge it, too
727 DialableFaxNumber detachedFax = this.getEntityManager().merge(foundFax);
730 assert (detachedFax instanceof DialableFaxNumber) : MessageFormat.format("Fax number with id {0} not found but should be.", detachedFax.getPhoneId()); //NOI18N
733 detachedFax.copyAll(user.getUserContact().getContactFaxNumber());
736 detachedContact.setContactFaxNumber(detachedFax);
739 // Get cellphone instance
740 DialableLandLineNumber landLine = detachedContact.getContactLandLineNumber();
742 // Is there a fax instance set?
743 if (landLine instanceof DialableLandLineNumber) {
745 this.getLoggerBeanLocal().logDebug(MessageFormat.format("updateUserPersonalData: landLine.phoneId={0} is being updated ...", landLine.getPhoneId())); //NOI18N
748 DialableLandLineNumber foundLandLine = this.getEntityManager().find(landLine.getClass(), landLine.getPhoneId());
751 assert (foundLandLine instanceof DialableLandLineNumber) : MessageFormat.format("Land line number with id {0} not found but should be.", foundLandLine.getPhoneId()); //NOI18N
753 // Then merge it, too
754 DialableLandLineNumber detachedLandLine = this.getEntityManager().merge(foundLandLine);
757 assert (detachedLandLine instanceof DialableLandLineNumber) : MessageFormat.format("Land line number with id {0} not found but should be.", detachedLandLine.getPhoneId()); //NOI18N
760 detachedLandLine.copyAll(user.getUserContact().getContactLandLineNumber());
763 detachedContact.setContactLandLineNumber(detachedLandLine);
766 // Return updated user instance