Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ExceptionPresenter |
|
| 1.0;1 |
1 | // Copyright 2005 The Apache Software Foundation | |
2 | // | |
3 | // Licensed under the Apache License, Version 2.0 (the "License"); | |
4 | // you may not use this file except in compliance with the License. | |
5 | // You may obtain a copy of the License at | |
6 | // | |
7 | // http://www.apache.org/licenses/LICENSE-2.0 | |
8 | // | |
9 | // Unless required by applicable law or agreed to in writing, software | |
10 | // distributed under the License is distributed on an "AS IS" BASIS, | |
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
12 | // See the License for the specific language governing permissions and | |
13 | // limitations under the License. | |
14 | ||
15 | package org.apache.tapestry.error; | |
16 | ||
17 | import org.apache.tapestry.IRequestCycle; | |
18 | ||
19 | /** | |
20 | * Invoked by the {@link org.apache.tapestry.IEngine} if there's an uncaught | |
21 | * exception (checked or runtime) processing a request. The ExceptionPresenter | |
22 | * is responsible for presenting a exception message (or description) to the | |
23 | * user. The default implementation activates the "Exception" page, but it is | |
24 | * common to override this to do something application specific (typically, | |
25 | * return to the Home page and display an error message there). This service | |
26 | * also provides a good hook for creating a server-side log of exceptions. | |
27 | * | |
28 | * @author Howard M. Lewis Ship | |
29 | * @since 4.0 | |
30 | * @see RequestExceptionReporter | |
31 | */ | |
32 | public interface ExceptionPresenter | |
33 | { | |
34 | ||
35 | /** | |
36 | * Report the exception and provide some response to the user in lieu of the | |
37 | * expected result page. | |
38 | * | |
39 | * @param cycle | |
40 | * the current request cycle | |
41 | * @param cause | |
42 | * the exception that was caught | |
43 | */ | |
44 | ||
45 | void presentException(IRequestCycle cycle, Throwable cause); | |
46 | } |