001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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    }