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