KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > RedirectException


1 // Copyright 2004, 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;
16
17 import org.apache.hivemind.ApplicationRuntimeException;
18
19 /**
20  * Exception thrown to force a redirection to an arbitrary location.
21  * This is used when, after processing a request (such as a form
22  * submission or a link being clicked), it is desirable to go
23  * to some arbitrary new location.
24  *
25  * @author Howard Lewis Ship
26  * @since 1.0.6
27  *
28  **/
29
30 public class RedirectException extends ApplicationRuntimeException
31 {
32     private String JavaDoc _redirectLocation;
33
34     public RedirectException(String JavaDoc redirectLocation)
35     {
36         this(null, redirectLocation);
37     }
38
39     /**
40      * @param message A message describing why the redirection is taking place.
41      * @param redirectLocation The location to redirect to, may be a relative path (relative
42      * to the {@link javax.servlet.ServletContext}).
43      *
44      * @see javax.servlet.http.HttpServletResponse#sendRedirect(String)
45      * @see javax.servlet.http.HttpServletResponse#encodeRedirectURL(String)
46      *
47      **/
48
49     public RedirectException(String JavaDoc message, String JavaDoc redirectLocation)
50     {
51         super(message);
52
53         _redirectLocation = redirectLocation;
54     }
55
56     public String JavaDoc getRedirectLocation()
57     {
58         return _redirectLocation;
59     }
60 }
Popular Tags