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 General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (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 General Public License for more details.
14 * You should have received a copy of the GNU 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.util.Calendar;
20 import java.util.Objects;
21 import javax.persistence.Basic;
22 import javax.persistence.CascadeType;
23 import javax.persistence.Column;
24 import javax.persistence.Entity;
25 import javax.persistence.EnumType;
26 import javax.persistence.Enumerated;
27 import javax.persistence.GeneratedValue;
28 import javax.persistence.GenerationType;
29 import javax.persistence.Id;
30 import javax.persistence.JoinColumn;
31 import javax.persistence.NamedQueries;
32 import javax.persistence.NamedQuery;
33 import javax.persistence.OneToOne;
34 import javax.persistence.Table;
35 import javax.persistence.Temporal;
36 import javax.persistence.TemporalType;
37 import org.mxchange.jusercore.model.email_address.status.EmailChangeStatus;
38 import org.mxchange.jusercore.model.user.LoginUser;
39 import org.mxchange.jusercore.model.user.User;
42 * A POJO for changing email addresses.
44 * @author Roland Haeder<roland@mxchange.org>
46 @Entity (name = "email_changes")
47 @Table (name = "email_changes")
50 @NamedQuery (name = "SearchEmailChangeByEmail", query = "SELECT e FROM email_changes AS e WHERE LOWER(e.emailAddress) LIKE LOWER(:email)"),
51 @NamedQuery (name = "AllEmailAddressChanges", query = "SELECT e.emailAddress FROM email_changes AS e ORDER BY e.emailChangeId ASC"),
52 @NamedQuery (name = "SearchEmailChangeByHash", query = "SELECT e FROM email_changes AS e WHERE e.emailChangeHash = :hash")
55 @SuppressWarnings ("PersistenceUnitPresent")
56 public class EmailAddressChange implements ChangeableEmailAddress {
61 private static final long serialVersionUID = 398_459_287_176_139L;
64 * Email address to change to
66 @Basic (optional = false)
67 @Column (name = "email_address", length = 100, nullable = false, updatable = false)
68 private String emailAddress;
71 * Timestamp when this change has been added
73 @Basic (optional = false)
74 @Temporal (TemporalType.TIMESTAMP)
75 @Column (name = "email_change_created", nullable = false, updatable = false)
76 private Calendar emailChangeCreated;
79 * Timestamp when this change has been done or undone
81 @Basic (optional = false)
82 @Temporal (TemporalType.TIMESTAMP)
83 @Column (name = "email_change_done", nullable = false, updatable = false)
84 private Calendar emailChangeDone;
87 * Email change hash the user has to click
89 @Basic (optional = false)
90 @Column (name = "email_change_hash", unique = true)
91 private String emailChangeHash;
97 @GeneratedValue (strategy = GenerationType.IDENTITY)
98 @Column (name = "email_change_id", nullable = false, updatable = false)
99 private Long emailChangeId;
102 * Email change status
104 @Basic (optional = false)
105 @Column (name = "email_change_status", nullable = false, updatable = false)
106 @Enumerated (EnumType.STRING)
107 private EmailChangeStatus emailChangeStatus;
110 * User initiating the email change
112 @JoinColumn (name = "email_change_user_id", nullable = false, updatable = false)
113 @OneToOne (targetEntity = LoginUser.class, cascade = CascadeType.REFRESH, optional = false)
114 private User emailChangeUser;
117 * Default constructor
119 public EmailAddressChange () {
120 // Set default email change status
121 this.emailChangeStatus = EmailChangeStatus.NEW;
125 * Constructor with all fields to set
127 * @param emailChangeId Email change id
128 * @param user User instance
129 * @param emailAddress Email address
130 * @param emailChangeCreated Timestamp for creation
131 * @param emailChangeStatus Email change status
132 * @param emailChangeDone When this entry has been done
133 * @param emailChangeHash Email change hash
135 public EmailAddressChange (final Long emailChangeId, final User user, final String emailAddress, final Calendar emailChangeCreated, final EmailChangeStatus emailChangeStatus, final Calendar emailChangeDone, final String emailChangeHash) {
136 // Call other constructor
137 this(user, emailAddress);
140 this.emailChangeId = emailChangeId;
141 this.emailChangeCreated = emailChangeCreated;
142 this.emailChangeStatus = emailChangeStatus;
143 this.emailChangeDone = emailChangeDone;
144 this.emailChangeHash = emailChangeHash;
148 * Constructor with user and email address
150 * @param user User instance
151 * @param emailAddress Email address
153 public EmailAddressChange (final User user, final String emailAddress) {
154 // Call other constructor
158 this.emailChangeUser = user;
159 this.emailAddress = emailAddress;
163 public boolean equals (final Object object) {
164 if (this == object) {
166 } else if (null == object) {
168 } else if (this.getClass() != object.getClass()) {
172 final ChangeableEmailAddress otherEmail = (ChangeableEmailAddress) object;
174 if (!Objects.equals(this.getEmailAddress(), otherEmail.getEmailAddress())) {
178 return Objects.equals(this.getEmailChangeUser(), otherEmail.getEmailChangeUser());
182 public int hashCode () {
184 hash = 71 * hash + Objects.hashCode(this.getEmailAddress());
185 hash = 71 * hash + Objects.hashCode(this.getEmailChangeUser());
190 public String getEmailAddress () {
191 return this.emailAddress;
195 public void setEmailAddress (final String emailAddress) {
196 this.emailAddress = emailAddress;
200 public Calendar getEmailChangeCreated () {
201 return this.emailChangeCreated;
205 public void setEmailChangeCreated (final Calendar emailChangeCreated) {
206 this.emailChangeCreated = emailChangeCreated;
210 public Calendar getEmailChangeDone () {
211 return this.emailChangeDone;
215 public void setEmailChangeDone (final Calendar emailChangeDone) {
216 this.emailChangeDone = emailChangeDone;
220 public String getEmailChangeHash () {
221 return this.emailChangeHash;
225 public void setEmailChangeHash (final String emailChangeHash) {
226 this.emailChangeHash = emailChangeHash;
230 public Long getEmailChangeId () {
231 return this.emailChangeId;
235 public void setEmailChangeId (final Long emailChangeId) {
236 this.emailChangeId = emailChangeId;
240 public EmailChangeStatus getEmailChangeStatus () {
241 return this.emailChangeStatus;
245 public void setEmailChangeStatus (final EmailChangeStatus emailChangeStatus) {
246 this.emailChangeStatus = emailChangeStatus;
250 public User getEmailChangeUser () {
251 return this.emailChangeUser;
255 public void setEmailChangeUser (final User emailChangeUser) {
256 this.emailChangeUser = emailChangeUser;