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.login;
19 import java.io.Serializable;
20 import org.mxchange.jusercore.model.user.User;
23 * An interface for registration web controllers
25 * @author Roland Haeder<roland@mxchange.org>
27 public interface JobsUserLoginWebSessionController extends Serializable {
30 * Getter for template type
32 * @return Template type
34 String getTemplateType ();
37 * Setter for template type
39 * @param templateType Template type
41 void setTemplateType (final String templateType);
44 * Logins the user, if the account is found, confirmed and unlocked.
46 * @return Redirect target
51 * Getter for logged-in user instance
53 * @return Logged-in user instance
55 User getLoggedInUser ();
58 * Setter for logged-in user instance
60 * @param loggedInUser Logged-in user instance
62 void setLoggedInUser (final User loggedInUser);
65 * Checks whether the user is logged-in
67 * @return Whether the user is logged-in
69 boolean isUserLoggedIn ();
72 * Is this truly a guest?
74 * @return Whether the user is truly a guest
79 * Whether the currently logged-in user is invisible
81 * @return Whether the currently logged-in user is invisible
83 boolean isInvisible ();
86 * Setter for current password (clear text)
88 * @param currentPassword Current password
90 void setCurrentPassword (final String currentPassword);
93 * Getter for current password (clear text)
95 * @return Current password
97 String getCurrentPassword ();
100 * Checks whether the (previously entered) current password matches with from
103 * @return If current password matches
105 boolean ifCurrentPasswordMatches ();