1 /*
2 * $Source$
3 * $Revision$
4 *
5 * Copyright (C) 2000 William Chesters
6 *
7 * Part of Melati (http://melati.org), a framework for the rapid
8 * development of clean, maintainable web applications.
9 *
10 * Melati is free software; Permission is granted to copy, distribute
11 * and/or modify this software under the terms either:
12 *
13 * a) the GNU General Public License as published by the Free Software
14 * Foundation; either version 2 of the License, or (at your option)
15 * any later version,
16 *
17 * or
18 *
19 * b) any version of the Melati Software License, as published
20 * at http://melati.org
21 *
22 * You should have received a copy of the GNU General Public License and
23 * the Melati Software License along with this program;
24 * if not, write to the Free Software Foundation, Inc.,
25 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26 * GNU General Public License and visit http://melati.org to obtain the
27 * Melati Software License.
28 *
29 * Feel free to contact the Developers of Melati (http://melati.org),
30 * if you would like to work out a different arrangement than the options
31 * outlined here. It is our intention to allow Melati to be used by as
32 * wide an audience as possible.
33 *
34 * This program is distributed in the hope that it will be useful,
35 * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 * GNU General Public License for more details.
38 *
39 * Contact details for copyright holder:
40 *
41 * William Chesters <williamc At paneris.org>
42 * http://paneris.org/~williamc
43 * Obrechtstraat 114, 2517VX Den Haag, The Netherlands
44 */
45
46 package org.melati.poem;
47
48 /**
49 * Thrown when an authorisation problem occurs, that is when
50 * a {@link User} does not have the required {@link Capability}
51 * or is not in a {@link Group} with the required {@link Capability}
52 * to access a restricted object.
53 */
54 public class AccessPoemException extends PoemException {
55 private static final long serialVersionUID = 1L;
56
57 /** The User's Token. */
58 public AccessToken token;
59 /** The required Capability. */
60 public Capability capability;
61
62 // This is required to report the exception outside of a session.
63 private String capabilityString;
64
65 public AccessPoemException(Exception problem,
66 AccessToken token, Capability capability) {
67 super(problem);
68 this.token = token;
69 this.capability = capability;
70 this.capabilityString = (capability == null ?
71 null : capability.toString());
72 }
73
74 public AccessPoemException(AccessToken token, Capability capability) {
75 this(null, token, capability);
76 }
77
78 public AccessPoemException(AccessPoemException e) {
79 this(e, e.token, e.capability);
80 }
81
82 public AccessPoemException() {
83 this(null, null);
84 }
85
86 /** @return null */
87 public String getActionDescription() {
88 return null;
89 }
90
91 /** @return The detail message */
92 public String getMessage() {
93 String ad = getActionDescription();
94 // Not sure what the rules are here.
95 if (capability != null && PoemThread.inSession()) {
96 capabilityString = capability.toString();
97 }
98 return
99 "You need the capability " + capabilityString +
100 (ad == null ? "" : " to " + ad) + " but your access token " +
101 token + " doesn't confer it";
102 }
103
104 /** @return the AccessToken */
105 public AccessToken getToken() {
106 return token;
107 }
108 }