001/*
002 * (C) Copyright 2006-2007 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Nuxeo - initial API and implementation
016 *
017 * $Id: JOOoConvertPluginImpl.java 18651 2007-05-13 20:28:53Z sfermigier $
018 */
019
020package org.nuxeo.ecm.platform.login;
021
022import java.util.Map;
023
024import org.nuxeo.ecm.platform.api.login.UserIdentificationInfo;
025
026public interface LoginPlugin {
027
028    // public String getLoginPage();
029
030    // public void setLoginPage(String loginPage);
031
032    Boolean initLoginModule();
033
034    /**
035     * Gets the plugin name.
036     *
037     * @return the plugin name.
038     */
039    String getName();
040
041    /**
042     * Sets the plugin name.
043     *
044     * @param pluginName the plugin name.
045     */
046    // Not used. Remove?
047    void setName(String pluginName);
048
049    Map<String, String> getParameters();
050
051    void setParameters(Map<String, String> parameters);
052
053    String getParameter(String parameterName);
054
055    String validatedUserIdentity(UserIdentificationInfo userIdent);
056
057}