src/java/org/mxchange/jjobs/beans/addressbook/JobsAddressbookWebSessionBean.java

   1 /*
   2  * Copyright (C) 2016, 2017 Roland Häder
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17 package org.mxchange.jjobs.beans.addressbook;
  18
  19 import java.text.MessageFormat;
  20 import java.util.Calendar;
  21 import java.util.Collections;
  22 import java.util.LinkedList;
  23 import java.util.List;
  24 import java.util.Objects;
  25 import javax.annotation.PostConstruct;
  26 import javax.enterprise.context.SessionScoped;
  27 import javax.enterprise.event.Event;
  28 import javax.enterprise.event.Observes;
  29 import javax.enterprise.inject.Any;
  30 import javax.faces.view.facelets.FaceletException;
  31 import javax.inject.Inject;
  32 import javax.inject.Named;
  33 import javax.naming.Context;
  34 import javax.naming.InitialContext;
  35 import javax.naming.NamingException;
  36 import org.mxchange.addressbook.model.addressbook.AddressbookSessionBeanRemote;
  37 import org.mxchange.jaddressbook.events.addressbook.AddressbookLoadedEvent;
  38 import org.mxchange.jaddressbook.events.addressbook.ObservableAddressbookLoadedEvent;
  39 import org.mxchange.jaddressbook.exceptions.AddressbookNameAlreadyUsedException;
  40 import org.mxchange.jaddressbook.exceptions.AddressbookNotFoundException;
  41 import org.mxchange.jaddressbook.model.addressbook.Addressbook;
  42 import org.mxchange.jaddressbook.model.addressbook.UserAddressbook;
  43 import org.mxchange.jaddressbook.model.addressbook.entry.AddressbookEntry;
  44 import org.mxchange.jjobs.beans.BaseJobsController;
  45 import org.mxchange.jjobs.beans.user.login.JobsUserLoginWebSessionController;
  46 import org.mxchange.jusercore.model.user.User;
  47 import org.mxchange.juserlogincore.events.login.ObservableUserLoggedInEvent;
  48
  49 /**
  50  * An address book bean (controller)
  51  * <p>
  52  * @author Roland Häder<roland@mxchange.org>
  53  */
  54 @Named ("addressbookController")
  55 @SessionScoped
  56 public class JobsAddressbookWebSessionBean extends BaseJobsController implements JobsAddressbookWebSessionController {
  57
  58         /**
  59          * Serial number
  60          */
  61         private static final long serialVersionUID = 185_781_756_712_969L;
  62
  63         /**
  64          * Address book instance
  65          */
  66         private Addressbook addressbook;
  67
  68         /**
  69          * Remote address book bean
  70          */
  71         private AddressbookSessionBeanRemote addressbookBean;
  72
  73         /**
  74          * When this address book has been created
  75          */
  76         private Calendar addressbookCreated;
  77
  78         /**
  79          * Address book id number (from URL for example)
  80          */
  81         private Long addressbookId;
  82
  83         /**
  84          * Name of the address book
  85          */
  86         private String addressbookName;
  87
  88         /**
  89          * Who owns this address book
  90          */
  91         private User addressbookUser;
  92
  93         /**
  94          * Event fired when user has logged in
  95          */
  96         @Inject
  97         @Any
  98         private Event<ObservableAddressbookLoadedEvent> loadedEvent;
  99
 100         /**
 101          * Login controller
 102          */
 103         @Inject
 104         private JobsUserLoginWebSessionController userLoginController;
 105
 106         /**
 107          * A list of all user's address books
 108          */
 109         private List<Addressbook> usersAddressbooks;
 110
 111         /**
 112          * Default constructor
 113          */
 114         public JobsAddressbookWebSessionBean () {
 115                 // Call super constructor
 116                 super();
 117         }
 118
 119         @Override
 120         public String addAddressbook () {
 121                 // Is this name already used?
 122                 if (!this.userLoginController.isUserLoggedIn()) {
 123                         // Not logged in
 124                         throw new FaceletException("This method can only be called as logged-in user."); //NOI18N
 125                 } else if (this.getAddressbookName() == null) {
 126                         // Address book name is null
 127                         throw new NullPointerException("addressbookName is null"); //NOI18N
 128                 } else if (this.getAddressbookName().isEmpty()) {
 129                         // Address book name is empty
 130                         throw new IllegalStateException("addressbookName is empty."); //NOI18N
 131                 } else if (this.isAddressbookNameUsed(this.getAddressbookName())) {
 132                         // Already used by this user
 133                         throw new FaceletException(MessageFormat.format("Address book name {0} already used.", this.getAddressbookName())); //NOI18N
 134                 }
 135
 136                 // Create address book instance with name
 137                 Addressbook book = new UserAddressbook(this.getAddressbookName(), this.userLoginController.getLoggedInUser());
 138
 139                 try {
 140                         // Register this address book
 141                         Addressbook updatedAddressbook = this.addressbookBean.createAddressbook(book);
 142
 143                         // Remove name
 144                         this.setAddressbookName(null);
 145
 146                         // Add address book entry to list
 147                         this.usersAddressbooks.add(updatedAddressbook);
 148
 149                         // All fine
 150                         return "login_own_addressbooks"; //NOI18N
 151                 } catch (final AddressbookNameAlreadyUsedException ex) {
 152                         // Throw again as cause
 153                         throw new FaceletException(ex);
 154                 }
 155         }
 156
 157         @Override
 158         public void afterAddressbookLoadedEvent (@Observes final ObservableAddressbookLoadedEvent event) {
 159                 // event should not be null
 160                 if (null == event) {
 161                         // Throw NPE
 162                         throw new NullPointerException("event is null"); //NOI18N
 163                 } else if (event.getAddressbook() == null) {
 164                         // Throw NPE again
 165                         throw new NullPointerException("event.addressbook is null"); //NOI18N
 166                 } else if (event.getAddressbook().getAddressbookId() == null) {
 167                         // And again a NPE
 168                         throw new NullPointerException("event.addressbook.addressbookId is null"); //NOI18N
 169                 } else if (event.getAddressbook().getAddressbookId() < 1) {
 170                         // Invalid id number
 171                         throw new IllegalArgumentException(MessageFormat.format("Address book instance {0} has invalid id number: {1}", event.getAddressbook(), event.getAddressbook().getAddressbookId())); //NOI18N
 172                 } else if (event.getAddressbook().getAddressbookUser() == null) {
 173                         // One more NPE ...
 174                         throw new NullPointerException("event.addressbook.addressbookUser is null"); //NOI18N
 175                 }
 176
 177                 // Get address book instance
 178                 Addressbook book = event.getAddressbook();
 179
 180                 // Set address book data
 181                 this.setAddressbookId(book.getAddressbookId());
 182                 this.setAddressbookName(book.getAddressbookName());
 183                 this.setAddressbookUser(book.getAddressbookUser());
 184                 this.setAddressbookCreated(book.getAddressbookCreated());
 185
 186                 // And instance ...
 187                 this.setAddressbook(book);
 188         }
 189
 190         @Override
 191         public void afterLoginEvent (@Observes final ObservableUserLoggedInEvent event) {
 192                 // Is the user logged in?
 193                 if (null == event) {
 194                         // Is null
 195                         throw new NullPointerException("event is null"); //NOI18N
 196                 } else if (event.getLoggedInUser() == null) {
 197                         // user is null
 198                         throw new NullPointerException("event.user is null"); //NOI18N
 199                 } else if (!event.getLoggedInUser().equals(this.userLoginController.getLoggedInUser())) {
 200                         // Not matching
 201                         throw new IllegalStateException("event.user and userLoginController.loggedInUser don't match."); //NOI18N
 202                 } else if (!this.userLoginController.isUserLoggedIn()) {
 203                         // Not logged in
 204                         throw new FaceletException("This method can only be called as logged-in user."); //NOI18N
 205                 }
 206
 207                 // Init user's address book list
 208                 this.initAddressbookList();
 209         }
 210
 211         @Override
 212         public List<Addressbook> allAddressbooks () {
 213                 // Is the user logged in?
 214                 if (!this.userLoginController.isUserLoggedIn()) {
 215                         // Not logged in
 216                         throw new FaceletException("This method can only be called as logged-in user."); //NOI18N
 217                 }
 218
 219                 return Collections.unmodifiableList(this.usersAddressbooks);
 220         }
 221
 222         @Override
 223         public List<AddressbookEntry> allEntries (final Addressbook addressbook) {
 224                 // Is the user logged in?
 225                 if (!this.userLoginController.isUserLoggedIn()) {
 226                         // Not logged in
 227                         throw new FaceletException("This method can only be called as logged-in user."); //NOI18N
 228                 }
 229
 230                 // Ask the bean
 231                 return this.addressbookBean.allEntries(addressbook);
 232         }
 233
 234         @Override
 235         public int allEntriesSize (final Addressbook addressbook) {
 236                 // Ask the bean
 237                 return this.allEntries(addressbook).size();
 238         }
 239
 240         @Override
 241         public Addressbook getAddressbook () {
 242                 return this.addressbook;
 243         }
 244
 245         @Override
 246         public void setAddressbook (final Addressbook addressbook) {
 247                 this.addressbook = addressbook;
 248         }
 249
 250         @Override
 251         @SuppressWarnings ("ReturnOfDateField")
 252         public Calendar getAddressbookCreated () {
 253                 return this.addressbookCreated;
 254         }
 255
 256         @Override
 257         @SuppressWarnings ("AssignmentToDateFieldFromParameter")
 258         public void setAddressbookCreated (final Calendar addressbookCreated) {
 259                 this.addressbookCreated = addressbookCreated;
 260         }
 261
 262         @Override
 263         public Long getAddressbookId () {
 264                 return this.addressbookId;
 265         }
 266
 267         @Override
 268         public void setAddressbookId (final Long addressbookId) {
 269                 this.addressbookId = addressbookId;
 270         }
 271
 272         @Override
 273         public String getAddressbookName () {
 274                 return this.addressbookName;
 275         }
 276
 277         @Override
 278         public void setAddressbookName (final String addressbookName) {
 279                 this.addressbookName = addressbookName;
 280         }
 281
 282         @Override
 283         public User getAddressbookUser () {
 284                 return this.addressbookUser;
 285         }
 286
 287         @Override
 288         public void setAddressbookUser (final User addressbookUser) {
 289                 this.addressbookUser = addressbookUser;
 290         }
 291
 292         @Override
 293         public boolean hasCreatedAddressbooks () {
 294                 // Is the user logged in?
 295                 if (!this.userLoginController.isUserLoggedIn()) {
 296                         // Not logged in
 297                         throw new FaceletException("This method can only be called as logged-in user."); //NOI18N
 298                 }
 299
 300                 // Check if the list is filled
 301                 return (!this.usersAddressbooks.isEmpty());
 302         }
 303
 304         /**
 305          * Post-initialization of this class
 306          */
 307         @PostConstruct
 308         public void init () {
 309                 // Try it
 310                 try {
 311                         // Get initial context
 312                         Context context = new InitialContext();
 313
 314                         // Try to lookup
 315                         this.addressbookBean = (AddressbookSessionBeanRemote) context.lookup("java:global/jjobs-ejb/jjobs-adr!org.mxchange.jjobs.model.addressbook.JobsAddressbookSessionBeanRemote"); //NOI18N
 316                 } catch (final NamingException e) {
 317                         // Throw again
 318                         throw new FaceletException(e);
 319                 }
 320
 321                 // Init list
 322                 this.usersAddressbooks = new LinkedList<>();
 323
 324                 // Is the user logged-in?
 325                 if (this.userLoginController.isUserLoggedIn()) {
 326                         // Initialize list
 327                         this.initAddressbookList();
 328                 }
 329
 330                 // TODO Initialize list from bean with just one call
 331                 //this.addressbookBean.getUserCountMap()
 332         }
 333
 334         @Override
 335         public boolean isAddressbookLoaded () {
 336                 return ((this.getAddressbookId() instanceof Long) &&
 337                                 (this.getAddressbookName() instanceof String) &&
 338                                 (!this.getAddressbookName().isEmpty()) &&
 339                                 (this.getAddressbookUser() instanceof User));
 340         }
 341
 342         @Override
 343         public boolean isAddressbookNameUsed (final String addressbookName) {
 344                 // Is it zero size?
 345                 if (null == addressbookName) {
 346                         // Is null
 347                         throw new NullPointerException("addressbookName is null"); //NOI18N
 348                 } else if (this.usersAddressbooks.isEmpty()) {
 349                         // Not found!
 350                         return false;
 351                 }
 352
 353                 // Default is not found
 354                 boolean isFound = false;
 355
 356                 // Check all entries
 357                 for (final Addressbook book : this.usersAddressbooks) {
 358                         // Is the name same?
 359                         if (book.getAddressbookName().equals(addressbookName)) {
 360                                 // Found a match
 361                                 isFound = true;
 362                                 break;
 363                         }
 364                 }
 365
 366                 // Return status
 367                 return isFound;
 368         }
 369
 370         @Override
 371         public boolean isOtherAddressbook () {
 372                 // Just call the other method and invert it
 373                 return (!this.isOwnAddressbook());
 374         }
 375
 376         @Override
 377         public boolean isOwnAddressbook () {
 378                 // Is the user logged in?
 379                 if (!this.userLoginController.isUserLoggedIn()) {
 380                         // No, then no own address book
 381                         throw new IllegalStateException("isOwnAddressbook() has been invoked for a guest account"); //NOI18N
 382                 }
 383
 384                 // Is same user?
 385                 return Objects.equals(this.getAddressbookUser(), this.userLoginController.getLoggedInUser());
 386         }
 387
 388         @Override
 389         public boolean loadAddressbook () {
 390                 // Check if the id is set
 391                 if (this.getAddressbookId() == null) {
 392                         // Throw NPE
 393                         throw new NullPointerException("this.addressbookId is null");
 394                 } else if (this.getAddressbookId() < 1) {
 395                         // Not valid id
 396                         throw new IllegalStateException(MessageFormat.format("this.addressbook={0} is invalid", this.getAddressbookId()));
 397                 }
 398
 399                 // Default is not found
 400                 boolean isFound = false;
 401
 402                 try {
 403                         // Then try to look it up
 404                         Addressbook a = this.addressbookBean.getAddressbookById(this.getAddressbookId());
 405
 406                         // Fire event here
 407                         this.loadedEvent.fire(new AddressbookLoadedEvent(a));
 408
 409                         // Found it
 410                         isFound = true;
 411                 } catch (final AddressbookNotFoundException ex) {
 412                         // Not found!
 413                         throw new FaceletException(ex);
 414                 }
 415
 416                 // Return status
 417                 return isFound;
 418         }
 419
 420         /**
 421          * Initializes the user user's address book list
 422          */
 423         private void initAddressbookList () {
 424                 // Get user instance
 425                 User user = this.userLoginController.getLoggedInUser();
 426
 427                 // Fill list with entries
 428                 this.usersAddressbooks = this.addressbookBean.getUsersAddressbookList(user);
 429         }
 430
 431 }