2 * Copyright (C) 2015 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.NamedQueries;
33 import javax.persistence.NamedQuery;
34 import javax.persistence.OneToOne;
35 import javax.persistence.Table;
36 import javax.persistence.Temporal;
37 import javax.persistence.TemporalType;
38 import org.mxchange.jcontacts.contact.Contact;
39 import org.mxchange.jcontacts.contact.UserContact;
40 import org.mxchange.jusercore.model.user.status.UserAccountStatus;
43 * A generic user entity class
45 * @author Roland Haeder<roland@mxchange.org>
47 @Entity (name = "users")
52 name = "confirmation_key",
54 columnList = "user_confirm_key"
59 columnList = "user_name"
65 @NamedQuery (name = "AllUserNames", query = "SELECT DISTINCT u.userName FROM users AS u ORDER BY u.userId ASC"),
66 @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"),
67 @NamedQuery (name = "SearchUserName", query = "SELECT u FROM users AS u WHERE LOWER(u.userName) LIKE LOWER(:param)"),
68 @NamedQuery (name = "SearchUserId", query = "SELECT u FROM users AS u WHERE u.userId = :id"),
69 @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)"),
70 @NamedQuery (name = "SearchAllUsersExcept", query = "SELECT u FROM users AS u WHERE u != :user ORDER BY u.userId ASC"),
71 @NamedQuery (name = "AllPublicUsers", query = "SELECT u FROM users AS u WHERE u.userAccountStatus = :param AND u.userPublicProfile = TRUE")
74 public class LoginUser implements User {
79 private static final long serialVersionUID = 4_328_454_581_751L;
84 @Basic (optional = false)
85 @Column (name = "user_account_status", nullable = false)
86 @Enumerated (value = EnumType.STRING)
87 private UserAccountStatus userAccountStatus;
92 @Column (name = "user_confirm_key", length = 50)
93 private String userConfirmKey;
96 * Id number from "contacts" table
98 @JoinColumn (name = "user_contact_id", nullable = false, updatable = false)
99 @OneToOne (targetEntity = UserContact.class, optional = false, cascade = CascadeType.ALL)
100 private Contact userContact;
103 * "created" timestamp
105 @Basic (optional = false)
106 @Temporal (TemporalType.TIMESTAMP)
107 @Column (name = "user_created", nullable = false)
108 private Calendar userCreated;
113 @Column (name = "user_encrypted_password", nullable = false)
114 private String userEncryptedPassword;
120 @Column (name = "user_id", nullable = false, length = 20, updatable = false)
121 @GeneratedValue (strategy = GenerationType.IDENTITY)
127 @Temporal (TemporalType.TIMESTAMP)
128 @Column (name = "user_locked")
129 private Calendar userLocked;
134 @Column (name = "user_name", nullable = false, length = 20)
135 private String userName;
138 * Whether the user wants a public profile. This means that it can be viewed
139 * from the Internet by everyone (only profile, no personal data, this needs
140 * explicit agreement) and it can be found for sharing addresses with.
142 @Basic (optional = false)
143 @Column (name = "user_public_profile_flag", nullable = false)
144 private Boolean userPublicProfile;
147 * Default constructor
149 public LoginUser () {
150 // Default is not public
151 this.userPublicProfile = Boolean.FALSE;
155 public void copyAll (final User user) {
156 // Copy also contact data
157 this.getUserContact().copyAll(user.getUserContact());
160 this.setUserConfirmKey(user.getUserConfirmKey());
161 this.setUserName(user.getUserName());
162 this.setUserEncryptedPassword(user.getUserEncryptedPassword());
163 this.setUserAccountStatus(user.getUserAccountStatus());
164 this.setUserCreated(user.getUserCreated());
165 this.setUserLocked(user.getUserLocked());
169 public boolean equals (final Object object) {
170 if (object == null) {
173 if (getClass() != object.getClass()) {
177 final User other = (User) object;
179 return ((Objects.equals(this.getUserName(), other.getUserName()))
180 && (Objects.equals(this.getUserId(), other.getUserId())));
184 public UserAccountStatus getUserAccountStatus () {
185 return this.userAccountStatus;
189 public void setUserAccountStatus (final UserAccountStatus userAccountStatus) {
190 this.userAccountStatus = userAccountStatus;
194 public String getUserConfirmKey () {
195 return this.userConfirmKey;
199 public void setUserConfirmKey (final String userConfirmKey) {
200 this.userConfirmKey = userConfirmKey;
204 public Contact getUserContact () {
205 return this.userContact;
209 public void setUserContact (final Contact userContact) {
210 this.userContact = userContact;
214 public Calendar getUserCreated () {
215 return this.userCreated;
219 public void setUserCreated (final Calendar userCreated) {
220 this.userCreated = userCreated;
224 public String getUserEncryptedPassword () {
225 return this.userEncryptedPassword;
229 public void setUserEncryptedPassword (final String userEncryptedPassword) {
230 this.userEncryptedPassword = userEncryptedPassword;
234 public Long getUserId () {
239 public void setUserId (final Long userId) {
240 this.userId = userId;
244 public Calendar getUserLocked () {
245 return this.userLocked;
249 public void setUserLocked (final Calendar userLocked) {
250 this.userLocked = userLocked;
254 public String getUserName () {
255 return this.userName;
259 public void setUserName (final String userName) {
260 this.userName = userName;
264 public Boolean getUserPublicProfile () {
265 return this.userPublicProfile;
269 public void setUserPublicProfile (final Boolean userPublicProfile) {
270 this.userPublicProfile = userPublicProfile;
274 public int hashCode () {
276 hash = 83 * hash + Objects.hashCode(this.getUserName());
277 hash = 83 * hash + Objects.hashCode(this.getUserId());