KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > error > ExceptionPresenter


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 exception
21  * (checked or runtime) processing a request. The ExceptionPresenter is responsible for presenting a
22  * exception message (or description) to the user. The default implementation activates the
23  * "Exception" page, but it is common to override this to do something application specific
24  * (typically, return to the Home page and display an error message there). This service also
25  * provides a good hook for creating a server-side log of exceptions.
26  *
27  * @author Howard M. Lewis Ship
28  * @since 4.0
29  * @see RequestExceptionReporter
30  */

31 public interface ExceptionPresenter
32 {
33     /**
34      * Report the exception and provide some response to the user in lieu of the expected result
35      * page.
36      *
37      * @param cycle
38      * the current request cycle
39      * @param cause
40      * the exception that was caught
41      */

42
43     public void presentException(IRequestCycle cycle, Throwable JavaDoc cause);
44 }
Popular Tags