1 /*
2 * $Id: Authenticator.java 124 2004-11-01 18:09:40Z josem $
3 *
4 * Tarsis
5 * Copyright (C) 2002 Talika Open Source Group
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 *
21 */
22
23 package org.talika.tarsis.security;
24
25 /***
26 * Interface that defines an authenticator component in Tarsis MVC Framework.<br>
27 * <br>
28 * Authenticator component is responsible of manage authentication of users.
29 *
30 * @author Jose M. Palomar
31 * @version $Revision: 124 $
32 */
33 public interface Authenticator {
34
35 /***
36 * Checks if given user and password are correct.
37 *
38 * @param user String user name.
39 * @param password String user password.
40 * @return SecuritySession security session created from given user and password.
41 * @throws AuthenticationFailedException if user and/or password aren't correct.
42 */
43 SecuritySession login(String user, String password)
44 throws AuthenticationFailedException;
45
46 }
47