001/*
002 * (C) Copyright 2006-2007 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nuxeo - initial API and implementation
018 *
019 * $Id: JOOoConvertPluginImpl.java 18651 2007-05-13 20:28:53Z sfermigier $
020 */
021
022package org.nuxeo.ecm.platform.login;
023
024import java.util.Map;
025
026import org.nuxeo.ecm.platform.api.login.UserIdentificationInfo;
027
028public interface LoginPlugin {
029
030    // public String getLoginPage();
031
032    // public void setLoginPage(String loginPage);
033
034    Boolean initLoginModule();
035
036    /**
037     * Gets the plugin name.
038     *
039     * @return the plugin name.
040     */
041    String getName();
042
043    /**
044     * Sets the plugin name.
045     *
046     * @param pluginName the plugin name.
047     */
048    // Not used. Remove?
049    void setName(String pluginName);
050
051    Map<String, String> getParameters();
052
053    void setParameters(Map<String, String> parameters);
054
055    String getParameter(String parameterName);
056
057    String validatedUserIdentity(UserIdentificationInfo userIdent);
058
059}