annotate servlet/src/digilib/auth/AuthOpsImpl.java @ 216:050fa739066f

image information in XML format
author robcast
date Tue, 29 Jun 2004 12:05:30 +0200
parents 26b2a74e2fe5
children e758a49258e8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
1 /* AuthOps -- Authentication class implementation
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
2
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
3 Digital Image Library servlet components
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
4
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
5 Copyright (C) 2001, 2002 Robert Casties (robcast@mail.berlios.de)
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
6
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
7 This program is free software; you can redistribute it and/or modify it
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
9 Free Software Foundation; either version 2 of the License, or (at your
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
10 option) any later version.
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
11
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
12 Please read license.txt for the full details. A copy of the GPL
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
13 may be found at http://www.gnu.org/copyleft/lgpl.html
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
14
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
16 along with this program; if not, write to the Free Software
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
18
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
19 */
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
20
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
21 package digilib.auth;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
22
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
23 import java.util.List;
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
24 import java.util.ListIterator;
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
25
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
26 import javax.servlet.http.HttpServletRequest;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
27
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
28 import org.apache.log4j.Logger;
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
29
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
30 import digilib.servlet.DigilibRequest;
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
31
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
32 /** Basic implementation of AuthOps interface.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
33 *
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
34 * Provides basic implementations. Only rolesForPath needs to be implemented
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
35 * by specific implementations.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
36 */
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
37 public abstract class AuthOpsImpl implements AuthOps {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
38
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
39 /** general logger for this class */
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
40 protected Logger logger = Logger.getLogger(this.getClass());
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
41
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
42 /** Default constructor. */
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
43 public AuthOpsImpl() {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
44 try {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
45 init();
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
46 } catch (AuthOpException e) {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
47 }
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
48 }
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
49
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
50
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
51 /** Test if the request is allowed to access filepath.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
52 * @param filepath filepath to be acessed.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
53 * @param request Request with user information.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
54 * @throws AuthOpException Exception thrown on error.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
55 * @return true if the request is allowed.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
56 */
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
57 public boolean isAuthRequired(String filepath, HttpServletRequest request) throws AuthOpException {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
58 // check permissions
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
59 List rolesRequired = rolesForPath(filepath, request);
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
60 return (rolesRequired != null);
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
61 }
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
62
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
63 /**
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
64 * @see digilib.auth.AuthOps#isAuthRequired(digilib.servlet.DigilibRequest)
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
65 */
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
66 public boolean isAuthRequired(DigilibRequest request)
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
67 throws AuthOpException {
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
68 // check permissions
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
69 List rolesRequired = rolesForPath(request);
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
70 return (rolesRequired != null);
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
71 }
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
72
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
73 /** Return authorization roles needed for request.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
74 *
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
75 * Returns a list of authorization roles that would be allowed to access the
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
76 * specified path. The location information of the request is considered also.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
77 * @param filepath filepath to be accessed.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
78 * @param request ServletRequest with address information.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
79 * @throws AuthOpException Exception thrown on error.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
80 * @return List of Strings with role names.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
81 */
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
82 public boolean isAuthorized(String filepath, HttpServletRequest request) throws AuthOpException {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
83 List rolesAllowed = rolesForPath(filepath, request);
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
84 return isRoleAuthorized(rolesAllowed, request);
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
85 }
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
86
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
87 /**
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
88 * @see digilib.auth.AuthOps#isAuthorized(digilib.servlet.DigilibRequest)
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
89 */
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
90 public boolean isAuthorized(DigilibRequest request)
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
91 throws AuthOpException {
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
92 List rolesAllowed = rolesForPath(request);
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
93 return isRoleAuthorized(rolesAllowed, request);
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
94 }
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
95
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
96 /** Test request authorization against a list of roles.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
97 * @param roles List of Strings with role names.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
98 * @param request ServletRequest with address information.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
99 * @return true if the user information in the request authorizes one of the roles.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
100 */
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
101 public boolean isRoleAuthorized(List roles, HttpServletRequest request) {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
102 ListIterator r = roles.listIterator();
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
103 String s = "";
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
104 while (r.hasNext()) {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
105 s = (String)r.next();
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
106 logger.debug("Testing role: "+s);
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
107 if (request.isUserInRole(s)) {
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
108 logger.debug("Role Authorized");
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
109 return true;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
110 }
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
111 }
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
112 return false;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
113 }
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
114
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
115 /**
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
116 * @see digilib.auth.AuthOps#isRoleAuthorized(java.util.List, digilib.servlet.DigilibRequest)
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
117 */
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
118 public boolean isRoleAuthorized(List roles, DigilibRequest request) {
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
119 ListIterator r = roles.listIterator();
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
120 String s = "";
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
121 while (r.hasNext()) {
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
122 s = (String)r.next();
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
123 logger.debug("Testing role: "+s);
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
124 if (((HttpServletRequest)request.getServletRequest()).isUserInRole(s)) {
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
125 logger.debug("Role Authorized");
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
126 return true;
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
127 }
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
128 }
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
129 return false;
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
130 }
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
131
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
132 public abstract void init() throws AuthOpException;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
133
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
134 public abstract List rolesForPath(String filepath, HttpServletRequest request) throws AuthOpException;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
135
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
136 public abstract List rolesForPath(DigilibRequest request) throws AuthOpException;
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
137
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
138 }