src/java/org/mxchange/jusercore/model/user/JobsAdminUserSessionBean.java

   1 /*
   2  * Copyright (C) 2016 Roland Haeder
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17 package org.mxchange.jusercore.model.user;
  18
  19 import java.text.MessageFormat;
  20 import java.util.GregorianCalendar;
  21 import javax.ejb.EJB;
  22 import javax.ejb.EJBException;
  23 import javax.ejb.Stateless;
  24 import javax.mail.Address;
  25 import javax.mail.internet.AddressException;
  26 import javax.mail.internet.InternetAddress;
  27 import org.mxchange.jcontacts.contact.Contact;
  28 import org.mxchange.jjobs.database.BaseJobsDatabaseBean;
  29 import org.mxchange.jusercore.exceptions.EmailAddressAlreadyRegisteredException;
  30 import org.mxchange.jusercore.exceptions.UserNameAlreadyRegisteredException;
  31 import org.mxchange.jusercore.exceptions.UserNotFoundException;
  32 import org.mxchange.jusercore.exceptions.UserStatusConfirmedException;
  33 import org.mxchange.jusercore.exceptions.UserStatusLockedException;
  34 import org.mxchange.jusercore.exceptions.UserStatusUnconfirmedException;
  35 import org.mxchange.jusercore.model.register.UserRegistrationSessionBeanRemote;
  36 import org.mxchange.jusercore.model.user.status.UserAccountStatus;
  37
  38 /**
  39  * An administrative user EJB
  40  * <p>
  41  * @author Roland Haeder<roland@mxchange.org>
  42  */
  43 @Stateless (name = "adminUser", description = "A bean handling the user data")
  44 public class JobsAdminUserSessionBean extends BaseJobsDatabaseBean implements AdminUserSessionBeanRemote {
  45
  46         /**
  47          * Serial number
  48          */
  49         private static final long serialVersionUID = 542_145_347_916L;
  50
  51         /**
  52          * Registration EJB
  53          */
  54         @EJB
  55         private UserRegistrationSessionBeanRemote registerBean;
  56
  57         /**
  58          * Regular user bean
  59          */
  60         @EJB
  61         private UserSessionBeanRemote userBean;
  62
  63         /**
  64          * Default constructor
  65          */
  66         public JobsAdminUserSessionBean () {
  67         }
  68
  69         @Override
  70         public User addUser (final User user) throws UserNameAlreadyRegisteredException, EmailAddressAlreadyRegisteredException {
  71                 // Trace message
  72                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.addUser: user={1} - CALLED!", this.getClass().getSimpleName(), user)); //NOI18N
  73
  74                 // user should not be null
  75                 if (null == user) {
  76                         // Abort here
  77                         throw new NullPointerException("user is null"); //NOI18N
  78                 } else if (user.getUserId() != null) {
  79                         // Not allowed here
  80                         throw new IllegalStateException(MessageFormat.format("user.userId must be null, is: {0}", user.getUserId())); //NOI18N
  81                 }
  82
  83                 // Check if user is registered
  84                 if (this.registerBean.isUserNameRegistered(user)) {
  85                         // Abort here
  86                         throw new UserNameAlreadyRegisteredException(user);
  87                 } else if (this.registerBean.isEmailAddressRegistered(user)) {
  88                         // Abort here
  89                         throw new EmailAddressAlreadyRegisteredException(user);
  90                 }
  91
  92                 // Set created timestamp
  93                 user.setUserCreated(new GregorianCalendar());
  94                 user.getUserContact().setContactCreated(new GregorianCalendar());
  95
  96                 // Update cellphone, land-line and fax instance
  97                 this.setAllContactPhoneEntriesCreated(user.getUserContact());
  98
  99                 // Persist it
 100                 this.getEntityManager().persist(user);
 101
 102                 // Flush to get id back
 103                 this.getEntityManager().flush();
 104
 105                 // Trace message
 106                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.addUser: user={1},user.userId={2} - EXIT!", this.getClass().getSimpleName(), user, user.getUserId())); //NOI18N
 107
 108                 // Return it
 109                 return user;
 110         }
 111
 112         @Override
 113         public User linkUser (final User user) throws UserNameAlreadyRegisteredException, EmailAddressAlreadyRegisteredException {
 114                 // Trace message
 115                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.linkUser: user={0} - CALLED!", this.getClass().getSimpleName(), user)); //NOI18N
 116
 117                 // user should not be null
 118                 if (null == user) {
 119                         // Abort here
 120                         throw new NullPointerException("user is null"); //NOI18N
 121                 } else if (user.getUserId() instanceof Long) {
 122                         // Id is set
 123                         throw new IllegalArgumentException("user.userId is not null"); //NOI18N
 124                 } else if (user.getUserContact() == null) {
 125                         // Throw NPE again
 126                         throw new NullPointerException("user.userContact is null"); //NOI18N
 127                 } else if (user.getUserContact().getContactId() == null) {
 128                         // Throw NPE again
 129                         throw new NullPointerException("user.userContact.contactId is null"); //NOI18N
 130                 } else if (user.getUserContact().getContactId() < 1) {
 131                         // Not valid id number
 132                         throw new IllegalArgumentException(MessageFormat.format("user.userContact.contactId={0} is not valid", user.getUserContact().getContactId())); //NOI18N
 133                 } else if (user.getUserAccountStatus() == null) {
 134                         // Throw NPE again
 135                         throw new NullPointerException("user.userAccountStatus is null"); //NOI18N
 136                 } else if (this.userBean.ifUserNameExists(user.getUserName())) {
 137                         // Name already found
 138                         throw new UserNameAlreadyRegisteredException(user.getUserName());
 139                 }
 140
 141                 // Try to find the contact
 142                 Contact foundContact = this.getEntityManager().find(user.getUserContact().getClass(), user.getUserContact().getContactId());
 143
 144                 // Set detached object in rexcruiter instance
 145                 user.setUserContact(foundContact);
 146
 147                 // Set timestamp
 148                 user.setUserCreated(new GregorianCalendar());
 149
 150                 // Perist it
 151                 this.getEntityManager().persist(user);
 152
 153                 // Flush it to get updated instance back
 154                 this.getEntityManager().flush();
 155
 156                 // Log trace message
 157                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.linkUser: user={1} - EXIT!", this.getClass().getSimpleName(), user)); //NOI18N
 158
 159                 // Return updated instanc
 160                 return user;
 161         }
 162
 163         @Override
 164         public User lockUserAccount (final User user, final String userLockReason, final String baseUrl) throws UserStatusLockedException, UserStatusUnconfirmedException, UserNotFoundException {
 165                 // Trace message
 166                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.lockUserAccount: user={1},userLockReason={2},baseUrl={3} - CALLED!", this.getClass().getSimpleName(), user, userLockReason, baseUrl)); //NOI18N
 167
 168                 // user should not be null
 169                 if (null == user) {
 170                         // Abort here
 171                         throw new NullPointerException("user is null"); //NOI18N
 172                 } else if (user.getUserId() == null) {
 173                         // Id is set
 174                         throw new NullPointerException("user.userId is null"); //NOI18N
 175                 } else if (user.getUserId() < 1) {
 176                         // Id is set
 177                         throw new IllegalArgumentException(MessageFormat.format("user.userId={0} is null", user.getUserId())); //NOI18N
 178                 } else if (user.getUserContact() == null) {
 179                         // Throw NPE again
 180                         throw new NullPointerException("user.userContact is null"); //NOI18N
 181                 } else if (user.getUserContact().getContactId() == null) {
 182                         // Throw NPE again
 183                         throw new NullPointerException("user.userContact.contactId is null"); //NOI18N
 184                 } else if (user.getUserContact().getContactId() < 1) {
 185                         // Not valid id number
 186                         throw new IllegalArgumentException(MessageFormat.format("user.userContact.contactId={0} is not valid", user.getUserContact().getContactId())); //NOI18N
 187                 } else if (user.getUserAccountStatus() == null) {
 188                         // Throw NPE again
 189                         throw new NullPointerException("user.userAccountStatus is null"); //NOI18N
 190                 } else if (!this.userBean.ifUserExists(user)) {
 191                         // Name already found
 192                         throw new UserNotFoundException(user);
 193                 } else if (user.getUserAccountStatus() == UserAccountStatus.LOCKED) {
 194                         // Account is locked
 195                         throw new UserStatusLockedException(user);
 196                 } else if (user.getUserAccountStatus() == UserAccountStatus.UNCONFIRMED) {
 197                         // Account is unconfirmed
 198                         throw new UserStatusUnconfirmedException(user);
 199                 } else if (null == userLockReason) {
 200                         // Throw NPE again
 201                         throw new NullPointerException("userLockReason is null"); //NOI18N
 202                 } else if (userLockReason.isEmpty()) {
 203                         // Is empty
 204                         throw new IllegalArgumentException("userLockReason is empty"); //NOI18N
 205                 }
 206
 207                 // Remove contact instance as this is not updated
 208                 user.setUserContact(null);
 209
 210                 // Set as locked, set timestamp and lock reason
 211                 user.setUserAccountStatus(UserAccountStatus.LOCKED);
 212                 user.setUserLastLocked(new GregorianCalendar());
 213                 user.setUserLastLockedReason(userLockReason);
 214
 215                 // Update user
 216                 User updatedUser = this.userBean.updateUserData(user);
 217
 218                 // @TODO Create user lock history entry
 219                 // Init variable
 220                 Address emailAddress;
 221
 222                 try {
 223                         // Create email address and set
 224                         emailAddress = new InternetAddress(updatedUser.getUserContact().getContactEmailAddress());
 225                 } catch (final AddressException ex) {
 226                         // Throw again
 227                         throw new EJBException(ex);
 228                 }
 229
 230                 // Send out email
 231                 // @TODO externalize subject line
 232                 this.sendEmail("Account locked", "account_locked", emailAddress, updatedUser, baseUrl); //NOI18N
 233
 234                 // Trace message
 235                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.lockUserAccount: updatedUser={1} - EXIT!", this.getClass().getSimpleName(), updatedUser)); //NOI18N
 236
 237                 // Return detached (and updated) user
 238                 return updatedUser;
 239         }
 240
 241         @Override
 242         public User unlockUserAccount (final User user, final String baseUrl) throws UserStatusConfirmedException, UserStatusUnconfirmedException, UserNotFoundException {
 243                 // Trace message
 244                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.lockUserAccount: user={1},baseUrl={2} - CALLED!", this.getClass().getSimpleName(), user, baseUrl)); //NOI18N
 245
 246                 // user should not be null
 247                 if (null == user) {
 248                         // Abort here
 249                         throw new NullPointerException("user is null"); //NOI18N
 250                 } else if (user.getUserId() == null) {
 251                         // Id is set
 252                         throw new NullPointerException("user.userId is null"); //NOI18N
 253                 } else if (user.getUserId() < 1) {
 254                         // Id is set
 255                         throw new IllegalArgumentException(MessageFormat.format("user.userId={0} is null", user.getUserId())); //NOI18N
 256                 } else if (user.getUserContact() == null) {
 257                         // Throw NPE again
 258                         throw new NullPointerException("user.userContact is null"); //NOI18N
 259                 } else if (user.getUserContact().getContactId() == null) {
 260                         // Throw NPE again
 261                         throw new NullPointerException("user.userContact.contactId is null"); //NOI18N
 262                 } else if (user.getUserContact().getContactId() < 1) {
 263                         // Not valid id number
 264                         throw new IllegalArgumentException(MessageFormat.format("user.userContact.contactId={0} is not valid", user.getUserContact().getContactId())); //NOI18N
 265                 } else if (user.getUserAccountStatus() == null) {
 266                         // Throw NPE again
 267                         throw new NullPointerException("user.userAccountStatus is null"); //NOI18N
 268                 } else if (!this.userBean.ifUserExists(user)) {
 269                         // Name already found
 270                         throw new UserNotFoundException(user);
 271                 } else if (user.getUserAccountStatus() == UserAccountStatus.CONFIRMED) {
 272                         // Account is confirmed
 273                         throw new UserStatusConfirmedException(user);
 274                 } else if (user.getUserAccountStatus() == UserAccountStatus.UNCONFIRMED) {
 275                         // Account is unconfirmed
 276                         throw new UserStatusUnconfirmedException(user);
 277                 }
 278
 279                 // Remove contact instance as this is not updated
 280                 user.setUserContact(null);
 281
 282                 // Unlock account
 283                 user.setUserAccountStatus(UserAccountStatus.CONFIRMED);
 284
 285                 // Update user
 286                 User updatedUser = this.userBean.updateUserData(user);
 287
 288                 // @TODO Create user lock history entry
 289                 // Init variable
 290                 Address emailAddress;
 291
 292                 try {
 293                         // Create email address and set
 294                         emailAddress = new InternetAddress(updatedUser.getUserContact().getContactEmailAddress());
 295                 } catch (final AddressException ex) {
 296                         // Throw again
 297                         throw new EJBException(ex);
 298                 }
 299
 300                 // Send out email
 301                 // @TODO externalize subject line
 302                 this.sendEmail("Account unlocked", "account_unlocked", emailAddress, updatedUser, baseUrl); //NOI18N
 303
 304                 // Trace message
 305                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.lockUserAccount: updatedUser={1} - EXIT!", this.getClass().getSimpleName(), updatedUser)); //NOI18N
 306
 307                 // Return changed account
 308                 return updatedUser;
 309         }
 310
 311 }