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.email_address;
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.mail.Address;
26 import javax.mail.internet.AddressException;
27 import javax.mail.internet.InternetAddress;
28 import javax.persistence.NoResultException;
29 import javax.persistence.Query;
30 import org.mxchange.jjobs.database.BaseJobsDatabaseBean;
31 import org.mxchange.jusercore.model.user.UserSessionBeanRemote;
32 import org.mxchange.jusercore.model.user.UserUtils;
35 * A session bean for changing email addresses
37 * @author Roland Häder<roland@mxchange.org>
39 @Stateless (name = "userEmailChange", description = "A bean handling user email changes")
40 public class JobsUserEmailChangeSessionBean extends BaseJobsDatabaseBean implements UserEmailChangeSessionBeanRemote {
45 private static final long serialVersionUID = 182_698_165_971_548L;
51 private UserSessionBeanRemote userBean;
56 public JobsUserEmailChangeSessionBean () {
60 @SuppressWarnings ("unchecked")
61 public List<String> allQueuedAddresses () {
63 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.allQueuedAddresses: CALLED!", this.getClass().getSimpleName())); //NOI18N
66 Query query = this.getEntityManager().createNamedQuery("AllEmailAddressChanges", String.class); //NOI18N
69 List<String> emailAddresses = query.getResultList();
72 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.allQueuedAddresses: emailAddresses.size()={1} - EXIT!", this.getClass().getSimpleName(), emailAddresses.size())); //NOI18N
75 return emailAddresses;
79 public void enqueueEmailAddressForChange (final ChangeableEmailAddress emailChange, final String baseUrl) {
81 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.enqueueEmailAddressForChange: emailChange={1},baseUrl={2} - CALLED!", this.getClass().getSimpleName(), emailChange, baseUrl)); //NOI18N
83 // Email address change should be valid
84 if (null == emailChange) {
86 throw new NullPointerException("emailChange is null"); //NOI18N
87 } else if (emailChange.getEmailChangeUser() == null) {
89 throw new NullPointerException("emailChange.emailChangeUser is null"); //NOI18N
90 } else if (emailChange.getEmailChangeUser().getUserId() == null) {
92 throw new NullPointerException("emailChange.emailChangeUser.userId is null"); //NOI18N
93 } else if (emailChange.getEmailChangeUser().getUserId() < 1) {
95 throw new IllegalArgumentException(MessageFormat.format("emailChange.emailChangeUser.userId={0} is invalid.", emailChange.getEmailChangeUser().getUserId())); //NOI18N
96 } else if (!this.userBean.ifUserExists(emailChange.getEmailChangeUser())) {
97 // User does not exist
98 throw new EJBException(MessageFormat.format("Email change with id {0} does not exist.", emailChange.getEmailChangeId())); //NOI18N
99 } else if (emailChange.getEmailAddress().trim().isEmpty()) {
100 // Email address is empty
101 throw new IllegalArgumentException("emailChange.emaiLAddress is empty."); //NOI18N
102 } else if (this.isEmailAddressEnqueued(emailChange.getEmailAddress())) {
103 // Email address is already enqueued
104 throw new EJBException(MessageFormat.format("Email address {0} is already enqueued.", emailChange.getEmailAddress())); //NOI18N
107 // The email change is not (yet) there, add secure hash and "created" timestamp
108 emailChange.setEmailChangeCreated(new GregorianCalendar());
109 this.generateSecureHash(emailChange);
112 emailChange.setEmailChangeUser(this.getManagedUser(emailChange.getEmailChangeUser()));
115 //@TODO Fix email delivery then allow this: this.getEntityManager().persist(emailChange);
117 Address emailAddress;
120 // Create email address and set
121 emailAddress = new InternetAddress(emailChange.getEmailAddress());
122 } catch (final AddressException ex) {
124 throw new EJBException(ex);
128 this.sendEmail("Email change", "email_change", emailAddress, emailChange.getEmailChangeUser(), baseUrl); //NOI18N
131 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.enqueueEmailAddressForChange - EXIT!", this.getClass().getSimpleName())); //NOI18N
135 public boolean isEmailAddressEnqueued (final String emailAddress) {
137 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.isEmailAddressEnqueued: emailAddress={1} - CALLED!", this.getClass().getSimpleName(), emailAddress)); //NOI18N
139 // Create query instance
140 Query query = this.getEntityManager().createNamedQuery("SearchEmailChangeByEmail"); //NOI18N
142 // Add email address as parameter
143 query.setParameter("email", emailAddress); //NOI18N
145 // Initialize variable
146 boolean isFound = false;
150 // Try to get single result
151 ChangeableEmailAddress dummy = (ChangeableEmailAddress) query.getSingleResult();
155 } catch (final NoResultException ex) {
157 this.getLoggerBeanLocal().logException(ex);
161 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.isEmailAddressEnqueued: isFound={1} - EXIT!", this.getClass().getSimpleName(), isFound)); //NOI18N
168 public void updateEmailAddress (final ChangeableEmailAddress emailAddress) {
170 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.updateEmailAddress: emailAddress={1} - CALLED!", this.getClass().getSimpleName(), emailAddress)); //NOI18N
172 // Email address change should be valid
173 if (null == emailAddress) {
175 throw new NullPointerException("emailAddress is null"); //NOI18N
176 } else if (emailAddress.getEmailChangeId() == null) {
178 throw new NullPointerException("emailAddress.emailChangeId is null"); //NOI18N
179 } else if (emailAddress.getEmailChangeId() < 1) {
181 throw new IllegalArgumentException(MessageFormat.format("emailAddress.emailChangeId={0} is not valid.", emailAddress.getEmailChangeId())); //NOI18N
182 } else if (emailAddress.getEmailAddress().trim().isEmpty()) {
183 // Email address is empty
184 throw new IllegalArgumentException("emailAddress.emaiLAddress is empty."); //NOI18N
185 } else if (!this.userBean.ifUserExists(emailAddress.getEmailChangeUser())) {
186 // User does not exist
187 throw new EJBException(MessageFormat.format("Email change with id {0} does not exist.", emailAddress.getEmailChangeId())); //NOI18N
188 } else if (!this.isEmailAddressEnqueued(emailAddress.getEmailAddress())) {
189 // Email address is not enqueued
190 throw new EJBException(MessageFormat.format("Email address {0} is not enqueued.", emailAddress.getEmailAddress())); //NOI18N
193 throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
197 * Generates a secure, unique hash for given email address change. This
198 * requires to check if the hash is really not there.
200 * @param emailAddressChange Email address change
202 private void generateSecureHash (final ChangeableEmailAddress emailAddressChange) {
203 // Email address change should be valid
204 if (null == emailAddressChange) {
206 throw new NullPointerException("emailAddressChange is null"); //NOI18N
207 } else if (emailAddressChange.getEmailAddress().trim().isEmpty()) {
208 // Email address is empty
209 throw new IllegalArgumentException("emailAddressChange.emaiLAddress is empty."); //NOI18N
212 // Initialize loop with null
215 // Default is not used
216 boolean isUsed = true;
218 // Search for free hash
220 // Generate hash, there is already in UserUtils a nice method that can be used for this purpose.
221 hash = UserUtils.encryptPassword(String.format("%s:%s", emailAddressChange.getEmailAddress(), emailAddressChange.toString())); //NOI18N
223 // The hash *may* be unique, better test it
224 Query query = this.getEntityManager().createNamedQuery("SearchEmailChangeByHash", EmailAddressChange.class); //NOI18N
226 // Set hash as parameter
227 query.setParameter("hash", hash); //NOI18N
229 // Try to get single result
232 ChangeableEmailAddress dummy = (ChangeableEmailAddress) query.getSingleResult();
233 } catch (final NoResultException ex) {
239 // hash should not be null and set
240 assert (hash != null) : "hash is null"; //NOI18N
241 assert (!hash.isEmpty()) : "hash is empty"; //NOI18N
243 // Set it in email change
244 emailAddressChange.setEmailChangeHash(hash);