001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.security.auth;
016    
017    import java.util.Map;
018    
019    /**
020     * @author Brian Wing Shun Chan
021     */
022    public interface Authenticator {
023    
024            public static final int DNE = 0;
025    
026            public static final int FAILURE = -1;
027    
028            public static final int SKIP_LIFERAY_CHECK = 2;
029    
030            public static final int SUCCESS = 1;
031    
032            public int authenticateByEmailAddress(
033                            long companyId, String emailAddress, String password,
034                            Map<String, String[]> headerMap, Map<String, String[]> parameterMap)
035                    throws AuthException;
036    
037            public int authenticateByScreenName(
038                            long companyId, String screenName, String password,
039                            Map<String, String[]> headerMap, Map<String, String[]> parameterMap)
040                    throws AuthException;
041    
042            public int authenticateByUserId(
043                            long companyId, long userId, String password,
044                            Map<String, String[]> headerMap, Map<String, String[]> parameterMap)
045                    throws AuthException;
046    
047    }