src/java/org/mxchange/jfinancials/beans/user/login/FinancialsUserLoginWebSessionController.java

   1 /*
   2  * Copyright (C) 2016 - 2022 Free Software Foundation
   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.jfinancials.beans.user.login;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import org.mxchange.jusercore.model.user.User;
  22 import org.mxchange.jusercore.model.user.password_history.PasswordHistory;
  23
  24 /**
  25  * An interface for registration web controllers
  26  * <p>
  27  * @author Roland Häder<roland@mxchange.org>
  28  */
  29 public interface FinancialsUserLoginWebSessionController extends Serializable {
  30
  31         /**
  32          * Checks whether given clear-text password is in user's password history.
  33          * <p>
  34          * @param userPassword Clear-text password
  35          * <p>
  36          * @return Whether clear-text password is in user's password history
  37          */
  38         boolean isPasswordInHistory (final String userPassword);
  39
  40         /**
  41          * Getter for base template type
  42          * <p>
  43          * @return Template type
  44          */
  45         String getBaseTemplatePathName ();
  46
  47         /**
  48          * Setter for base template type
  49          * <p>
  50          * @param baseTemplatePathName Template type
  51          */
  52         void setBaseTemplatePathName (final String baseTemplatePathName);
  53
  54         /**
  55          * Getter for logged-in user instance
  56          * <p>
  57          * @return Logged-in user instance
  58          */
  59         User getLoggedInUser ();
  60
  61         /**
  62          * Setter for logged-in user instance
  63          * <p>
  64          * @param loggedInUser Logged-in user instance
  65          */
  66         void setLoggedInUser (final User loggedInUser);
  67
  68         /**
  69          * Checks whether the user is logged-in
  70          * <p>
  71          * @return Whether the user is logged-in
  72          */
  73         boolean isUserLoggedIn ();
  74
  75         /**
  76          * Checks whether the user needs to change password
  77          * <p>
  78          * @return Whether the user needs to change password
  79          */
  80         boolean ifUserMustChangePassword ();
  81
  82         /**
  83          * Whether the currently logged-in user is invisible
  84          * <p>
  85          * @return Whether the currently logged-in user is invisible
  86          */
  87         boolean isInvisible ();
  88
  89         /**
  90          * Checks whether the (previously entered) current password matches with
  91          * from the user instance.
  92          * <p>
  93          * @return If current password matches
  94          */
  95         boolean ifCurrentPasswordMatches ();
  96
  97         /**
  98          * Getter for user's password history
  99          * <p>
 100          * @return User's password history
 101          */
 102         List<PasswordHistory> getUserPasswordHistory ();
 103
 104 }