2 * Copyright (C) 2016 - 2024 Free Software Foundation
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.email_address;
19 import java.text.MessageFormat;
20 import java.util.Date;
21 import java.util.List;
23 import javax.ejb.EJBException;
24 import javax.ejb.Stateless;
25 import javax.persistence.NoResultException;
26 import javax.persistence.Query;
27 import org.mxchange.addressbook.enterprise.BaseAddressbookEnterpriseBean;
28 import org.mxchange.jusercore.model.email_address.ChangeableEmailAddress;
29 import org.mxchange.jusercore.model.email_address.EmailAddressChange;
30 import org.mxchange.jusercore.model.user.UserSessionBeanRemote;
31 import org.mxchange.juserlogincore.utils.UserLoginUtils;
34 * A session-scoped bean for changing email addresses
36 * @author Roland Häder<roland@mxchange.org>
38 @Stateless (name = "userEmailChange", description = "A bean handling user email changes")
39 public class AddressbookUserEmailChangeSessionBean extends BaseAddressbookEnterpriseBean implements UserEmailChangeSessionBeanRemote {
44 private static final long serialVersionUID = 182_698_165_971_548L;
49 @EJB (lookup = "java:global/addressbook-ejb/user!org.mxchange.jusercore.model.user.UserSessionBeanRemote")
50 private UserSessionBeanRemote userBean;
55 public AddressbookUserEmailChangeSessionBean () {
56 // Call super constructor
57 super("jms/addressbook-queue-factory", "jms/addressbook-email-queue"); //NOI18N
61 public void enqueueEmailAddressForChange (final ChangeableEmailAddress emailChange, final String baseUrl) {
63 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.enqueueEmailAddressForChange: emailChange={1},baseUrl={2} - CALLED!", this.getClass().getSimpleName(), emailChange, baseUrl)); //NOI18N
65 // Email address change should be valid
66 if (null == emailChange) {
68 throw new NullPointerException("emailChange is null"); //NOI18N
69 } else if (emailChange.getEmailChangeUser() == null) {
71 throw new NullPointerException("emailChange.emailChangeUser is null"); //NOI18N
72 } else if (emailChange.getEmailChangeUser().getUserId() == null) {
74 throw new NullPointerException("emailChange.emailChangeUser.userId is null"); //NOI18N
75 } else if (emailChange.getEmailChangeUser().getUserId() < 1) {
77 throw new IllegalArgumentException(MessageFormat.format("emailChange.emailChangeUser.userId={0} is invalid.", emailChange.getEmailChangeUser().getUserId())); //NOI18N
78 } else if (emailChange.getEmailAddress().trim().isEmpty()) {
79 // Email address is empty
80 throw new IllegalArgumentException("emailChange.emaiLAddress is empty."); //NOI18N
81 } else if (this.isEmailAddressEnqueued(emailChange.getEmailAddress())) {
82 // Email address is already enqueued
83 throw new EJBException(MessageFormat.format("Email address {0} is already enqueued.", emailChange.getEmailAddress())); //NOI18N
84 } else if (null == baseUrl) {
86 throw new NullPointerException("baseUrl is null"); //NOI18N
87 } else if (baseUrl.isEmpty()) {
89 throw new IllegalArgumentException("baseUrl is empty"); //NOI18N
92 // The email change is not (yet) there, add secure hash and "created" timestamp
93 emailChange.setEmailChangeCreated(new Date());
94 this.generateSecureHash(emailChange);
97 //@TODO Fix email delivery then allow this: this.getEntityManager().persist(emailChange);
99 this.sendEmail("User email change", "user_email_change", emailChange.getEmailChangeUser(), baseUrl, null); //NOI18N
102 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.enqueueEmailAddressForChange - EXIT!", this.getClass().getSimpleName())); //NOI18N
106 @SuppressWarnings ("unchecked")
107 public List<ChangeableEmailAddress> fetchAllQueuedAddressChanges () {
109 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.allQueuedAddresses: CALLED!", this.getClass().getSimpleName())); //NOI18N
112 final Query query = this.getEntityManager().createNamedQuery("AllEmailAddressChanges", ChangeableEmailAddress.class); //NOI18N
115 final List<ChangeableEmailAddress> emailAddresses = query.getResultList();
118 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.allQueuedAddresses: emailAddresses.size()={1} - EXIT!", this.getClass().getSimpleName(), emailAddresses.size())); //NOI18N
121 return emailAddresses;
125 public void updateEmailAddress (final ChangeableEmailAddress emailAddress) {
127 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.updateEmailAddress: emailAddress={1} - CALLED!", this.getClass().getSimpleName(), emailAddress)); //NOI18N
129 // Email address change should be valid
130 if (null == emailAddress) {
132 throw new NullPointerException("emailAddress is null"); //NOI18N
133 } else if (emailAddress.getEmailChangeId() == null) {
135 throw new NullPointerException("emailAddress.emailChangeId is null"); //NOI18N
136 } else if (emailAddress.getEmailChangeId() < 1) {
138 throw new IllegalArgumentException(MessageFormat.format("emailAddress.emailChangeId={0} is not valid.", emailAddress.getEmailChangeId())); //NOI18N
139 } else if (emailAddress.getEmailAddress().trim().isEmpty()) {
140 // Email address is empty
141 throw new IllegalArgumentException("emailAddress.emaiLAddress is empty."); //NOI18N
142 } else if (!this.isEmailAddressEnqueued(emailAddress.getEmailAddress())) {
143 // Email address is not enqueued
144 throw new EJBException(MessageFormat.format("Email address {0} is not enqueued.", emailAddress.getEmailAddress())); //NOI18N
147 throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
151 * Generates a secure, unique hash for given email address change. This
152 * requires to check if the hash is really not there.
154 * @param emailAddress Email address change
156 private void generateSecureHash (final ChangeableEmailAddress emailAddress) {
157 // Email address change should be valid
158 if (null == emailAddress) {
160 throw new NullPointerException("emailAddress is null"); //NOI18N
161 } else if (emailAddress.getEmailAddress().trim().isEmpty()) {
162 // Email address is empty
163 throw new IllegalArgumentException("emailAddress.emaiLAddress is empty."); //NOI18N
166 // Initialize loop with null
169 // Default is not used
170 boolean isUsed = true;
172 // Search for free hash
174 // Generate hash, there is already in UserUtils a nice method that can be used for this purpose.
175 hash = UserLoginUtils.encryptPassword(String.format("%s:%s", emailAddress.getEmailAddress(), emailAddress.toString())); //NOI18N
177 // The hash *may* be unique, better test it
178 final Query query = this.getEntityManager().createNamedQuery("SearchEmailChangeByHash", EmailAddressChange.class); //NOI18N
180 // Set hash as parameter
181 query.setParameter("hash", hash); //NOI18N
183 // Try to get single result
186 final ChangeableEmailAddress dummy = (ChangeableEmailAddress) query.getSingleResult();
187 } catch (final NoResultException ex) {
193 // hash should not be null and set
194 assert (hash != null) : "hash is null"; //NOI18N
195 assert (!hash.isEmpty()) : "hash is empty"; //NOI18N
197 // Set it in email change
198 emailAddress.setEmailChangeHash(hash);
202 * Checks whether given email address is already enqueued
204 * @param emailAddress Email address to check
206 * @return Whether the email address has already been enqueued
208 private boolean isEmailAddressEnqueued (final String emailAddress) {
210 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.isEmailAddressEnqueued: emailAddress={1} - CALLED!", this.getClass().getSimpleName(), emailAddress)); //NOI18N
212 // Default is not found
213 boolean isFound = false;
216 for (final ChangeableEmailAddress address : this.fetchAllQueuedAddressChanges()) {
218 if (address.getEmailAddress().equals(emailAddress)) {
219 // Yes, set flag, skip further iterations
226 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.isEmailAddressEnqueued: isFound={1} - EXIT!", this.getClass().getSimpleName(), isFound)); //NOI18N