src/org/mxchange/jusercore/model/register/UserRegistrationSessionBeanRemote.java

   1 /*
   2  * Copyright (C) 2016 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.register;
  18
  19 import java.io.Serializable;
  20 import javax.ejb.Remote;
  21 import org.mxchange.jusercore.exceptions.EmailAddressAlreadyRegisteredException;
  22 import org.mxchange.jusercore.exceptions.UserNameAlreadyRegisteredException;
  23 import org.mxchange.jusercore.model.user.User;
  24
  25 /**
  26  * A remote interface for user registtration
  27  * <p>
  28  * @author Roland Haeder<roland@mxchange.org>
  29  */
  30 @Remote
  31 public interface UserRegistrationSessionBeanRemote extends Serializable {
  32
  33         /**
  34          * Generates a non-existing confirmation key for given user instance. The
  35          * user instance is being used as entropy source to make the key more harder
  36          * to "guess".
  37          * <p>
  38          * @param user User instance
  39          * <p>
  40          * @return Non-existing confirmation key
  41          */
  42         String generateConfirmationKey (User user);
  43
  44         /**
  45          * Registers given user data, if not yet found
  46          * <p>
  47          * @param user User instance to register
  48          * @param baseUrl Base URL
  49          * <p>
  50          * @return The fully registered user account
  51          * <p>
  52          * @throws UserNameAlreadyRegisteredException If the user name has already
  53          * been registered
  54          * @throws EmailAddressAlreadyRegisteredException If the email address has
  55          * already been registered
  56          */
  57         User registerUser (final User user, final String baseUrl) throws UserNameAlreadyRegisteredException, EmailAddressAlreadyRegisteredException;
  58
  59         /**
  60          * Checks if the user's name is already registered
  61          * <p>
  62          * @param user User instance to check
  63          * <p>
  64          * @return Whether the user's name has already been registered
  65          */
  66         boolean isUserNameRegistered (final User user);
  67
  68         /**
  69          * Checks if the user's email address is already registered
  70          * <p>
  71          * @param user User instance to check
  72          * <p>
  73          * @return Whether the user's email address has already been registered
  74          */
  75         boolean isEmailAddressRegistered (final User user);
  76 }