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 all fields to set
 124          * <p>
 125          * @param emailChangeId      Email change id
 126          * @param user               User instance
 127          * @param emailAddress       Email address
 128          * @param emailChangeCreated Timestamp for creation
 129          * @param emailChangeStatus  Email change status
 130          * @param emailChangeDone    When this entry has been done
 131          * @param emailChangeHash    Email change hash
 132          */
 133         public EmailAddressChange (final Long emailChangeId, final User user, final String emailAddress, final Calendar emailChangeCreated, final EmailChangeStatus emailChangeStatus, final Calendar emailChangeDone, final String emailChangeHash) {
 134                 // Call other constructor
 135                 this(user, emailAddress);
 136
 137                 // Set remaining
 138                 this.emailChangeId = emailChangeId;
 139                 this.emailChangeCreated = emailChangeCreated;
 140                 this.emailChangeStatus = emailChangeStatus;
 141                 this.emailChangeDone = emailChangeDone;
 142                 this.emailChangeHash = emailChangeHash;
 143         }
 144
 145         /**
 146          * Constructor with user and email address
 147          * <p>
 148          * @param user         User instance
 149          * @param emailAddress Email address
 150          */
 151         public EmailAddressChange (final User user, final String emailAddress) {
 152                 // Call other constructor
 153                 this();
 154
 155                 // Set all
 156                 this.emailChangeUser = user;
 157                 this.emailAddress = emailAddress;
 158         }
 159
 160         @Override
 161         public boolean equals (final Object object) {
 162                 if (this == object) {
 163                         return true;
 164                 } else if (null == object) {
 165                         return false;
 166                 } else if (this.getClass() != object.getClass()) {
 167                         return false;
 168                 }
 169
 170                 final ChangeableEmailAddress otherEmail = (ChangeableEmailAddress) object;
 171
 172                 if (!Objects.equals(this.getEmailAddress(), otherEmail.getEmailAddress())) {
 173                         return false;
 174                 }
 175
 176                 return Objects.equals(this.getEmailChangeUser(), otherEmail.getEmailChangeUser());
 177         }
 178
 179         @Override
 180         public int hashCode () {
 181                 int hash = 5;
 182                 hash = 71 * hash + Objects.hashCode(this.getEmailAddress());
 183                 hash = 71 * hash + Objects.hashCode(this.getEmailChangeUser());
 184                 return hash;
 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         public Calendar getEmailChangeCreated () {
 199                 return this.emailChangeCreated;
 200         }
 201
 202         @Override
 203         public void setEmailChangeCreated (final Calendar emailChangeCreated) {
 204                 this.emailChangeCreated = emailChangeCreated;
 205         }
 206
 207         @Override
 208         public Calendar getEmailChangeDone () {
 209                 return this.emailChangeDone;
 210         }
 211
 212         @Override
 213         public void setEmailChangeDone (final Calendar emailChangeDone) {
 214                 this.emailChangeDone = emailChangeDone;
 215         }
 216
 217         @Override
 218         public String getEmailChangeHash () {
 219                 return this.emailChangeHash;
 220         }
 221
 222         @Override
 223         public void setEmailChangeHash (final String emailChangeHash) {
 224                 this.emailChangeHash = emailChangeHash;
 225         }
 226
 227         @Override
 228         public Long getEmailChangeId () {
 229                 return this.emailChangeId;
 230         }
 231
 232         @Override
 233         public void setEmailChangeId (final Long emailChangeId) {
 234                 this.emailChangeId = emailChangeId;
 235         }
 236
 237         @Override
 238         public EmailChangeStatus getEmailChangeStatus () {
 239                 return this.emailChangeStatus;
 240         }
 241
 242         @Override
 243         public void setEmailChangeStatus (final EmailChangeStatus emailChangeStatus) {
 244                 this.emailChangeStatus = emailChangeStatus;
 245         }
 246
 247         @Override
 248         public User getEmailChangeUser () {
 249                 return this.emailChangeUser;
 250         }
 251
 252         @Override
 253         public void setEmailChangeUser (final User emailChangeUser) {
 254                 this.emailChangeUser = emailChangeUser;
 255         }
 256
 257 }