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 Affero General Public License as
6 * published by the Free Software Foundation, either version 3 of the
7 * License, or (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 Affero General Public License for more details.
14 * You should have received a copy of the GNU Affero General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 package org.mxchange.jjobs.beans.user;
19 import java.io.Serializable;
20 import java.util.List;
21 import org.mxchange.jcontacts.contact.Contact;
22 import org.mxchange.jusercore.events.confirmation.UserConfirmedAccountEvent;
23 import org.mxchange.jusercore.events.login.UserLoggedInEvent;
24 import org.mxchange.jusercore.events.registration.UserRegisteredEvent;
25 import org.mxchange.jusercore.events.user.add.AdminAddedUserEvent;
26 import org.mxchange.jusercore.events.user.password_change.UpdatedUserPasswordEvent;
27 import org.mxchange.jusercore.events.user.update.AdminUpdatedUserDataEvent;
28 import org.mxchange.jusercore.events.user.update.UpdatedUserPersonalDataEvent;
29 import org.mxchange.jusercore.exceptions.UserEmailAddressNotFoundException;
30 import org.mxchange.jusercore.exceptions.UserNotFoundException;
31 import org.mxchange.jusercore.model.user.User;
32 import org.mxchange.jusercore.model.user.profilemodes.ProfileMode;
35 * An interface for user beans
37 * @author Roland Haeder<roland@mxchange.org>
39 public interface JobsUserWebSessionController extends Serializable {
42 * Minimum password length
44 public static final Integer MINIMUM_PASSWORD_LENGTH = 5;
47 * Event observer for newly added users by adminstrator
49 * @param event Event being fired
51 void afterAdminAddedUserEvent (final AdminAddedUserEvent event);
54 * Event observer for updated user data by administrator
56 * @param event Event being updated
58 void afterAdminUpdatedUserDataEvent (final AdminUpdatedUserDataEvent event);
61 * Event observer when user confirmed account.
63 * @param event Event being fired
65 void afterUserConfirmedAccount (final UserConfirmedAccountEvent event);
68 * Method being call after user's password has been updated (and history
69 * entry has been created).
71 * @param event Event being observed
73 void afterUserUpdatedPasswordEvent (final UpdatedUserPasswordEvent event);
76 * Listens to fired event when user updated personal data
78 * @param event Event being fired
80 void afterUserUpdatedPersonalData (final UpdatedUserPersonalDataEvent event);
83 * Event observer for new user registrations
85 * @param event User registration event
87 void afterRegistrationEvent (final UserRegisteredEvent event);
90 * Event observer for logged-in user
92 * @param event Event instance
94 void afterUserLogin (final UserLoggedInEvent event);
99 * @return A list of all public user profiles
101 List<User> allUsers ();
104 * All public user profiles
106 * @return A list of all public user profiles
108 List<User> allVisibleUsers ();
111 * Checks whether the given contact is a user
113 * @param contact Contact to check
115 * @return Whether the contact is a user
117 boolean isContactFound (final Contact contact);
120 * Checks whether a public user account is registered. This means that at
121 * least one user profile has its flag "public user profile" enabled.
123 * @return Whether at least one user has a public profile
125 boolean isVisibleUserFound ();
128 * Checks whether given user instance's name is used
130 * @param user User instance's name to check
132 * @return Whether it is already used
134 boolean isUserNameRegistered (final User user);
137 * Tries to lookup user by given id number. If the user is not found or the
138 * account status is not CONFIRMED proper exceptions are thrown.
140 * @param userId User id
142 * @return User instance
144 * @throws UserNotFoundException If the user is not found
146 User lookupUserById (final Long userId) throws UserNotFoundException;
149 * Tries to lookup user by given email address. If the user is not found a
150 * proper exceptions is thrown.
152 * @param emailAddress Email address
154 * @return User instance
156 * @throws UserEmailAddressNotFoundException If the user's email address is not found
158 User lookupUserByEmailAddress (final String emailAddress) throws UserEmailAddressNotFoundException;
161 * Creates an instance from all properties
163 * @param createContactData Whether contact data should be created
165 * @return A user instance
167 User createUserInstance (final boolean createContactData);
170 * Creates a user instance for login phase
172 * @return User instance
174 User createUserLogin ();
186 * @param userId User id
188 void setUserId (final Long userId);
191 * Getter for user name
195 String getUserName ();
198 * Setter for user name
200 * @param userName User name
202 void setUserName (final String userName);
205 * Getter for unencrypted user password
207 * @return Unencrypted user password
209 String getUserPassword ();
212 * Setter for unencrypted user password
214 * @param userPassword Unencrypted user password
216 void setUserPassword (final String userPassword);
219 * Getter for unencrypted user password repeated
221 * @return Unencrypted user password repeated
223 String getUserPasswordRepeat ();
226 * Setter for unencrypted user password repeated
228 * @param userPasswordRepeat Unencrypted user password repeated
230 void setUserPasswordRepeat (final String userPasswordRepeat);
233 * Getter for user profile mode
235 * @return User profile mode
237 ProfileMode getUserProfileMode ();
240 * Setter for user profile mode
242 * @param userProfileMode User profile mode
244 void setUserProfileMode (final ProfileMode userProfileMode);
247 * Checks whether all required personal data is set
249 * @return Whether the required personal data is set
251 boolean isRequiredPersonalDataSet ();
254 * Checks whether all required personal data is set for changing them
256 * @return Whether the required personal data is set
258 boolean isRequiredChangePersonalDataSet ();
261 * Checks whether same passwords has been entered
263 * @return Whether same passwords has been entered
265 boolean isSamePasswordEntered ();
268 * Checks if the user id is empty
270 * @return Whether the user id is empty
272 boolean isUserIdEmpty ();
275 * Changes logged-in user's personal data if the current password matches
276 * and TAC + privacy statement has been accepted.
278 * @return New target page
280 String doChangePersonalData ();
283 * Checks whether this application requires a user name to be entered.
284 * Otherwise a random name like "userXXXXX" is generated
286 * @return Whether this application requires a user name
288 boolean isUserNameRequired ();
291 * Checks wether public user profiles are enabled. This requires that user
292 * names are also enabled.
294 * @return Whether public user profiles are enabled
296 boolean isPublicUserProfileEnabled ();