Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
AccessHandler |
|
| 1.0;1 |
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@paneris.org> | |
42 | * http://paneris.org/~williamc | |
43 | * Obrechtstraat 114, 2517VX Den Haag, The Netherlands | |
44 | */ | |
45 | ||
46 | package org.melati.login; | |
47 | ||
48 | import java.io.IOException; | |
49 | import org.melati.poem.AccessPoemException; | |
50 | import org.melati.Melati; | |
51 | import org.melati.util.MelatiException; | |
52 | ||
53 | /** | |
54 | * A handler invoked when an {@link AccessPoemException} occurs. | |
55 | * | |
56 | * The actions required are to offer the user the opportunity to | |
57 | * login and then return the user to the same point as they were before | |
58 | * the {@link AccessPoemException} occurred and retry that operation. | |
59 | */ | |
60 | public interface AccessHandler { | |
61 | ||
62 | /** | |
63 | * Deal with an AccessPoemException, often by allowing login. | |
64 | * @param melati current Melati | |
65 | * @param accessException the AccessException | |
66 | */ | |
67 | void handleAccessException(Melati melati, | |
68 | AccessPoemException accessException) | |
69 | throws Exception; | |
70 | ||
71 | /** | |
72 | * Called when a @link PoemTask} is initiated. | |
73 | * | |
74 | * @return A {@link Melati} with the appropriate fields filled. | |
75 | * @see org.melati.servlet.PoemServlet#doConfiguredRequest | |
76 | * @see org.melati.app.AbstractPoemApp#doConfiguredRequest | |
77 | */ | |
78 | Melati establishUser(Melati melati); | |
79 | ||
80 | /** | |
81 | * Rebuild request if we have had to login, otherwise nothing. | |
82 | * | |
83 | * @param melati used to hold original request | |
84 | */ | |
85 | void buildRequest(Melati melati) | |
86 | throws MelatiException, IOException; | |
87 | } |