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

   1 /*
   2  * Copyright (C) 2015 Roland Haeder
   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.exceptions.UserNotFoundException;
  22 import org.mxchange.jusercore.exceptions.UserStatusLockedException;
  23 import org.mxchange.jusercore.exceptions.UserStatusUnconfirmedException;
  24 import org.mxchange.jusercore.model.user.User;
  25
  26 /**
  27  * A remote interface for user login
  28  * <p>
  29  * @author Roland Haeder
  30  */
  31 @Remote
  32 public interface UserLoginSessionBeanRemote extends Serializable {
  33
  34         /**
  35          * Validates if the user is a confirmed account and returns the full user
  36          * instance
  37          * <p>
  38          * @param user User instance to register
  39          * <p>
  40          * @return Full confirmed user account
  41          * <p>
  42          * @throws org.mxchange.jusercore.exceptions.UserNotFoundException If the
  43          * user account was not found
  44          * @throws org.mxchange.jusercore.exceptions.UserStatusLockedException If
  45          * the user account is locked
  46          * @throws org.mxchange.jusercore.exceptions.UserStatusUnconfirmedException
  47          * If the user account is unconfirmed
  48          */
  49         public User validateUserAccountStatus (final User user) throws UserNotFoundException, UserStatusLockedException, UserStatusUnconfirmedException;
  50 }