KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > jforum > sso > SSO


1 /*
2  * Copyright (c) Rafael Steil
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms,
6  * with or without modification, are permitted provided
7  * that the following conditions are met:
8  *
9  * 1) Redistributions of source code must retain the above
10  * copyright notice, this list of conditions and the
11  * following disclaimer.
12  * 2) Redistributions in binary form must reproduce the
13  * above copyright notice, this list of conditions and
14  * the following disclaimer in the documentation and/or
15  * other materials provided with the distribution.
16  * 3) Neither the name of "Rafael Steil" nor
17  * the names of its contributors may be used to endorse
18  * or promote products derived from this software without
19  * specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
22  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
23  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
24  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
27  * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES
30  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
32  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
34  * IN CONTRACT, STRICT LIABILITY, OR TORT
35  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
36  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
37  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
38  *
39  * Created on Mar 28, 2005 7:22:52 PM
40  * The JForum Project
41  * http://www.jforum.net
42  */
43 package net.jforum.sso;
44
45 import javax.servlet.http.HttpServletRequest JavaDoc;
46
47 import net.jforum.ActionServletRequest;
48 import net.jforum.entities.UserSession;
49
50 /**
51  * @author Rafael Steil
52  * @author Daniel Campagnoli
53  * @version $Id: SSO.java,v 1.5 2005/07/26 03:05:32 rafaelsteil Exp $
54  */
55 public interface SSO
56 {
57     /**
58      * Authenticates an user.
59      * This method should check if the incoming user is authorized
60      * to access the forum.
61      * @param request The request object
62      * @return The username, if authentication succeded, or <code>nulll</code>
63      * otherwise.
64      */
65     public String JavaDoc authenticateUser(ActionServletRequest request);
66    
67    
68     /**
69      * Check to see if the user for the current {@link UserSession} is the same user by
70      * single sign on mechanisim.
71      * @param userSession the current user session
72      * @param request the current request
73      * @return if the UserSession is valid
74      */
75     public boolean isSessionValid(UserSession userSession, HttpServletRequest JavaDoc request);
76 }
77
Popular Tags