ILoginAuthenticator.java

/*
 * ConcourseConnect
 * Copyright 2009 Concursive Corporation
 * http://www.concursive.com
 *
 * This file is part of ConcourseConnect, an open source social business
 * software and community platform.
 *
 * Concursive ConcourseConnect is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation, version 3 of the License.
 *
 * Under the terms of the GNU Affero General Public License you must release the
 * complete source code for any application that uses any part of ConcourseConnect
 * (system header files and libraries used by the operating system are excluded).
 * These terms must be included in any work that has ConcourseConnect components.
 * If you are developing and distributing open source applications under the
 * GNU Affero General Public License, then you are free to use ConcourseConnect
 * under the GNU Affero General Public License.
 *
 * If you are deploying a web site in which users interact with any portion of
 * ConcourseConnect over a network, the complete source code changes must be made
 * available.  For example, include a link to the source archive directly from
 * your web site.
 *
 * For OEMs, ISVs, SIs and VARs who distribute ConcourseConnect with their
 * products, and do not license and distribute their source code under the GNU
 * Affero General Public License, Concursive provides a flexible commercial
 * license.
 *
 * To anyone in doubt, we recommend the commercial license. Our commercial license
 * is competitively priced and will eliminate any confusion about how
 * ConcourseConnect can be used and distributed.
 *
 * ConcourseConnect 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 Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with ConcourseConnect.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Attribution Notice: ConcourseConnect is an Original Work of software created
 * by Concursive Corporation
 */
package com.concursive.connect.web.modules.login.auth;

import com.concursive.commons.web.mvc.actions.ActionContext;

/**
 * The ILoginAuthenticator interface provides a standard model for
 * all login authentication packages to use.
 *
 * @author Artem.Zakolodkin
 * @created Jul 19, 2007
 */
public interface ILoginAuthenticator {

  /**
   * Complete whatever form of validation is appropriate for the login
   * model it instantiates.
   *
   * @param context The action context as provided by the ControllerServlet.
   * @return The strings <i>"LoginRetry", "PerformUpgradeOK", "UpgradeCheck",
   *         "LoginVerifyOK", "LoginOK", "CustomerPortalLoginOK", "ProductsPortalLoginOK",
   *         "RedirectURL",</i> and <i>"LoginOK"</i> should be returned as appropriate for the login.
   *         <p/>
   *         In the event the login redirects away from CentricCRM, as in the case of a LAM login, <i>"-none-"</i>
   *         should be returned.
   */
  public String authenticateLogin(ActionContext context);

  /**
   * Close any login sessions currently open.
   *
   * @param context The action context as provided by the <code>ControllerServlet</code>.
   * @return A String containing <i>"LoginRetry"</i>.
   */
  public String authenticateLogout(ActionContext context);
}