View Javadoc
1 package org.apache.turbine.services.velocity; 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 java.io.OutputStream; 58 import java.io.Writer; 59 import org.apache.turbine.services.TurbineServices; 60 import org.apache.turbine.util.RunData; 61 import org.apache.velocity.context.Context; 62 63 /*** 64 * This is a simple static accessor to common Velocity tasks such as 65 * getting an instance of a context as well as handling a request for 66 * processing a template. 67 * <pre> 68 * Context context = TurbineVelocity.getContext(data); 69 * context.put("message", "Hello from Turbine!"); 70 * String results = TurbineVelocity.handleRequest(context, "helloWorld.vm"); 71 * data.getPage().getBody().addElement(results); 72 * </pre> 73 * 74 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a> 75 * @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a> 76 * @author <a href="mailto:jvanzyl@periapt.com.com">Jason van Zyl</a> 77 * @version $Id: TurbineVelocity.java,v 1.3 2002/07/11 16:53:23 mpoeschl Exp $ 78 */ 79 public abstract class TurbineVelocity 80 { 81 /*** 82 * Utility method for accessing the service 83 * implementation 84 * 85 * @return a VelocityService implementation instance 86 */ 87 protected static VelocityService getService() 88 { 89 return (VelocityService)TurbineServices 90 .getInstance().getService(VelocityService.SERVICE_NAME); 91 } 92 93 /*** 94 * This allows you to pass in a context and a path to a template 95 * file and then grabs an instance of the velocity service and 96 * processes the template and returns the results as a String 97 * object. 98 * 99 * @param context A Context. 100 * @param templateFilePath The path for the template files. 101 * @return A String. 102 * @exception Exception, a generic exception. 103 */ 104 public static String handleRequest(Context context, String template) 105 throws Exception 106 { 107 return getService().handleRequest(context, template); 108 } 109 110 /*** 111 * Process the request and fill in the template with the values 112 * you set in the Context. 113 * 114 * @param context A Context. 115 * @param filename A String with the filename of the template. 116 * @param out A OutputStream where we will write the process template as 117 * a String. 118 * @exception Exception, a generic exception. 119 */ 120 public static void handleRequest(Context context, 121 String template, 122 OutputStream out) 123 throws Exception 124 { 125 getService().handleRequest(context, template, out); 126 } 127 128 /*** 129 * Process the request and fill in the template with the values 130 * you set in the Context. 131 * 132 * @param context A Context. 133 * @param filename A String with the filename of the template. 134 * @param writer A Writer where we will write the process template as 135 * a String. 136 * @exception Exception, a generic exception. 137 */ 138 public static void handleRequest(Context context, 139 String template, 140 Writer writer) 141 throws Exception 142 { 143 getService().handleRequest(context, template, writer); 144 } 145 146 /*** 147 * This returns a Context that you can pass into handleRequest 148 * once you have populated it with information that the template 149 * will know about. 150 * 151 * @param data A Turbine RunData. 152 * @return A Context. 153 */ 154 public static Context getContext(RunData data) 155 { 156 return getService().getContext(data); 157 } 158 159 /*** 160 * This method returns a blank Context object. 161 * 162 * @return A WebContext. 163 */ 164 public static Context getContext() 165 { 166 return getService().getContext(); 167 } 168 169 /*** 170 * Performs post-request actions (releases context 171 * tools back to the object pool). 172 * 173 * @param context a Velocity Context 174 */ 175 public static void requestFinished(Context context) 176 { 177 getService().requestFinished(context); 178 } 179 }

This page was automatically generated by Maven