1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.security.auth;
24  
25  import java.util.Map;
26  
27  /**
28   * <a href="Authenticator.java.html"><b><i>View Source</i></b></a>
29   *
30   * @author Brian Wing Shun Chan
31   */
32  public interface Authenticator {
33  
34      public static final int SUCCESS = 1;
35  
36      public static final int FAILURE = -1;
37  
38      public static final int DNE = 0;
39  
40      public int authenticateByEmailAddress(
41              long companyId, String emailAddress, String password,
42              Map<String, String[]> headerMap, Map<String, String[]> parameterMap)
43          throws AuthException;
44  
45      public int authenticateByScreenName(
46              long companyId, String screenName, String password,
47              Map<String, String[]> headerMap, Map<String, String[]> parameterMap)
48          throws AuthException;
49  
50      public int authenticateByUserId(
51              long companyId, long userId, String password,
52              Map<String, String[]> headerMap, Map<String, String[]> parameterMap)
53          throws AuthException;
54  
55  }