src/org/mxchange/jusercore/model/user/LoginUser.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.user;
  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.Lob;
  33 import javax.persistence.NamedQueries;
  34 import javax.persistence.NamedQuery;
  35 import javax.persistence.OneToOne;
  36 import javax.persistence.Table;
  37 import javax.persistence.Temporal;
  38 import javax.persistence.TemporalType;
  39 import org.mxchange.jcontacts.contact.Contact;
  40 import org.mxchange.jcontacts.contact.UserContact;
  41 import org.mxchange.jusercore.model.user.profilemodes.ProfileMode;
  42 import org.mxchange.jusercore.model.user.status.UserAccountStatus;
  43
  44 /**
  45  * A generic user entity class
  46  * <p>
  47  * @author Roland Haeder<roland@mxchange.org>
  48  */
  49 @Entity (name = "users")
  50 @Table (
  51                 name = "users",
  52                 indexes = {
  53                         @Index (
  54                                         name = "confirmation_key",
  55                                         unique = true,
  56                                         columnList = "user_confirm_key"
  57                         ),
  58                         @Index (
  59                                         name = "user_name",
  60                                         unique = true,
  61                                         columnList = "user_name"
  62                         )
  63                 }
  64 )
  65 @NamedQueries (
  66                 {
  67                         @NamedQuery (name = "AllUserNames", query = "SELECT DISTINCT u.userName FROM users AS u ORDER BY u.userId ASC"),
  68                         @NamedQuery (name = "AllEmailAddresses", query = "SELECT DISTINCT c.contactEmailAddress FROM contacts AS c INNER JOIN users AS u ON u.userContact = c ORDER BY c.contactId ASC"),
  69                         @NamedQuery (name = "SearchUserName", query = "SELECT u FROM users AS u WHERE LOWER(u.userName) LIKE LOWER(:param)"),
  70                         @NamedQuery (name = "SearchUserId", query = "SELECT u FROM users AS u WHERE u.userId = :id"),
  71                         @NamedQuery (name = "SearchEmailAddress", query = "SELECT u FROM users AS u INNER JOIN contacts AS c ON u.userContact = c WHERE LOWER(c.contactEmailAddress) LIKE LOWER(:param)"),
  72                         @NamedQuery (name = "SearchAllUsersExcept", query = "SELECT u FROM users AS u WHERE u != :user ORDER BY u.userId ASC"),
  73                         @NamedQuery (name = "AllPublicUsers", query = "SELECT u FROM users AS u WHERE u.userAccountStatus = :status AND u.userProfileMode = :mode ORDER BY u.userId ASC"),
  74                         @NamedQuery (name = "AllMemberPublicUsers", query = "SELECT u FROM users AS u WHERE u.userAccountStatus = :status AND u.userProfileMode IN (:public, :members) ORDER BY u.userId ASC")
  75                 }
  76 )
  77 public class LoginUser implements User {
  78
  79         /**
  80          * Serial number
  81          */
  82         private static final long serialVersionUID = 4_328_454_581_751L;
  83
  84         /**
  85          * Account status
  86          */
  87         @Basic (optional = false)
  88         @Column (name = "user_account_status", nullable = false)
  89         @Enumerated (value = EnumType.STRING)
  90         private UserAccountStatus userAccountStatus;
  91
  92         /**
  93          * Confirmation key
  94          */
  95         @Column (name = "user_confirm_key", length = 50)
  96         private String userConfirmKey;
  97
  98         /**
  99          * Id number from "contacts" table
 100          */
 101         @JoinColumn (name = "user_contact_id", nullable = false, updatable = false)
 102         @OneToOne (targetEntity = UserContact.class, cascade = CascadeType.ALL, optional = false)
 103         private Contact userContact;
 104
 105         /**
 106          * "created" timestamp
 107          */
 108         @Basic (optional = false)
 109         @Temporal (TemporalType.TIMESTAMP)
 110         @Column (name = "user_created", nullable = false)
 111         private Calendar userCreated;
 112
 113         /**
 114          * Encrypted password
 115          */
 116         @Column (name = "user_encrypted_password", nullable = false)
 117         private String userEncryptedPassword;
 118
 119         /**
 120          * User id
 121          */
 122         @Id
 123         @Column (name = "user_id", nullable = false, length = 20, updatable = false)
 124         @GeneratedValue (strategy = GenerationType.IDENTITY)
 125         private Long userId;
 126
 127         /**
 128          * Last "locked" timestamp
 129          */
 130         @Temporal (TemporalType.TIMESTAMP)
 131         @Column (name = "user_last_locked_timestamp")
 132         private Calendar userLastLocked;
 133
 134         /**
 135          * Last locked reason
 136          */
 137         @Lob
 138         @Column (name = "user_last_locked_reason")
 139         private String lastLockedReason;
 140
 141         /**
 142          * User name
 143          */
 144         @Column (name = "user_name", nullable = false, length = 20)
 145         private String userName;
 146
 147         /**
 148          * When this user has been updated
 149          */
 150         @Temporal (TemporalType.TIMESTAMP)
 151         @Column (name = "user_updated")
 152         private Calendar userUpdated;
 153
 154         /**
 155          * Profile mode of this user
 156          */
 157         @Basic (optional = false)
 158         @Enumerated (EnumType.STRING)
 159         @Column (name = "user_profile_mode", nullable = false)
 160         private ProfileMode userProfileMode;
 161
 162         /**
 163          * Default constructor
 164          */
 165         public LoginUser () {
 166                 // Default is invisible
 167                 this.userProfileMode = ProfileMode.INVISIBLE;
 168         }
 169
 170         @Override
 171         public void copyAll (final User user) {
 172                 // Copy also contact data
 173                 this.getUserContact().copyAll(user.getUserContact());
 174
 175                 // Copy other data
 176                 this.setUserConfirmKey(user.getUserConfirmKey());
 177                 this.setUserName(user.getUserName());
 178                 this.setUserEncryptedPassword(user.getUserEncryptedPassword());
 179                 this.setUserAccountStatus(user.getUserAccountStatus());
 180                 this.setUserCreated(user.getUserCreated());
 181                 this.setUserLastLocked(user.getUserLastLocked());
 182         }
 183
 184         @Override
 185         public boolean equals (final Object object) {
 186                 if (object == null) {
 187                         return false;
 188                 }
 189                 if (getClass() != object.getClass()) {
 190                         return false;
 191                 }
 192
 193                 final User other = (User) object;
 194
 195                 return ((Objects.equals(this.getUserName(), other.getUserName()))
 196                                 && (Objects.equals(this.getUserId(), other.getUserId())));
 197         }
 198
 199         @Override
 200         public String getLastLockedReason () {
 201                 return this.lastLockedReason;
 202         }
 203
 204         @Override
 205         public void setLastLockedReason (final String lastLockedReason) {
 206                 this.lastLockedReason = lastLockedReason;
 207         }
 208
 209         @Override
 210         public UserAccountStatus getUserAccountStatus () {
 211                 return this.userAccountStatus;
 212         }
 213
 214         @Override
 215         public void setUserAccountStatus (final UserAccountStatus userAccountStatus) {
 216                 this.userAccountStatus = userAccountStatus;
 217         }
 218
 219         @Override
 220         public String getUserConfirmKey () {
 221                 return this.userConfirmKey;
 222         }
 223
 224         @Override
 225         public void setUserConfirmKey (final String userConfirmKey) {
 226                 this.userConfirmKey = userConfirmKey;
 227         }
 228
 229         @Override
 230         public Contact getUserContact () {
 231                 return this.userContact;
 232         }
 233
 234         @Override
 235         public void setUserContact (final Contact userContact) {
 236                 this.userContact = userContact;
 237         }
 238
 239         @Override
 240         public Calendar getUserCreated () {
 241                 return this.userCreated;
 242         }
 243
 244         @Override
 245         public void setUserCreated (final Calendar userCreated) {
 246                 this.userCreated = userCreated;
 247         }
 248
 249         @Override
 250         public String getUserEncryptedPassword () {
 251                 return this.userEncryptedPassword;
 252         }
 253
 254         @Override
 255         public void setUserEncryptedPassword (final String userEncryptedPassword) {
 256                 this.userEncryptedPassword = userEncryptedPassword;
 257         }
 258
 259         @Override
 260         public Long getUserId () {
 261                 return this.userId;
 262         }
 263
 264         @Override
 265         public void setUserId (final Long userId) {
 266                 this.userId = userId;
 267         }
 268
 269         @Override
 270         public Calendar getUserLastLocked () {
 271                 return this.userLastLocked;
 272         }
 273
 274         @Override
 275         public void setUserLastLocked (final Calendar userLastLocked) {
 276                 this.userLastLocked = userLastLocked;
 277         }
 278
 279         @Override
 280         public String getUserName () {
 281                 return this.userName;
 282         }
 283
 284         @Override
 285         public void setUserName (final String userName) {
 286                 this.userName = userName;
 287         }
 288
 289         @Override
 290         public ProfileMode getUserProfileMode () {
 291                 return this.userProfileMode;
 292         }
 293
 294         @Override
 295         public void setUserProfileMode (final ProfileMode userProfileMode) {
 296                 this.userProfileMode = userProfileMode;
 297         }
 298
 299         @Override
 300         public Calendar getUserUpdated () {
 301                 return this.userUpdated;
 302         }
 303
 304         @Override
 305         public void setUserUpdated (final Calendar userUpdated) {
 306                 this.userUpdated = userUpdated;
 307         }
 308
 309         @Override
 310         public int hashCode () {
 311                 int hash = 5;
 312                 hash = 83 * hash + Objects.hashCode(this.getUserName());
 313                 hash = 83 * hash + Objects.hashCode(this.getUserId());
 314                 return hash;
 315         }
 316 }