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

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