git.mxchange.org Git - addressbook-war.git/blob

   1 /*
   2  * Copyright (C) 2016 - 2020 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.addressbook.beans.user.confirmlink;
  18
  19 import java.io.Serializable;
  20
  21 /**
  22  * An interface for an email change controller
  23  * <p>
  24  * @author Roland Häder<roland@mxchange.org>
  25  */
  26 public interface AddressbookConfirmationLinkWebRequestController extends Serializable {
  27
  28         /**
  29          * Getter for confirmation key
  30          * <p>
  31          * @return Confirmation key
  32          */
  33         String getConfirmationKey ();
  34
  35         /**
  36          * Setter for confirmation key
  37          * <p>
  38          * @param confirmationKey Confirmation key
  39          */
  40         void setConfirmationKey (final String confirmationKey);
  41
  42         /**
  43          * Tries to lookup the user by currently set confirmation key and if found
  44          * tries to confirm it. If no user is found, the instance beanHelper.user is
  45          * set to null. Other methods or JSF pages should then respond on this
  46          * accordingly.
  47          */
  48         void maybeConfirmUserAccount ();
  49
  50 }