2 * Copyright (C) 2016, 2017 Roland Häder
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.addressbook.beans.user.activity;
19 import java.text.MessageFormat;
20 import java.util.Collections;
21 import java.util.GregorianCalendar;
22 import java.util.LinkedHashMap;
23 import java.util.LinkedList;
24 import java.util.List;
26 import javax.annotation.PostConstruct;
27 import javax.enterprise.context.ApplicationScoped;
28 import javax.enterprise.event.Observes;
29 import javax.faces.view.facelets.FaceletException;
30 import javax.inject.Inject;
31 import javax.inject.Named;
32 import javax.naming.Context;
33 import javax.naming.InitialContext;
34 import javax.naming.NamingException;
35 import org.mxchange.addressbook.beans.BaseAddressbookController;
36 import org.mxchange.addressbook.beans.helper.AddressbookWebRequestHelperController;
37 import org.mxchange.jusercore.events.user.add.ObservableAdminAddedUserEvent;
38 import org.mxchange.jusercore.events.user.created.ObservableCreatedUserEvent;
39 import org.mxchange.jusercore.events.user.delete.ObservableAdminDeletedUserEvent;
40 import org.mxchange.jusercore.events.user.linked.ObservableAdminLinkedUserEvent;
41 import org.mxchange.jusercore.events.user.locked.ObservableAdminLockedUserEvent;
42 import org.mxchange.jusercore.events.user.unlocked.ObservableAdminUnlockedUserEvent;
43 import org.mxchange.jusercore.events.user.update.ObservableAdminUpdatedUserDataEvent;
44 import org.mxchange.jusercore.events.user.update.ObservableUpdatedUserPersonalDataEvent;
45 import org.mxchange.jusercore.model.user.User;
46 import org.mxchange.jusercore.model.user.activity.LogableUserActivity;
47 import org.mxchange.jusercore.model.user.activity.UserActivityLog;
48 import org.mxchange.jusercore.model.user.activity.UserActivityLogSessionBeanRemote;
49 import org.mxchange.jusercore.model.user.activity.comparator.UserActivityLogTimestampComparator;
50 import org.mxchange.juserlogincore.events.confirmation.ObservableUserConfirmedAccountEvent;
51 import org.mxchange.juserlogincore.events.login.ObservableUserLoggedInEvent;
52 import org.mxchange.juserlogincore.events.logout.ObservableUserLogoutEvent;
53 import org.mxchange.juserlogincore.events.registration.ObservableUserRegisteredEvent;
54 import org.mxchange.juserlogincore.events.resendlink.ObservableUserResendLinkAccountEvent;
55 import org.mxchange.juserlogincore.events.user.password_change.ObservableUpdatedUserPasswordEvent;
58 * A controller (bean) for user activity log
60 * @author Roland Häder<roland@mxchange.org>
62 @Named ("userActivityController")
64 public class AddressbookUserActivityWebApplicationBean extends BaseAddressbookController implements AddressbookUserActivityWebApplicationController {
69 private static final long serialVersionUID = 192_586_376_717_856_904L;
75 private AddressbookWebRequestHelperController beanHelper;
83 * EJB for user activity log
85 private UserActivityLogSessionBeanRemote userActivityBean;
88 * "Cache" for activity log per user
90 private final Map<User, List<LogableUserActivity>> usersActivity;
95 @SuppressWarnings ("CollectionWithoutInitialCapacity")
96 public AddressbookUserActivityWebApplicationBean () {
97 // Try to get EJB instance
99 // Get initial context
100 Context context = new InitialContext();
103 this.userActivityBean = (UserActivityLogSessionBeanRemote) context.lookup("java:global/addressbook-ejb/userActivity!org.mxchange.jusercore.model.user.activity.UserActivityLogSessionBeanRemote"); //NOI18N
104 } catch (final NamingException e) {
106 throw new FaceletException(e);
110 this.usersActivity = new LinkedHashMap<>();
114 * Adds user activity entry with given type
116 * @param user User instance
117 * @param activityType Activity type
119 private void addUserActivity (final User user, final String activityType) {
120 // Better re-validate
123 throw new NullPointerException("user is null"); //NOI18N
124 } else if (user.getUserId() == null) {
126 throw new NullPointerException("user.userId is null"); //NOI18N
127 } else if (user.getUserId() < 1) {
129 throw new IllegalArgumentException(MessageFormat.format("user.userId={0} is not valid", user.getUserId())); //NOI18N
130 } else if (null == activityType) {
132 throw new NullPointerException("activityType is null"); //NOI18N
133 } else if (activityType.isEmpty()) {
135 throw new IllegalArgumentException("activityType is empty"); //NOI18N
138 // Create new activity object
139 LogableUserActivity userActivity = new UserActivityLog(activityType, user, new GregorianCalendar(), this.determinePrincipalName());
141 // Call bean to add it
142 this.userActivityBean.addUserActivityLog(userActivity);
145 this.addUserActivityToCache(userActivity);
149 * Adds user activity log with type and message
151 * @param user User instance
152 * @param activityType Activity type
153 * @param message Activity message
155 private void addUserActivity (final User user, final String activityType, final String message) {
156 // Better re-validate
159 throw new NullPointerException("user is null"); //NOI18N
160 } else if (user.getUserId() == null) {
162 throw new NullPointerException("user.userId is null"); //NOI18N
163 } else if (user.getUserId() < 1) {
165 throw new IllegalArgumentException(MessageFormat.format("user.userId={0} is not valid", user.getUserId())); //NOI18N
166 } else if (null == activityType) {
168 throw new NullPointerException("activityType is null"); //NOI18N
169 } else if (activityType.isEmpty()) {
171 throw new IllegalArgumentException("activityType is empty"); //NOI18N
172 } else if (null == message) {
174 throw new NullPointerException("message is null"); //NOI18N
175 } else if (message.isEmpty()) {
177 throw new IllegalArgumentException("message is empty"); //NOI18N
180 // Create new activity object
181 LogableUserActivity userActivity = new UserActivityLog(message, activityType, user, new GregorianCalendar(), this.determinePrincipalName());
183 // Call bean to add it
184 this.userActivityBean.addUserActivityLog(userActivity);
187 this.addUserActivityToCache(userActivity);
191 * Event observer for newly added users by administrator
193 * @param event Event being fired
195 public void afterAdminAddedUserEvent (@Observes final ObservableAdminAddedUserEvent event) {
196 // event should not be null
199 throw new NullPointerException("event is null"); //NOI18N
200 } else if (event.getAddedUser() == null) {
202 throw new NullPointerException("event.addedUser is null"); //NOI18N
203 } else if (event.getAddedUser().getUserId() == null) {
205 throw new NullPointerException("event.addedUser.userId is null"); //NOI18N
206 } else if (event.getAddedUser().getUserId() < 1) {
208 throw new IllegalArgumentException(MessageFormat.format("userId of user={0} is not valid: {1}", event.getAddedUser(), event.getAddedUser().getUserId())); //NOI18N
212 this.addUserActivity(event.getAddedUser(), "ADMIN_ADDED_USER_ACCOUNT"); //NOI18N
216 * Event observer for deleted user accounts (by administrator)
218 * @param event Event being fired
220 public void afterAdminDeletedUserEvent (@Observes final ObservableAdminDeletedUserEvent event) {
221 // event should not be null
224 throw new NullPointerException("event is null"); //NOI18N
225 } else if (event.getDeletedUser() == null) {
227 throw new NullPointerException("event.deletedUser is null"); //NOI18N
228 } else if (event.getDeletedUser().getUserId() == null) {
230 throw new NullPointerException("event.deletedUser.userId is null"); //NOI18N
231 } else if (event.getDeletedUser().getUserId() < 1) {
233 throw new IllegalArgumentException(MessageFormat.format("userId of user={0} is not valid: {1}", event.getDeletedUser(), event.getDeletedUser().getUserId())); //NOI18N
237 this.addUserActivity(event.getDeletedUser(), "ADMIN_DELETED_USER_ACCOUNT", event.getUserDeleteReason()); //NOI18N
241 * Event observer for linked users with existing contact data
243 * @param event Event being fired
245 public void afterAdminLinkedUserEvent (@Observes final ObservableAdminLinkedUserEvent event) {
246 // event should not be null
249 throw new NullPointerException("event is null"); //NOI18N
250 } else if (event.getLinkedUser() == null) {
252 throw new NullPointerException("event.linkedUser is null"); //NOI18N
253 } else if (event.getLinkedUser().getUserId() == null) {
255 throw new NullPointerException("event.linkedUser.userId is null"); //NOI18N
256 } else if (event.getLinkedUser().getUserId() < 1) {
258 throw new IllegalArgumentException(MessageFormat.format("userId of user={0} is not valid: {1}", event.getLinkedUser(), event.getLinkedUser().getUserId())); //NOI18N
262 this.addUserActivity(event.getLinkedUser(), "ADMIN_LINKED_USER_ACCOUNT"); //NOI18N
266 * Event observer for locked users
268 * @param event Event being fired
270 public void afterAdminLockedUserEvent (@Observes final ObservableAdminLockedUserEvent event) {
271 // event should not be null
274 throw new NullPointerException("event is null"); //NOI18N
275 } else if (event.getLockedUser() == null) {
277 throw new NullPointerException("event.lockedUser is null"); //NOI18N
278 } else if (event.getLockedUser().getUserId() == null) {
280 throw new NullPointerException("event.lockedUser.userId is null"); //NOI18N
281 } else if (event.getLockedUser().getUserId() < 1) {
283 throw new IllegalArgumentException(MessageFormat.format("userId of user={0} is not valid: {1}", event.getLockedUser(), event.getLockedUser().getUserId())); //NOI18N
287 this.addUserActivity(event.getLockedUser(), "ADMIN_LOCKED_USER_ACCOUNT", event.getLockedUser().getUserLastLockedReason()); //NOI18N
291 * Event observer for unlocked users
293 * @param event Event being fired
295 public void afterAdminUnlockedUserEvent (@Observes final ObservableAdminUnlockedUserEvent event) {
296 // event should not be null
299 throw new NullPointerException("event is null"); //NOI18N
300 } else if (event.getUnlockedUser() == null) {
302 throw new NullPointerException("event.unlockedUser is null"); //NOI18N
303 } else if (event.getUnlockedUser().getUserId() == null) {
305 throw new NullPointerException("event.unlockedUser.userId is null"); //NOI18N
306 } else if (event.getUnlockedUser().getUserId() < 1) {
308 throw new IllegalArgumentException(MessageFormat.format("userId of user={0} is not valid: {1}", event.getUnlockedUser(), event.getUnlockedUser().getUserId())); //NOI18N
312 this.addUserActivity(event.getUnlockedUser(), "ADMIN_UNLOCKED_USER_ACCOUNT"); //NOI18N
316 * Event observer for updated user data by administrator
318 * @param event Event being updated
320 public void afterAdminUpdatedUserDataEvent (@Observes final ObservableAdminUpdatedUserDataEvent event) {
321 // event should not be null
324 throw new NullPointerException("event is null"); //NOI18N
325 } else if (event.getUpdatedUser() == null) {
327 throw new NullPointerException("event.updatedUser is null"); //NOI18N
328 } else if (event.getUpdatedUser().getUserId() == null) {
330 throw new NullPointerException("event.updatedUser.userId is null"); //NOI18N
331 } else if (event.getUpdatedUser().getUserId() < 1) {
333 throw new IllegalArgumentException(MessageFormat.format("userId of user={0} is not valid: {1}", event.getUpdatedUser(), event.getUpdatedUser().getUserId())); //NOI18N
337 this.addUserActivity(event.getUpdatedUser(), "ADMIN_UPDATED_USER_PERSONAL_DATA"); //NOI18N
341 * Event observer for when a bean helper has successfully created a user
342 * instance, means the user exists. If the user does not exist, this event
343 * should not fire but instead a proper exception must be thrown.
345 * @param event User created event
347 public void afterCreatedUserEvent (@Observes final ObservableCreatedUserEvent event) {
348 // Is the instance valid?
351 throw new NullPointerException("event is null"); //NOI18N
352 } else if (event.getCreatedUser() == null) {
354 throw new NullPointerException("event.createdUser is null"); //NOI18N
355 } else if (event.getCreatedUser().getUserId() == null) {
357 throw new NullPointerException("event.createdUser.userId is null"); //NOI18N
358 } else if (event.getCreatedUser().getUserId() < 1) {
360 throw new NullPointerException(MessageFormat.format("event.createdUser.userId={0} is not valid", event.getCreatedUser().getUserId())); //NOI18N
364 this.setUser(event.getCreatedUser());
368 * Event observer when user confirmed account.
370 * @param event Event being fired
372 public void afterUserConfirmedAccountEvent (@Observes final ObservableUserConfirmedAccountEvent event) {
373 // event should not be null
376 throw new NullPointerException("event is null"); //NOI18N
377 } else if (event.getConfirmedUser() == null) {
379 throw new NullPointerException("event.confirmedUser is null"); //NOI18N
380 } else if (event.getConfirmedUser().getUserId() == null) {
382 throw new NullPointerException("event.confirmedUser.userId is null"); //NOI18N
383 } else if (event.getConfirmedUser().getUserId() < 1) {
385 throw new IllegalArgumentException(MessageFormat.format("userId of user={0} is not valid: {1}", event.getConfirmedUser(), event.getConfirmedUser().getUserId())); //NOI18N
389 this.addUserActivity(event.getConfirmedUser(), "USER_CONFIRMED_ACCOUNT"); //NOI18N
393 * Event observer for logged-in user
395 * @param event Event being fired
397 public void afterUserLoginEvent (@Observes final ObservableUserLoggedInEvent event) {
398 // event should not be null
401 throw new NullPointerException("event is null"); //NOI18N
402 } else if (event.getLoggedInUser() == null) {
404 throw new NullPointerException("event.registeredUser is null"); //NOI18N
405 } else if (event.getLoggedInUser().getUserId() == null) {
407 throw new NullPointerException("event.registeredUser.userId is null"); //NOI18N
408 } else if (event.getLoggedInUser().getUserId() < 1) {
410 throw new IllegalArgumentException(MessageFormat.format("userId of user={0} is not valid: {1}", event.getLoggedInUser(), event.getLoggedInUser().getUserId())); //NOI18N
413 // Copy all data to this bean
414 this.addUserActivity(event.getLoggedInUser(), "USER_LOGGED_IN"); //NOI18N
418 * Event observer for logged-out user
420 * @param event Event instance
422 public void afterUserLogoutEvent (@Observes final ObservableUserLogoutEvent event) {
423 // event should not be null
426 throw new NullPointerException("event is null"); //NOI18N
427 } else if (event.getLoggedOutUser() == null) {
429 throw new NullPointerException("event.loggedOutUser is null"); //NOI18N
430 } else if (event.getLoggedOutUser().getUserId() == null) {
432 throw new NullPointerException("event.loggedOutUser.userId is null"); //NOI18N
433 } else if (event.getLoggedOutUser().getUserId() < 1) {
435 throw new IllegalArgumentException(MessageFormat.format("userId of user={0} is not valid: {1}", event.getLoggedOutUser(), event.getLoggedOutUser().getUserId())); //NOI18N
439 this.addUserActivity(event.getLoggedOutUser(), "USER_LOGGED_OUT"); //NOI18N
443 * Event observer for new user registrations
445 * @param event Event being fired
447 public void afterUserRegistrationEvent (@Observes final ObservableUserRegisteredEvent event) {
448 // event should not be null
451 throw new NullPointerException("event is null"); //NOI18N
452 } else if (event.getRegisteredUser() == null) {
454 throw new NullPointerException("event.registeredUser is null"); //NOI18N
455 } else if (event.getRegisteredUser().getUserId() == null) {
457 throw new NullPointerException("event.registeredUser.userId is null"); //NOI18N
458 } else if (event.getRegisteredUser().getUserId() < 1) {
460 throw new IllegalArgumentException(MessageFormat.format("userId of user={0} is not valid: {1}", event.getRegisteredUser(), event.getRegisteredUser().getUserId())); //NOI18N
464 this.addUserActivity(event.getRegisteredUser(), "USER_REGISTERED_NEW_ACCOUNT"); //NOI18N
468 * Event observer for users resending their confirmation link
470 * @param event Event being fired
472 public void afterUserResendConfirmationLinkEvent (@Observes final ObservableUserResendLinkAccountEvent event) {
473 // event should not be null
476 throw new NullPointerException("event is null"); //NOI18N
477 } else if (event.getResendLinkUser() == null) {
479 throw new NullPointerException("event.resendLinkUser is null"); //NOI18N
480 } else if (event.getResendLinkUser().getUserId() == null) {
482 throw new NullPointerException("event.resendLinkUser.userId is null"); //NOI18N
483 } else if (event.getResendLinkUser().getUserId() < 1) {
485 throw new IllegalArgumentException(MessageFormat.format("userId of user={0} is not valid: {1}", event.getResendLinkUser(), event.getResendLinkUser().getUserId())); //NOI18N
488 // Copy all data to this bean
489 this.addUserActivity(event.getResendLinkUser(), "USER_RESEND_CONFIRMATION_LINK"); //NOI18N
493 * Method being call after user's password has been updated (and history
494 * entry has been created).
496 * @param event Event being observed
498 public void afterUserUpdatedPasswordEvent (@Observes final ObservableUpdatedUserPasswordEvent event) {
502 throw new NullPointerException("event is null"); //NOI18N
503 } else if (event.getPasswordHistory() == null) {
505 throw new NullPointerException("event.passwordHistory is null"); //NOI18N
506 } else if (event.getPasswordHistory().getUserPasswordHistoryId() == null) {
508 throw new NullPointerException("event.passwordHistory.userPasswordHistoryId is null"); //NOI18N
509 } else if (event.getPasswordHistory().getUserPasswordHistoryId() < 1) {
511 throw new IllegalArgumentException(MessageFormat.format("event.passwordHistory.userPasswordHistoryId={0} is in valid", event.getPasswordHistory().getUserPasswordHistoryId())); //NOI18N
515 this.addUserActivity(event.getPasswordHistory().getUserPasswordHistoryUser(), "USER_UPDATED_PASSWORD"); //NOI18N
519 * Listens to fired event when user updated personal data
521 * @param event Event being fired
523 public void afterUserUpdatedPersonalDataEvent (@Observes final ObservableUpdatedUserPersonalDataEvent event) {
527 throw new NullPointerException("event is null"); //NOI18N
528 } else if (event.getUpdatedUser() == null) {
530 throw new NullPointerException("event.updatedUser is null"); //NOI18N
531 } else if (event.getUpdatedUser().getUserId() == null) {
533 throw new NullPointerException("event.updatedUser.userId is null"); //NOI18N
534 } else if (event.getUpdatedUser().getUserId() < 1) {
536 throw new IllegalArgumentException(MessageFormat.format("event.updatedUser.userId={0} is in valid", event.getUpdatedUser().getUserId())); //NOI18N
540 this.addUserActivity(event.getUpdatedUser(), "USER_UPDATED_PERSONAL_DATA"); //NOI18N
544 * Expands given activity type into a i18n string for administrators
546 * @param activityType Activity type
548 * @return Expanded i18n string
550 public String expandAdminActivityType (final String activityType) {
552 if (null == activityType) {
554 throw new NullPointerException("activityType is null"); //NOI18N
555 } else if (activityType.isEmpty()) {
557 throw new IllegalArgumentException("activityType is empty"); //NOI18N
561 return "ADMIN_ACTIVITY_" + activityType; //NOI18N
565 * Expands given activity type into a i18n string for users
567 * @param activityType Activity type
569 * @return Expanded i18n string
571 public String expandUserActivityType (final String activityType) {
573 if (null == activityType) {
575 throw new NullPointerException("activityType is null"); //NOI18N
576 } else if (activityType.isEmpty()) {
578 throw new IllegalArgumentException("activityType is empty"); //NOI18N
582 return "USER_ACTIVITY_" + activityType; //NOI18N
586 * Returns a list of in beanHelper set user instance's activity log
588 * @return List of user's activity log
590 public List<LogableUserActivity> fetchCurrentUsersActivityLog () {
591 // beanHelper.user should be set and valid
592 if (this.getUser() == null) {
594 throw new NullPointerException("this.beanHelper.user is null"); //NOI18N
595 } else if (this.getUser().getUserId() == null) {
597 throw new NullPointerException("this.beanHelper.user.userId is null"); //NOI18N
598 } else if (this.getUser().getUserId() < 1) {
600 throw new IllegalArgumentException(MessageFormat.format("this.beanHelper.user.userId={0} is not valid", this.getUser().getUserId())); //NOI18N
604 List<LogableUserActivity> list = new LinkedList<>();
607 if (this.usersActivity.containsKey(this.getUser())) {
609 list.addAll(this.usersActivity.get(this.getUser()));
611 // Sort list and reverse it
612 Collections.sort(list, new UserActivityLogTimestampComparator());
613 Collections.reverse(list);
621 * Getter for user instance
623 * @return User instance
625 public User getUser () {
630 * Setter for user instance
632 * @param user User instance
634 public void setUser (final User user) {
639 * Post-constructor method
642 public void init () {
644 List<LogableUserActivity> list = this.userActivityBean.fetchAllUserActivityLog();
646 // Put all in map, per-user
647 for (final LogableUserActivity userActivity : list) {
648 // Is the list there?
649 if (!this.usersActivity.containsKey(userActivity.getActivityUser())) {
651 this.usersActivity.put(userActivity.getActivityUser(), new LinkedList<LogableUserActivity>());
654 // Add by user instance
655 boolean added = this.usersActivity.get(userActivity.getActivityUser()).add(userActivity);
658 assert (added) : "Activity log not added"; //NOI18N
663 * Adds given user activity instance to "cache" (local map)
665 * @param userActivity User activity instance
667 private void addUserActivityToCache (final LogableUserActivity userActivity) {
668 // Is the instance valid
669 if (null == userActivity) {
671 throw new NullPointerException("userActivity is null");
672 } else if (userActivity.getActivityId() instanceof Long) {
674 throw new IllegalArgumentException("userActivity.activityId=" + userActivity.getActivityId() + " is not null");
675 } else if (userActivity.getActivityUser() == null) {
677 throw new NullPointerException("userActivity.activityUser is null");
678 } else if (userActivity.getActivityUser().getUserId() == null) {
680 throw new NullPointerException("userActivity.activityUser.userId is null");
681 } else if (userActivity.getActivityUser().getUserId() < 1) {
683 throw new IllegalArgumentException("userActivity.activityUser.userId=" + userActivity.getActivityUser().getUserId() + " is not valid");
687 if (!this.usersActivity.containsKey(userActivity.getActivityUser())) {
689 this.usersActivity.put(userActivity.getActivityUser(), new LinkedList<LogableUserActivity>());
692 // Add activity to log
693 this.usersActivity.get(userActivity.getActivityUser()).add(userActivity);