KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > core > jsdkapi > GenericDispatcher


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */

64
65 package com.jcorporate.expresso.core.jsdkapi;
66
67 import com.jcorporate.expresso.core.misc.StringUtil;
68 import org.apache.log4j.Logger;
69
70 import javax.servlet.RequestDispatcher JavaDoc;
71 import javax.servlet.ServletException JavaDoc;
72 import javax.servlet.http.HttpServletRequest JavaDoc;
73 import javax.servlet.http.HttpServletResponse JavaDoc;
74 import java.io.IOException JavaDoc;
75
76
77 /**
78  * As we no longer support the 2.0 Servlet API, this class is just a wrapper to
79  * the appropriate methods, as they do not vary between 2.1 thru 2.3 of the API.
80  * <p/>
81  * IMPORTANT: The URL's for "forward" and "include" are RELATIVE to the context
82  * root (even if they begin with "/").
83  *
84  * @author Shash Chatterjee
85  */

86 public class GenericDispatcher {
87     private static Logger log = Logger.getLogger(GenericDispatcher.class);
88
89     /**
90      *
91      */

92     public GenericDispatcher() {
93     } /* GenericDispatcher () */
94
95
96     /**
97      * This method is used to forward to a new URL
98      *
99      * @param req javax.servlet.http.HttpServletRequest - The request object
100      * associated with this service call
101      * @param res javax.servlet.http.HttpServletResponse - The response object
102      * associated with this service call.
103      * @param URL java.lang.String - The URL to forward to - relative to the current web-app context root
104      * @throws javax.servlet.ServletException The exception description.
105      * @throws java.io.IOException The exception description.
106      */

107     public static void forward(HttpServletRequest JavaDoc req, HttpServletResponse JavaDoc res,
108                                String JavaDoc URL)
109             throws ServletException JavaDoc, IOException JavaDoc {
110         StringUtil.assertNotBlank(URL, "URL to forward to may not be blank");
111
112         // RequestDispatcher rd = req.getRequestDispatcher(res.encodeURL(URL));
113
RequestDispatcher JavaDoc rd = req.getRequestDispatcher(URL);
114
115         if (rd == null) {
116             throw new ServletException JavaDoc("Request dispatcher was null - cannot forward to URL '" +
117                     URL + "'");
118         }
119         if (log.isDebugEnabled()) {
120             log.debug("Forwarding to '" + URL + "'");
121         }
122
123         rd.forward(req, res);
124     } /* forward(HttpServletRequest, HttpServletResponse, */
125
126
127     /* String) */
128     /**
129      * This method is used to include the contents of a URL.
130      *
131      * @param req javax.servlet.http.HttpServletRequest - The request object
132      * associated with this service call
133      * @param res javax.servlet.http.HttpServletResponse - The response object
134      * associated with this service call.
135      * @param URL java.lang.String - The URL to forward to - relative to the current web-app context root
136      * @throws javax.servlet.ServletException The exception description.
137      * @throws java.io.IOException The exception description.
138      */

139     public static void include(HttpServletRequest JavaDoc req, HttpServletResponse JavaDoc res,
140                                String JavaDoc URL)
141             throws ServletException JavaDoc, IOException JavaDoc {
142         StringUtil.assertNotBlank(URL, "URL to include may not be blank");
143
144         // RequestDispatcher rd = req.getRequestDispatcher(res.encodeURL(URL));
145
RequestDispatcher JavaDoc rd = req.getRequestDispatcher(URL);
146
147         if (rd == null) {
148             throw new ServletException JavaDoc("Request dispatcher was null - cannot include URL '" +
149                     URL + "'");
150         }
151         if (log.isDebugEnabled()) {
152             log.debug("Including '" + URL + "'");
153         }
154
155         rd.include(req, res);
156     } /* include(HttpServletRequest, HttpServletResponse, */
157
158
159     /* String) */
160     /**
161      * API 2.2 actually implements the getContextPath method, so we
162      * return the result directly.
163      *
164      * @param req The HttpServletRequest object
165      * @return java.lang.String
166      */

167     public static String JavaDoc getContextPath(HttpServletRequest JavaDoc req) {
168         return req.getContextPath();
169     } /* getContextPath(HttpServletRequest) */
170
171 } /* ServletAPI2_2Dispatcher */
172
Popular Tags