/*
 * This file is part of the Meeds project (https://meeds.io/).
 * Copyright (C) 2022 Meeds Association
 * contact@meeds.io
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.exoplatform.services.organization.plugin;

import org.exoplatform.container.component.BaseComponentPlugin;
import org.exoplatform.services.organization.User;

public abstract class SecurityCheckAuthenticationPlugin extends BaseComponentPlugin {

  /**
   * check user authentication depends on the specified logic in the plugin
   *
   * @param user Target user to be authenticated
   * @throws Exception
   */
  public abstract void doCheck(User user) throws Exception;

  /**
   * Invoked when the check on the authentication is failed
   *
   * @param userName Target username
   */
  public abstract void onCheckFail(String userName);

  /**
   * Invoked when the check on the authentication is succeeded
   *
   * @param userName Target username
   */
  public abstract void onCheckSuccess(String userName);
}
