1 /*
2 * Copyright (c) 2001 - 2004 ivata limited.
3 * All rights reserved.
4 * -----------------------------------------------------------------------------
5 * ivata masks may be redistributed under the GNU General Public
6 * License as published by the Free Software Foundation;
7 * version 2 of the License.
8 *
9 * These programs are free software; you can redistribute them and/or
10 * modify them under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; version 2 of the License.
12 *
13 * These programs are distributed in the hope that they will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16 *
17 * See the GNU General Public License in the file LICENSE.txt for more
18 * details.
19 *
20 * If you would like a copy of the GNU General Public License write to
21 *
22 * Free Software Foundation, Inc.
23 * 59 Temple Place - Suite 330
24 * Boston, MA 02111-1307, USA.
25 *
26 *
27 * To arrange commercial support and licensing, contact ivata at
28 * http://www.ivata.com/contact.jsp
29 * -----------------------------------------------------------------------------
30 * $Log: MaskAuthenticator.java,v $
31 * Revision 1.3 2005/04/09 18:04:19 colinmacleod
32 * Changed copyright text to GPL v2 explicitly.
33 *
34 * Revision 1.2 2005/01/07 08:08:24 colinmacleod
35 * Moved up a version number.
36 * Changed copyright notices to 2005.
37 * Updated the documentation:
38 * - started working on multiproject:site docu.
39 * - changed the logo.
40 * Added checkstyle and fixed LOADS of style issues.
41 * Added separate thirdparty subproject.
42 * Added struts (in web), util and webgui (in webtheme) from ivata op.
43 *
44 * Revision 1.1 2004/12/23 21:28:32 colinmacleod
45 * Modifications to add ivata op compatibility.
46 * -----------------------------------------------------------------------------
47 */
48 package com.ivata.mask.web.struts;
49 import javax.servlet.http.HttpSession;
50 /***
51 * <p>
52 * Mask authenticator allows you to query the state of the current web session
53 * and return control to an alternate forward, if the current user is
54 * unauthorized.
55 * </p>
56 *
57 * @since ivata masks 0.3 (2004-11-12)
58 * @author Colin MacLeod
59 * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
60 * @version $Revision: 1.3 $
61 */
62 public interface MaskAuthenticator {
63 /***
64 * <p>
65 * This is the 'do it' method of this interface <code>:-)</code>.
66 * Identify whether or not special steps should be taken for this user, and
67 * return the <strong>Struts </strong> action forward if they should.
68 * </p>
69 *
70 * @param session
71 * current web session to authenicate against.
72 * @param login
73 * <code>true</code> if the user is performing a login action,
74 * otherwise <code>false</code>.
75 * @return name of a <strong>Struts </strong> action forward to pass control
76 * to, or <code>null</code> if the current user is valid and
77 * should be allowed to continue.
78 */
79 String authenticate(HttpSession session, boolean login);
80 }
81