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 public class EmailAddressChange implements ChangeableEmailAddress {
60 private static final long serialVersionUID = 398_459_287_176_139L;
63 * Email address to change to
65 @Basic (optional = false)
66 @Column (name = "email_address", length = 100, nullable = false, updatable = false)
67 private String emailAddress;
70 * Timestamp when this change has been added
72 @Basic (optional = false)
73 @Temporal (TemporalType.TIMESTAMP)
74 @Column (name = "email_change_created", nullable = false, updatable = false)
75 private Calendar emailChangeCreated;
78 * Timestamp when this change has been done or undone
80 @Basic (optional = false)
81 @Temporal (TemporalType.TIMESTAMP)
82 @Column (name = "email_change_done", nullable = false, updatable = false)
83 private Calendar emailChangeDone;
86 * Email change hash the user has to click
88 @Basic (optional = false)
89 @Column (name = "email_change_hash", unique = true)
90 private String emailChangeHash;
96 @GeneratedValue (strategy = GenerationType.IDENTITY)
97 @Column (name = "email_change_id", nullable = false, updatable = false)
98 private Long emailChangeId;
101 * Email change status
103 @Basic (optional = false)
104 @Column (name = "email_change_status", nullable = false, updatable = false)
105 @Enumerated (EnumType.STRING)
106 private EmailChangeStatus emailChangeStatus;
109 * User initiating the email change
111 @JoinColumn (name = "email_change_user_id", nullable = false, updatable = false)
112 @OneToOne (targetEntity = LoginUser.class, cascade = CascadeType.REFRESH, optional = false)
113 private User emailChangeUser;
116 * Default constructor
118 public EmailAddressChange () {
119 // Set default email change status
120 this.emailChangeStatus = EmailChangeStatus.NEW;
124 * Constructor with all fields to set
126 * @param emailChangeId Email change id
127 * @param user User instance
128 * @param emailAddress Email address
129 * @param emailChangeCreated Timestamp for creation
130 * @param emailChangeStatus Email change status
131 * @param emailChangeDone When this entry has been done
132 * @param emailChangeHash Email change hash
134 public EmailAddressChange (final Long emailChangeId, final User user, final String emailAddress, final Calendar emailChangeCreated, final EmailChangeStatus emailChangeStatus, final Calendar emailChangeDone, final String emailChangeHash) {
135 // Call other constructor
136 this(user, emailAddress);
139 this.emailChangeId = emailChangeId;
140 this.emailChangeCreated = emailChangeCreated;
141 this.emailChangeStatus = emailChangeStatus;
142 this.emailChangeDone = emailChangeDone;
143 this.emailChangeHash = emailChangeHash;
147 * Constructor with user and email address
149 * @param user User instance
150 * @param emailAddress Email address
152 public EmailAddressChange (final User user, final String emailAddress) {
153 // Call other constructor
157 this.emailChangeUser = user;
158 this.emailAddress = emailAddress;
162 public boolean equals (final Object object) {
163 if (this == object) {
165 } else if (null == object) {
167 } else if (this.getClass() != object.getClass()) {
171 final ChangeableEmailAddress otherEmail = (ChangeableEmailAddress) object;
173 if (!Objects.equals(this.getEmailAddress(), otherEmail.getEmailAddress())) {
177 return Objects.equals(this.getEmailChangeUser(), otherEmail.getEmailChangeUser());
181 public int hashCode () {
183 hash = 71 * hash + Objects.hashCode(this.getEmailAddress());
184 hash = 71 * hash + Objects.hashCode(this.getEmailChangeUser());
189 public String getEmailAddress () {
190 return this.emailAddress;
194 public void setEmailAddress (final String emailAddress) {
195 this.emailAddress = emailAddress;
199 public Calendar getEmailChangeCreated () {
200 return this.emailChangeCreated;
204 public void setEmailChangeCreated (final Calendar emailChangeCreated) {
205 this.emailChangeCreated = emailChangeCreated;
209 public Calendar getEmailChangeDone () {
210 return this.emailChangeDone;
214 public void setEmailChangeDone (final Calendar emailChangeDone) {
215 this.emailChangeDone = emailChangeDone;
219 public String getEmailChangeHash () {
220 return this.emailChangeHash;
224 public void setEmailChangeHash (final String emailChangeHash) {
225 this.emailChangeHash = emailChangeHash;
229 public Long getEmailChangeId () {
230 return this.emailChangeId;
234 public void setEmailChangeId (final Long emailChangeId) {
235 this.emailChangeId = emailChangeId;
239 public EmailChangeStatus getEmailChangeStatus () {
240 return this.emailChangeStatus;
244 public void setEmailChangeStatus (final EmailChangeStatus emailChangeStatus) {
245 this.emailChangeStatus = emailChangeStatus;
249 public User getEmailChangeUser () {
250 return this.emailChangeUser;
254 public void setEmailChangeUser (final User emailChangeUser) {
255 this.emailChangeUser = emailChangeUser;