src/org/mxchange/jusercore/model/login/UserLoginSessionBeanRemote.java

   1 /*
   2  * Copyright (C) 2016 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 General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (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 General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jusercore.model.login;
  18
  19 import java.io.Serializable;
  20 import javax.ejb.Remote;
  21 import org.mxchange.jusercore.container.login.LoginContainer;
  22 import org.mxchange.jusercore.exceptions.UserNotFoundException;
  23 import org.mxchange.jusercore.exceptions.UserPasswordMismatchException;
  24 import org.mxchange.jusercore.exceptions.UserStatusLockedException;
  25 import org.mxchange.jusercore.exceptions.UserStatusUnconfirmedException;
  26 import org.mxchange.jusercore.model.user.User;
  27
  28 /**
  29  * A remote interface for user login
  30  * <p>
  31  * @author Roland Häder<roland@mxchange.org>
  32  */
  33 @Remote
  34 public interface UserLoginSessionBeanRemote extends Serializable {
  35
  36         /**
  37          * Validates if the user is a confirmed account and returns the full user
  38          * instance
  39          * <p>
  40          * @param container Login container holding user instance and unencrypted password
  41          * <p>
  42          * @return Full confirmed user account
  43          * <p>
  44          * @throws org.mxchange.jusercore.exceptions.UserNotFoundException If the
  45          * user account was not found
  46          * @throws org.mxchange.jusercore.exceptions.UserStatusLockedException If
  47          * the user account is locked
  48          * @throws org.mxchange.jusercore.exceptions.UserStatusUnconfirmedException
  49          * If the user account is unconfirmed
  50          * @throws org.mxchange.jusercore.exceptions.UserPasswordMismatchException
  51          * If the password is not matching
  52          */
  53         User validateUserAccountStatus (final LoginContainer container) throws UserNotFoundException, UserStatusLockedException, UserStatusUnconfirmedException, UserPasswordMismatchException;
  54 }