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 = "AllUsers", query = "SELECT u FROM users AS u ORDER BY u.userId ASC"),
74 @NamedQuery (name = "AllPublicUsers", query = "SELECT u FROM users AS u WHERE u.userAccountStatus = :status AND u.userProfileMode = :mode ORDER BY u.userId ASC"),
75 @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")
78 @SuppressWarnings ("PersistenceUnitPresent")
79 public class LoginUser implements User {
84 private static final long serialVersionUID = 4_328_454_581_751L;
89 @Basic (optional = false)
90 @Column (name = "user_account_status", nullable = false)
91 @Enumerated (value = EnumType.STRING)
92 private UserAccountStatus userAccountStatus;
97 @Column (name = "user_confirm_key", length = 50)
98 private String userConfirmKey;
101 * Id number from "contacts" table
103 @JoinColumn (name = "user_contact_id", referencedColumnName = "contact_id", nullable = false, updatable = false, unique = true)
104 @OneToOne (targetEntity = UserContact.class, cascade = CascadeType.ALL, optional = false)
105 private Contact userContact;
108 * "created" timestamp
110 @Basic (optional = false)
111 @Temporal (TemporalType.TIMESTAMP)
112 @Column (name = "user_created", nullable = false)
113 private Calendar userCreated;
118 @Basic (optional = false)
119 @Column (name = "user_encrypted_password", nullable = false)
120 private String userEncryptedPassword;
126 @Column (name = "user_id", nullable = false, length = 20, updatable = false)
127 @GeneratedValue (strategy = GenerationType.IDENTITY)
131 * Last "locked" timestamp
133 @Temporal (TemporalType.TIMESTAMP)
134 @Column (name = "user_last_locked_timestamp")
135 private Calendar userLastLocked;
141 @Column (name = "user_last_locked_reason")
142 private String userLastLockedReason;
147 @Basic (optional = false)
148 @Column (name = "user_name", nullable = false, length = 20)
149 private String userName;
152 * Profile mode of this user
154 @Basic (optional = false)
155 @Enumerated (EnumType.STRING)
156 @Column (name = "user_profile_mode", nullable = false)
157 private ProfileMode userProfileMode;
160 * When this user has been updated
162 @Temporal (TemporalType.TIMESTAMP)
163 @Column (name = "user_updated")
164 private Calendar userUpdated;
167 * Default constructor
169 public LoginUser () {
170 // Default is invisible
171 this.userProfileMode = ProfileMode.INVISIBLE;
175 public void copyAll (final User user) {
177 if (user.getUserContact() instanceof Contact) {
178 // Copy also contact data
179 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 (null == object) {
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 UserAccountStatus getUserAccountStatus () {
208 return this.userAccountStatus;
212 public void setUserAccountStatus (final UserAccountStatus userAccountStatus) {
213 this.userAccountStatus = userAccountStatus;
217 public String getUserConfirmKey () {
218 return this.userConfirmKey;
222 public void setUserConfirmKey (final String userConfirmKey) {
223 this.userConfirmKey = userConfirmKey;
227 public Contact getUserContact () {
228 return this.userContact;
232 public void setUserContact (final Contact userContact) {
233 this.userContact = userContact;
237 @SuppressWarnings ("ReturnOfDateField")
238 public Calendar getUserCreated () {
239 return this.userCreated;
243 @SuppressWarnings ("ReturnOfDateField")
244 public void setUserCreated (final Calendar userCreated) {
245 this.userCreated = userCreated;
249 public String getUserEncryptedPassword () {
250 return this.userEncryptedPassword;
254 public void setUserEncryptedPassword (final String userEncryptedPassword) {
255 this.userEncryptedPassword = userEncryptedPassword;
259 public Long getUserId () {
264 public void setUserId (final Long userId) {
265 this.userId = userId;
269 @SuppressWarnings ("ReturnOfDateField")
270 public Calendar getUserLastLocked () {
271 return this.userLastLocked;
275 @SuppressWarnings ("AssignmentToDateFieldFromParameter")
276 public void setUserLastLocked (final Calendar userLastLocked) {
277 this.userLastLocked = userLastLocked;
281 public String getUserLastLockedReason () {
282 return this.userLastLockedReason;
286 public void setUserLastLockedReason (final String userLastLockedReason) {
287 this.userLastLockedReason = userLastLockedReason;
291 public String getUserName () {
292 return this.userName;
296 public void setUserName (final String userName) {
297 this.userName = userName;
301 public ProfileMode getUserProfileMode () {
302 return this.userProfileMode;
306 public void setUserProfileMode (final ProfileMode userProfileMode) {
307 this.userProfileMode = userProfileMode;
311 @SuppressWarnings ("ReturnOfDateField")
312 public Calendar getUserUpdated () {
313 return this.userUpdated;
317 @SuppressWarnings ("AssignmentToDateFieldFromParameter")
318 public void setUserUpdated (final Calendar userUpdated) {
319 this.userUpdated = userUpdated;
323 public int hashCode () {
325 hash = 83 * hash + Objects.hashCode(this.getUserName());
326 hash = 83 * hash + Objects.hashCode(this.getUserId());