src/org/mxchange/jusercore/model/email_address/EmailAddressChange.java

   1 /*
   2  * Copyright (C) 2016, 2017 Roland Häder
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17 package org.mxchange.jusercore.model.email_address;
  18
  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 javax.persistence.Transient;
  38 import org.mxchange.jusercore.model.email_address.status.EmailChangeStatus;
  39 import org.mxchange.jusercore.model.user.LoginUser;
  40 import org.mxchange.jusercore.model.user.User;
  41
  42 /**
  43  * A POJO for changing email addresses.
  44  * <p>
  45  * @author Roland Häder<roland@mxchange.org>
  46  */
  47 @Entity (name = "email_changes")
  48 @Table (name = "email_changes")
  49 @NamedQueries (
  50                 value = {
  51                         @NamedQuery (name = "SearchEmailChangeByEmail", query = "SELECT e FROM email_changes AS e WHERE LOWER(e.emailAddress) LIKE LOWER(:email)"),
  52                         @NamedQuery (name = "AllEmailAddressChanges", query = "SELECT e.emailAddress FROM email_changes AS e ORDER BY e.emailChangeId ASC"),
  53                         @NamedQuery (name = "SearchEmailChangeByHash", query = "SELECT e FROM email_changes AS e WHERE e.emailChangeHash = :hash")
  54                 }
  55 )
  56 @SuppressWarnings ("PersistenceUnitPresent")
  57 public class EmailAddressChange implements ChangeableEmailAddress {
  58
  59         /**
  60          * Serial number
  61          */
  62         @Transient
  63         private static final long serialVersionUID = 398_459_287_176_139L;
  64
  65         /**
  66          * Email address to change to
  67          */
  68         @Basic (optional = false)
  69         @Column (name = "email_address", length = 100, nullable = false, updatable = false)
  70         private String emailAddress;
  71
  72         /**
  73          * Timestamp when this change has been added
  74          */
  75         @Basic (optional = false)
  76         @Temporal (TemporalType.TIMESTAMP)
  77         @Column (name = "email_change_created", nullable = false, updatable = false)
  78         private Calendar emailChangeCreated;
  79
  80         /**
  81          * Timestamp when this change has been done or undone
  82          */
  83         @Basic (optional = false)
  84         @Temporal (TemporalType.TIMESTAMP)
  85         @Column (name = "email_change_done", nullable = false, updatable = false)
  86         private Calendar emailChangeDone;
  87
  88         /**
  89          * Email change hash the user has to click
  90          */
  91         @Basic (optional = false)
  92         @Column (name = "email_change_hash", unique = true)
  93         private String emailChangeHash;
  94
  95         /**
  96          * Email change id
  97          */
  98         @Id
  99         @GeneratedValue (strategy = GenerationType.IDENTITY)
 100         @Column (name = "email_change_id", nullable = false, updatable = false)
 101         private Long emailChangeId;
 102
 103         /**
 104          * Email change status
 105          */
 106         @Basic (optional = false)
 107         @Column (name = "email_change_status", nullable = false, updatable = false)
 108         @Enumerated (EnumType.STRING)
 109         private EmailChangeStatus emailChangeStatus;
 110
 111         /**
 112          * User initiating the email change
 113          */
 114         @JoinColumn (name = "email_change_user_id", nullable = false, updatable = false)
 115         @OneToOne (targetEntity = LoginUser.class, cascade = CascadeType.REFRESH, optional = false)
 116         private User emailChangeUser;
 117
 118         /**
 119          * Default constructor
 120          */
 121         public EmailAddressChange () {
 122                 // Set default email change status
 123                 this.emailChangeStatus = EmailChangeStatus.NEW;
 124         }
 125
 126         /**
 127          * Constructor with all fields to set
 128          * <p>
 129          * @param emailChangeId Email change id
 130          * @param user User instance
 131          * @param emailAddress Email address
 132          * @param emailChangeCreated Timestamp for creation
 133          * @param emailChangeStatus Email change status
 134          * @param emailChangeDone When this entry has been done
 135          * @param emailChangeHash Email change hash
 136          */
 137         public EmailAddressChange (final Long emailChangeId, final User user, final String emailAddress, final Calendar emailChangeCreated, final EmailChangeStatus emailChangeStatus, final Calendar emailChangeDone, final String emailChangeHash) {
 138                 // Call other constructor
 139                 this(user, emailAddress);
 140
 141                 // Set remaining
 142                 this.emailChangeId = emailChangeId;
 143                 this.emailChangeCreated = emailChangeCreated;
 144                 this.emailChangeStatus = emailChangeStatus;
 145                 this.emailChangeDone = emailChangeDone;
 146                 this.emailChangeHash = emailChangeHash;
 147         }
 148
 149         /**
 150          * Constructor with user and email address
 151          * <p>
 152          * @param user User instance
 153          * @param emailAddress Email address
 154          */
 155         public EmailAddressChange (final User user, final String emailAddress) {
 156                 // Call other constructor
 157                 this();
 158
 159                 // Set all
 160                 this.emailChangeUser = user;
 161                 this.emailAddress = emailAddress;
 162         }
 163
 164         @Override
 165         public boolean equals (final Object object) {
 166                 if (this == object) {
 167                         return true;
 168                 } else if (null == object) {
 169                         return false;
 170                 } else if (this.getClass() != object.getClass()) {
 171                         return false;
 172                 }
 173
 174                 final ChangeableEmailAddress otherEmail = (ChangeableEmailAddress) object;
 175
 176                 if (!Objects.equals(this.getEmailChangeId(), otherEmail.getEmailChangeId())) {
 177                         return false;
 178                 } else if (!Objects.equals(this.getEmailAddress(), otherEmail.getEmailAddress())) {
 179                         return false;
 180                 } else if (!Objects.equals(this.getEmailChangeUser(), otherEmail.getEmailChangeUser())) {
 181                         return false;
 182                 }
 183
 184                 return true;
 185         }
 186
 187         @Override
 188         public String getEmailAddress () {
 189                 return this.emailAddress;
 190         }
 191
 192         @Override
 193         public void setEmailAddress (final String emailAddress) {
 194                 this.emailAddress = emailAddress;
 195         }
 196
 197         @Override
 198         @SuppressWarnings ("ReturnOfDateField")
 199         public Calendar getEmailChangeCreated () {
 200                 return this.emailChangeCreated;
 201         }
 202
 203         @Override
 204         @SuppressWarnings ("AssignmentToDateFieldFromParameter")
 205         public void setEmailChangeCreated (final Calendar emailChangeCreated) {
 206                 this.emailChangeCreated = emailChangeCreated;
 207         }
 208
 209         @Override
 210         @SuppressWarnings ("ReturnOfDateField")
 211         public Calendar getEmailChangeDone () {
 212                 return this.emailChangeDone;
 213         }
 214
 215         @Override
 216         @SuppressWarnings ("AssignmentToDateFieldFromParameter")
 217         public void setEmailChangeDone (final Calendar emailChangeDone) {
 218                 this.emailChangeDone = emailChangeDone;
 219         }
 220
 221         @Override
 222         public String getEmailChangeHash () {
 223                 return this.emailChangeHash;
 224         }
 225
 226         @Override
 227         public void setEmailChangeHash (final String emailChangeHash) {
 228                 this.emailChangeHash = emailChangeHash;
 229         }
 230
 231         @Override
 232         public Long getEmailChangeId () {
 233                 return this.emailChangeId;
 234         }
 235
 236         @Override
 237         public void setEmailChangeId (final Long emailChangeId) {
 238                 this.emailChangeId = emailChangeId;
 239         }
 240
 241         @Override
 242         public EmailChangeStatus getEmailChangeStatus () {
 243                 return this.emailChangeStatus;
 244         }
 245
 246         @Override
 247         public void setEmailChangeStatus (final EmailChangeStatus emailChangeStatus) {
 248                 this.emailChangeStatus = emailChangeStatus;
 249         }
 250
 251         @Override
 252         public User getEmailChangeUser () {
 253                 return this.emailChangeUser;
 254         }
 255
 256         @Override
 257         public void setEmailChangeUser (final User emailChangeUser) {
 258                 this.emailChangeUser = emailChangeUser;
 259         }
 260
 261         @Override
 262         public int hashCode () {
 263                 int hash = 5;
 264
 265                 hash = 71 * hash + Objects.hashCode(this.getEmailChangeId());
 266                 hash = 71 * hash + Objects.hashCode(this.getEmailAddress());
 267                 hash = 71 * hash + Objects.hashCode(this.getEmailChangeUser());
 268
 269                 return hash;
 270         }
 271
 272 }