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

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