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