KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > turbine > pipeline > JspRenderer


1 package org.apache.turbine.pipeline;
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 2001 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution,
22  * if any, must include the following acknowledgment:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowledgment may appear in the software itself,
26  * if and wherever such third-party acknowledgments normally appear.
27  *
28  * 4. The names "Apache" and "Apache Software Foundation" and
29  * "Apache Turbine" must not be used to endorse or promote products
30  * derived from this software without prior written permission. For
31  * written permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache",
34  * "Apache Turbine", nor may "Apache" appear in their name, without
35  * prior written permission of the Apache Software Foundation.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the Apache Software Foundation. For more
53  * information on the Apache Software Foundation, please see
54  * <http://www.apache.org/>.
55  */
56
57 import javax.servlet.RequestDispatcher JavaDoc;
58
59 import org.apache.commons.lang.exception.ExceptionUtils;
60 import org.apache.commons.logging.Log;
61 import org.apache.commons.logging.LogFactory;
62 import org.apache.turbine.RunData;
63 import org.apache.turbine.TurbineException;
64
65 /**
66  * Valve to call the JspRenderer.
67  *
68  * @author <a HREF="mailto:jvanzyl@zenplex.com">Jason van Zyl</a>
69  * @version $Id: JspRenderer.java,v 1.5 2002/09/12 15:57:07 kschrader Exp $
70  */
71 public class JspRenderer
72 {
73     private static final Log log = LogFactory.getLog(JspRenderer.class);
74
75     /** The base path[s] prepended to filenames given in arguments */
76     private String JavaDoc[] templatePaths;
77
78     /** The relative path[s] prepended to filenames */
79     private String JavaDoc[] relativeTemplatePaths;
80
81     /** The buffer size for the output stream. */
82     private int bufferSize;
83
84     /**
85      * RunData of the request this Renderer is for.
86      */
87     protected RunData data = null;
88
89     /**
90      * Construct a renderer for the given RunData.
91      */
92     public JspRenderer(RunData data)
93     {
94         this.data = data;
95     }
96
97     /**
98      * The buffer size
99      *
100      */
101     public int getDefaultBufferSize()
102     {
103         return bufferSize;
104     }
105
106     /**
107      * Process the request
108      *
109      * @param RunData
110      * @param String the filename of the template.
111      * @throws TurbineException Any exception trown while processing will be
112      * wrapped into a TurbineException and rethrown.
113      */
114     public void render(String JavaDoc jsp)
115         throws TurbineException
116     {
117         render(jsp, false);
118     }
119     
120     /**
121      * Process the request
122      *
123      * @param RunData
124      * @param String the filename of the template.
125      * @param boolean whether to perform a forward or include.
126      * @throws TurbineException Any exception trown while processing will be
127      * wrapped into a TurbineException and rethrown.
128      */
129     public void render(String JavaDoc jsp, boolean isForward)
130         throws TurbineException
131     {
132         // This obviously can be improved.
133 String JavaDoc jspPath = "/templates/jsp/" + jsp;
134         
135         log.debug("Jsp to render: " + jspPath);
136         
137         if (jspPath == null)
138         {
139             throw new TurbineException(
140                 "JSP " + jsp + " not found in specified paths");
141         }
142         
143         // get the RequestDispatcher for the JSP
144 RequestDispatcher JavaDoc dispatcher = data.getServletContext()
145             .getRequestDispatcher(jspPath);
146         
147         data.getResponse().setBufferSize(8192);
148         data.getResponse().setContentType("text/html");
149         
150         try
151         {
152             if (isForward)
153             {
154                 // forward the request to the JSP
155 dispatcher.forward( data.getRequest(), data.getResponse() );
156             }
157             else
158             {
159                 data.getOut().flush();
160                 // include the JSP
161 dispatcher.include( data.getRequest(), data.getResponse() );
162             }
163         }
164         catch(Exception JavaDoc e)
165         {
166             log.error(ExceptionUtils.getStackTrace(e));
167         }
168     }
169 }
170
Popular Tags