2 * Copyright (C) 2016 Roland Haeder
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.
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.
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/>.
17 package org.mxchange.jusercore.model.user;
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;
45 * A generic user entity class
47 * @author Roland Haeder<roland@mxchange.org>
49 @Entity (name = "users")
54 name = "confirmation_key",
56 columnList = "user_confirm_key"
61 columnList = "user_name"
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")
77 public class LoginUser implements User, Comparable<User> {
82 private static final long serialVersionUID = 4_328_454_581_751L;
88 @Column (name = "user_last_locked_reason")
89 private String lastLockedReason;
94 @Basic (optional = false)
95 @Column (name = "user_account_status", nullable = false)
96 @Enumerated (value = EnumType.STRING)
97 private UserAccountStatus userAccountStatus;
102 @Column (name = "user_confirm_key", length = 50)
103 private String userConfirmKey;
106 * Id number from "contacts" table
108 @JoinColumn (name = "user_contact_id", referencedColumnName = "contact_id", nullable = false, updatable = false, unique = true)
109 @OneToOne (targetEntity = UserContact.class, cascade = CascadeType.ALL, optional = false)
110 private Contact userContact;
113 * "created" timestamp
115 @Basic (optional = false)
116 @Temporal (TemporalType.TIMESTAMP)
117 @Column (name = "user_created", nullable = false)
118 private Calendar userCreated;
123 @Basic (optional = false)
124 @Column (name = "user_encrypted_password", nullable = false)
125 private String userEncryptedPassword;
131 @Column (name = "user_id", nullable = false, length = 20, updatable = false)
132 @GeneratedValue (strategy = GenerationType.IDENTITY)
136 * Last "locked" timestamp
138 @Temporal (TemporalType.TIMESTAMP)
139 @Column (name = "user_last_locked_timestamp")
140 private Calendar userLastLocked;
145 @Basic (optional = false)
146 @Column (name = "user_name", nullable = false, length = 20)
147 private String userName;
150 * Profile mode of this user
152 @Basic (optional = false)
153 @Enumerated (EnumType.STRING)
154 @Column (name = "user_profile_mode", nullable = false)
155 private ProfileMode userProfileMode;
158 * When this user has been updated
160 @Temporal (TemporalType.TIMESTAMP)
161 @Column (name = "user_updated")
162 private Calendar userUpdated;
165 * Default constructor
167 public LoginUser () {
168 // Default is invisible
169 this.userProfileMode = ProfileMode.INVISIBLE;
173 public int compareTo (final User user) {
174 throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
178 public void copyAll (final User user) {
179 // Copy also contact data
180 this.getUserContact().copyAll(user.getUserContact());
183 this.setUserConfirmKey(user.getUserConfirmKey());
184 this.setUserName(user.getUserName());
185 this.setUserEncryptedPassword(user.getUserEncryptedPassword());
186 this.setUserAccountStatus(user.getUserAccountStatus());
187 this.setUserCreated(user.getUserCreated());
188 this.setUserLastLocked(user.getUserLastLocked());
192 public boolean equals (final Object object) {
193 if (object == null) {
196 if (this.getClass() != object.getClass()) {
200 final User other = (User) object;
202 return ((Objects.equals(this.getUserName(), other.getUserName())) &&
203 (Objects.equals(this.getUserId(), other.getUserId())));
207 public int hashCode () {
209 hash = 83 * hash + Objects.hashCode(this.getUserName());
210 hash = 83 * hash + Objects.hashCode(this.getUserId());
215 public String getLastLockedReason () {
216 return this.lastLockedReason;
220 public void setLastLockedReason (final String lastLockedReason) {
221 this.lastLockedReason = lastLockedReason;
225 public UserAccountStatus getUserAccountStatus () {
226 return this.userAccountStatus;
230 public void setUserAccountStatus (final UserAccountStatus userAccountStatus) {
231 this.userAccountStatus = userAccountStatus;
235 public String getUserConfirmKey () {
236 return this.userConfirmKey;
240 public void setUserConfirmKey (final String userConfirmKey) {
241 this.userConfirmKey = userConfirmKey;
245 public Contact getUserContact () {
246 return this.userContact;
250 public void setUserContact (final Contact userContact) {
251 this.userContact = userContact;
255 public Calendar getUserCreated () {
256 return this.userCreated;
260 public void setUserCreated (final Calendar userCreated) {
261 this.userCreated = userCreated;
265 public String getUserEncryptedPassword () {
266 return this.userEncryptedPassword;
270 public void setUserEncryptedPassword (final String userEncryptedPassword) {
271 this.userEncryptedPassword = userEncryptedPassword;
275 public Long getUserId () {
280 public void setUserId (final Long userId) {
281 this.userId = userId;
285 public Calendar getUserLastLocked () {
286 return this.userLastLocked;
290 public void setUserLastLocked (final Calendar userLastLocked) {
291 this.userLastLocked = userLastLocked;
295 public String getUserName () {
296 return this.userName;
300 public void setUserName (final String userName) {
301 this.userName = userName;
305 public ProfileMode getUserProfileMode () {
306 return this.userProfileMode;
310 public void setUserProfileMode (final ProfileMode userProfileMode) {
311 this.userProfileMode = userProfileMode;
315 public Calendar getUserUpdated () {
316 return this.userUpdated;
320 public void setUserUpdated (final Calendar userUpdated) {
321 this.userUpdated = userUpdated;