1 package org.apache.turbine.services.webmacro;
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 org.apache.turbine.services.TurbineServices;
59 import org.apache.turbine.util.RunData;
60 import org.webmacro.servlet.WebContext;
61
62 /***
63 * This is a simple static accessor to common WebMacro tasks such as
64 * getting an instance of a context as well as handling a request for
65 * processing a template. It uses the TurbineWebMacroService to
66 * obtain an instance of WebMacro.
67 *
68 * WebContext context = WebMacro.getContext(data);
69 * context.put("message", "Hello from Turbine!");
70 * String results = WebMacro.handleRequest(context,"helloWorld.wm");
71 * data.getPage().getBody().addElement(results);
72 *
73 * @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a>
74 * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
75 * @version $Id: TurbineWebMacro.java,v 1.2 2002/07/11 16:53:23 mpoeschl Exp $
76 * @deprecated
77 */
78 public abstract class TurbineWebMacro
79 {
80 /***
81 * Utility method for accessing the service implementation.
82 *
83 * @return A WebMacroService implementation instance.
84 */
85 protected static final WebMacroService getService()
86 {
87 return (WebMacroService)TurbineServices
88 .getInstance().getService(WebMacroService.SERVICE_NAME);
89 }
90
91 /***
92 * @see org.apache.turbine.services.webmacro.WebMacroService#handleRequest
93 */
94 public static void handleRequest(WebContext context, String filename,
95 OutputStream out)
96 throws Exception
97 {
98 getService().handleRequest(context, filename, out);
99 }
100
101 /***
102 * @see org.apache.turbine.services.webmacro.WebMacroService#handleRequest
103 */
104 public static String handleRequest(WebContext context,
105 String templateFilePath)
106 throws Exception
107 {
108 return getService().handleRequest(context, templateFilePath);
109 }
110
111 /***
112 * This returns a WebContext that you can pass into handleRequest
113 * once you have populated it with information that the template
114 * will know about.
115 *
116 * @param data A Turbine RunData.
117 * @return A WebContext.
118 */
119 public static WebContext getContext(RunData data)
120 {
121 return getService().getContext(data);
122 }
123
124 /***
125 * This method returns a blank WebContext object.
126 *
127 * @return A WebContext.
128 */
129 public static WebContext getContext()
130 {
131 return getService().getContext();
132 }
133 }
This page was automatically generated by Maven