1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * This library is free software; you can redistribute it and/or modify it under
5    * the terms of the GNU Lesser General Public License as published by the Free
6    * Software Foundation; either version 2.1 of the License, or (at your option)
7    * any later version.
8    *
9    * This library is distributed in the hope that it will be useful, but WITHOUT
10   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11   * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
12   * details.
13   */
14  
15  package com.liferay.portal.security.auth;
16  
17  import java.util.Map;
18  
19  /**
20   * <a href="Authenticator.java.html"><b><i>View Source</i></b></a>
21   *
22   * @author Brian Wing Shun Chan
23   */
24  public interface Authenticator {
25  
26      public static final int SUCCESS = 1;
27  
28      public static final int FAILURE = -1;
29  
30      public static final int DNE = 0;
31  
32      public int authenticateByEmailAddress(
33              long companyId, String emailAddress, String password,
34              Map<String, String[]> headerMap, Map<String, String[]> parameterMap)
35          throws AuthException;
36  
37      public int authenticateByScreenName(
38              long companyId, String screenName, String password,
39              Map<String, String[]> headerMap, Map<String, String[]> parameterMap)
40          throws AuthException;
41  
42      public int authenticateByUserId(
43              long companyId, long userId, String password,
44              Map<String, String[]> headerMap, Map<String, String[]> parameterMap)
45          throws AuthException;
46  
47  }