KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > rift > coad > lib > interceptor > InterceptorAuthenticator


1 /*
2  * CoadunationLib: The coaduntion implementation library.
3  * Copyright (C) 2006 Rift IT Contracting
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  *
19  * InterceptorAuthenticator.java
20  *
21  * This interface is responsible for supplying a method to authenticate a
22  * credential object an return the appropriate user session object.
23  */

24
25 // the package path
26
package com.rift.coad.lib.interceptor;
27
28 // coadunation imports
29
import com.rift.coad.lib.interceptor.credentials.Credential;
30 import com.rift.coad.lib.security.AuthorizationException;
31 import com.rift.coad.lib.security.UserSession;
32
33 /**
34  * This interface is responsible for supplying a method to authenticate a
35  * credential object an return the appropriate user session object.
36  *
37  * @author Brett Chaldecott
38  */

39 public interface InterceptorAuthenticator {
40     
41     /**
42      * This method returns a valid user session object for the supplied
43      * credentials
44      *
45      * @return UserSession The new user session for the given credentials.
46      * @param credentials The credentials for the user session.
47      * @exception InterceptorException
48      * @exception AuthorizationException
49      */

50     public UserSession authenticate(Credential credential) throws
51             InterceptorException, AuthorizationException;
52 }
53
Popular Tags