2 * Copyright (C) 2016 Roland Häder
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;
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.addressbook.database.BaseAddressbookDatabaseBean;
28 import org.mxchange.jcontacts.contact.Contact;
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;
39 * An administrative user EJB
41 * @author Roland Häder<roland@mxchange.org>
43 @Stateless (name = "adminUser", description = "A bean handling the user data")
44 public class AddressbookAdminUserSessionBean extends BaseAddressbookDatabaseBean implements AdminUserSessionBeanRemote {
49 private static final long serialVersionUID = 542_145_347_916L;
55 private UserRegistrationSessionBeanRemote registerBean;
61 private UserSessionBeanRemote userBean;
66 public AddressbookAdminUserSessionBean () {
70 public User addUser (final User user) throws UserNameAlreadyRegisteredException, EmailAddressAlreadyRegisteredException {
72 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.addUser: user={1} - CALLED!", this.getClass().getSimpleName(), user)); //NOI18N
74 // user should not be null
77 throw new NullPointerException("user is null"); //NOI18N
78 } else if (user.getUserId() != null) {
80 throw new IllegalStateException(MessageFormat.format("user.userId must be null, is: {0}", user.getUserId())); //NOI18N
83 // Check if user is registered
84 if (this.registerBean.isUserNameRegistered(user)) {
86 throw new UserNameAlreadyRegisteredException(user);
87 } else if (this.registerBean.isEmailAddressRegistered(user)) {
89 throw new EmailAddressAlreadyRegisteredException(user);
92 // Set created timestamp
93 user.setUserCreated(new GregorianCalendar());
94 user.getUserContact().setContactCreated(new GregorianCalendar());
96 // Update cellphone, land-line and fax instance
97 this.setAllContactPhoneEntriesCreated(user.getUserContact());
100 this.getEntityManager().persist(user);
102 // Flush to get id back
103 this.getEntityManager().flush();
106 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.addUser: user={1},user.userId={2} - EXIT!", this.getClass().getSimpleName(), user, user.getUserId())); //NOI18N
113 public void deleteUser (final User user, final String userDeleteReason) throws UserNotFoundException {
115 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.deleteUser: user={1} - CALLED!", this.getClass().getSimpleName(), user)); //NOI18N
117 // user should not be null
120 throw new NullPointerException("user is null"); //NOI18N
121 } else if (user.getUserId() == null) {
123 throw new NullPointerException("user.userId is null"); //NOI18N
124 } else if (user.getUserId() < 1) {
125 // Not valid id number
126 throw new IllegalArgumentException(MessageFormat.format("user.userId={0} is not valid", user.getUserId())); //NOI18N
127 } else if (user.getUserContact() == null) {
129 throw new NullPointerException("user.userContact is null"); //NOI18N
130 } else if (user.getUserContact().getContactId() == null) {
132 throw new NullPointerException("user.userContact.contactId is null"); //NOI18N
133 } else if (user.getUserContact().getContactId() < 1) {
134 // Not valid id number
135 throw new IllegalArgumentException(MessageFormat.format("user.userContact.contactId={0} is not valid", user.getUserContact().getContactId())); //NOI18N
136 } else if (user.getUserAccountStatus() == null) {
138 throw new NullPointerException("user.userAccountStatus is null"); //NOI18N
139 } else if (!this.userBean.ifUserExists(user)) {
140 // Name already found
141 throw new UserNotFoundException(user);
144 // Get a managed instance
145 User managedUser = this.getManagedUser(user);
148 assert (managedUser instanceof User) : MessageFormat.format("User with id {0} not found, but should be.", user.getUserId()); //NOI18N
151 this.getEntityManager().remove(managedUser);
154 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.deleteUser: EXIT!", this.getClass().getSimpleName())); //NOI18N
158 public User linkUser (final User user) throws UserNameAlreadyRegisteredException, EmailAddressAlreadyRegisteredException {
160 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.linkUser: user={0} - CALLED!", this.getClass().getSimpleName(), user)); //NOI18N
162 // user should not be null
165 throw new NullPointerException("user is null"); //NOI18N
166 } else if (user.getUserId() instanceof Long) {
168 throw new IllegalArgumentException("user.userId is not null"); //NOI18N
169 } else if (user.getUserContact() == null) {
171 throw new NullPointerException("user.userContact is null"); //NOI18N
172 } else if (user.getUserContact().getContactId() == null) {
174 throw new NullPointerException("user.userContact.contactId is null"); //NOI18N
175 } else if (user.getUserContact().getContactId() < 1) {
176 // Not valid id number
177 throw new IllegalArgumentException(MessageFormat.format("user.userContact.contactId={0} is not valid", user.getUserContact().getContactId())); //NOI18N
178 } else if (user.getUserAccountStatus() == null) {
180 throw new NullPointerException("user.userAccountStatus is null"); //NOI18N
181 } else if (this.userBean.ifUserNameExists(user.getUserName())) {
182 // Name already found
183 throw new UserNameAlreadyRegisteredException(user.getUserName());
186 // Try to find the contact
187 Contact foundContact = this.getEntityManager().find(user.getUserContact().getClass(), user.getUserContact().getContactId());
189 // Set detached object in rexcruiter instance
190 user.setUserContact(foundContact);
193 user.setUserCreated(new GregorianCalendar());
196 this.getEntityManager().persist(user);
198 // Flush it to get updated instance back
199 this.getEntityManager().flush();
202 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.linkUser: user={1} - EXIT!", this.getClass().getSimpleName(), user)); //NOI18N
204 // Return updated instanc
209 public User lockUserAccount (final User user, final String userLockReason, final String baseUrl) throws UserStatusLockedException, UserStatusUnconfirmedException, UserNotFoundException {
211 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.lockUserAccount: user={1},userLockReason={2},baseUrl={3} - CALLED!", this.getClass().getSimpleName(), user, userLockReason, baseUrl)); //NOI18N
213 // user should not be null
216 throw new NullPointerException("user is null"); //NOI18N
217 } else if (user.getUserId() == null) {
219 throw new NullPointerException("user.userId is null"); //NOI18N
220 } else if (user.getUserId() < 1) {
222 throw new IllegalArgumentException(MessageFormat.format("user.userId={0} is null", user.getUserId())); //NOI18N
223 } else if (user.getUserContact() == null) {
225 throw new NullPointerException("user.userContact is null"); //NOI18N
226 } else if (user.getUserContact().getContactId() == null) {
228 throw new NullPointerException("user.userContact.contactId is null"); //NOI18N
229 } else if (user.getUserContact().getContactId() < 1) {
230 // Not valid id number
231 throw new IllegalArgumentException(MessageFormat.format("user.userContact.contactId={0} is not valid", user.getUserContact().getContactId())); //NOI18N
232 } else if (user.getUserAccountStatus() == null) {
234 throw new NullPointerException("user.userAccountStatus is null"); //NOI18N
235 } else if (!this.userBean.ifUserExists(user)) {
236 // Name already found
237 throw new UserNotFoundException(user);
238 } else if (user.getUserAccountStatus() == UserAccountStatus.LOCKED) {
240 throw new UserStatusLockedException(user);
241 } else if (user.getUserAccountStatus() == UserAccountStatus.UNCONFIRMED) {
242 // Account is unconfirmed
243 throw new UserStatusUnconfirmedException(user);
244 } else if (null == userLockReason) {
246 throw new NullPointerException("userLockReason is null"); //NOI18N
247 } else if (userLockReason.isEmpty()) {
249 throw new IllegalArgumentException("userLockReason is empty"); //NOI18N
252 // Remove contact instance as this is not updated
253 user.setUserContact(null);
255 // Set as locked, set timestamp and lock reason
256 user.setUserAccountStatus(UserAccountStatus.LOCKED);
257 user.setUserLastLocked(new GregorianCalendar());
258 user.setUserLastLockedReason(userLockReason);
261 User updatedUser = this.userBean.updateUserData(user);
263 // @TODO Create user lock history entry
265 Address emailAddress;
268 // Create email address and set
269 emailAddress = new InternetAddress(updatedUser.getUserContact().getContactEmailAddress());
270 } catch (final AddressException ex) {
272 throw new EJBException(ex);
276 // @TODO externalize subject line
277 this.sendEmail("Account locked", "account_locked", emailAddress, updatedUser, baseUrl); //NOI18N
280 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.lockUserAccount: updatedUser={1} - EXIT!", this.getClass().getSimpleName(), updatedUser)); //NOI18N
282 // Return detached (and updated) user
287 public User unlockUserAccount (final User user, final String baseUrl) throws UserStatusConfirmedException, UserStatusUnconfirmedException, UserNotFoundException {
289 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.lockUserAccount: user={1},baseUrl={2} - CALLED!", this.getClass().getSimpleName(), user, baseUrl)); //NOI18N
291 // user should not be null
294 throw new NullPointerException("user is null"); //NOI18N
295 } else if (user.getUserId() == null) {
297 throw new NullPointerException("user.userId is null"); //NOI18N
298 } else if (user.getUserId() < 1) {
300 throw new IllegalArgumentException(MessageFormat.format("user.userId={0} is null", user.getUserId())); //NOI18N
301 } else if (user.getUserContact() == null) {
303 throw new NullPointerException("user.userContact is null"); //NOI18N
304 } else if (user.getUserContact().getContactId() == null) {
306 throw new NullPointerException("user.userContact.contactId is null"); //NOI18N
307 } else if (user.getUserContact().getContactId() < 1) {
308 // Not valid id number
309 throw new IllegalArgumentException(MessageFormat.format("user.userContact.contactId={0} is not valid", user.getUserContact().getContactId())); //NOI18N
310 } else if (user.getUserAccountStatus() == null) {
312 throw new NullPointerException("user.userAccountStatus is null"); //NOI18N
313 } else if (!this.userBean.ifUserExists(user)) {
314 // Name already found
315 throw new UserNotFoundException(user);
316 } else if (user.getUserAccountStatus() == UserAccountStatus.CONFIRMED) {
317 // Account is confirmed
318 throw new UserStatusConfirmedException(user);
319 } else if (user.getUserAccountStatus() == UserAccountStatus.UNCONFIRMED) {
320 // Account is unconfirmed
321 throw new UserStatusUnconfirmedException(user);
324 // Remove contact instance as this is not updated
325 user.setUserContact(null);
328 user.setUserAccountStatus(UserAccountStatus.CONFIRMED);
331 User updatedUser = this.userBean.updateUserData(user);
333 // @TODO Create user lock history entry
335 Address emailAddress;
338 // Create email address and set
339 emailAddress = new InternetAddress(updatedUser.getUserContact().getContactEmailAddress());
340 } catch (final AddressException ex) {
342 throw new EJBException(ex);
346 // @TODO externalize subject line
347 this.sendEmail("Account unlocked", "account_unlocked", emailAddress, updatedUser, baseUrl); //NOI18N
350 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.lockUserAccount: updatedUser={1} - EXIT!", this.getClass().getSimpleName(), updatedUser)); //NOI18N
352 // Return changed account