1 package org.apache.turbine.modules.screens;
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 // Turbine/ECS Imports
58 import org.apache.ecs.ConcreteElement;
59 import org.apache.ecs.StringElement;
60 import org.apache.turbine.util.RunData;
61 import org.apache.turbine.util.StringUtils;
62 import org.apache.turbine.services.resources.TurbineResources;
63 import org.apache.turbine.services.velocity.TurbineVelocity;
64 import org.apache.turbine.services.template.TurbineTemplate;
65
66 // Velocity Stuff
67 import org.apache.velocity.context.Context;
68
69
70 /***
71 * Base Velocity Screen. The buildTemplate() assumes the template
72 * parameter has been set in the RunData object. This provides the
73 * ability to execute several templates from one Screen.
74 *
75 * <p>
76 *
77 * If you need more specific behavior in your application, extend this
78 * class and override the doBuildTemplate() method.
79 *
80 * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
81 * @version $Id: VelocityDirectScreen.java,v 1.1 2001/08/19 17:59:18 mpoeschl Exp $
82 */
83 public class VelocityDirectScreen extends VelocityScreen
84 {
85
86 /***
87 * This builds the Velocity template.
88 *
89 * @param data Turbine information.
90 * @return A ConcreteElement.
91 * @exception Exception, a generic exception.
92 */
93 public ConcreteElement buildTemplate( RunData data ) throws Exception
94 {
95 StringElement output = new StringElement();
96 String screenData = null;
97 Context context = TurbineVelocity.getContext(data);
98
99 // This will already be properly set and will not be null
100 // because of TemplateSessionValidator.
101 String templateName = TurbineTemplate.getScreenTemplateName(
102 data.getTemplateInfo().getScreenTemplate() );
103
104 // Template service adds the leading slash, but make it sure.
105 if ((templateName.length() > 0) &&
106 (templateName.charAt(0) != '/'))
107 {
108 templateName = '/' + templateName;
109 }
110
111 try
112 {
113 // if a layout has been defined return the results, otherwise
114 // send the results directly to the output stream.
115 if (getLayout(data) == null)
116 {
117 TurbineVelocity.handleRequest(context,
118 "screens" + templateName,
119 data.getResponse().getOutputStream());
120 }
121 else
122 {
123 TurbineVelocity.handleRequest(context,
124 "screens" + templateName,
125 data.getOut());
126 }
127 }
128 catch (Exception e)
129 {
130 // If there is an error, build a $processingException and
131 // attempt to call the error.vm template in the screens
132 // directory.
133 context.put ( "processingException", e.toString() );
134 context.put ( "stackTrace", StringUtils.stackTrace(e) );
135 templateName = TurbineResources.getString(
136 "template.error", "/error.vm");
137 if ((templateName.length() > 0) &&
138 (templateName.charAt(0) != '/'))
139 {
140 templateName = '/' + templateName;
141 }
142 TurbineVelocity.handleRequest(context,
143 "screens" + templateName,
144 data.getOut());
145 }
146
147 // package the response in an ECS element
148 if (screenData != null)
149 {
150 output.setFilterState(false);
151 output.addElement(screenData);
152 }
153 return output;
154 }
155 }
This page was automatically generated by Maven