| package org.apache.turbine.modules.layouts; |
| |
| /* ==================================================================== |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 2001-2003 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Apache" and "Apache Software Foundation" and |
| * "Apache Turbine" must not be used to endorse or promote products |
| * derived from this software without prior written permission. For |
| * written permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * "Apache Turbine", nor may "Apache" appear in their name, without |
| * prior written permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| |
| import org.apache.commons.logging.Log; |
| import org.apache.commons.logging.LogFactory; |
| |
| import org.apache.turbine.TurbineConstants; |
| import org.apache.turbine.modules.Layout; |
| import org.apache.turbine.pipeline.PipelineData; |
| import org.apache.turbine.services.velocity.TurbineVelocity; |
| import org.apache.turbine.util.RunData; |
| import org.apache.turbine.util.template.TemplateNavigation; |
| import org.apache.turbine.util.template.TemplateScreen; |
| |
| import org.apache.velocity.context.Context; |
| |
| /** |
| * This Layout module allows Velocity templates |
| * to be used as layouts. It will stream directly the output of |
| * the layout and navigation templates to the output writer without |
| * using a screen. Use this if you have a large page to output |
| * and won't buffer it in the memory. |
| * |
| * @author <a href="mailto:raphael@apache.org">Raphaël Luta</a> |
| * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a> |
| * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a> |
| * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a> |
| * @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a> |
| * @version $Id$ |
| */ |
| public class VelocityDirectLayout |
| extends Layout |
| { |
| /** Logging */ |
| private static Log log = LogFactory.getLog(VelocityDirectLayout.class); |
| |
| /** The prefix for lookup up layout pages */ |
| private String prefix = TurbineConstants.LAYOUT_PREFIX + "/"; |
| |
| /** |
| * Method called by LayoutLoader. |
| * |
| * @deprecated Use the PipelineData version instead |
| * @param data Turbine information. |
| * @exception Exception a generic exception. |
| */ |
| public void doBuild(RunData data) |
| throws Exception |
| { |
| // Get the context needed by Velocity. |
| Context context = TurbineVelocity.getContext(data); |
| |
| // variable for the screen in the layout template |
| context.put(TurbineConstants.SCREEN_PLACEHOLDER, |
| new TemplateScreen(data)); |
| |
| // variable to reference the navigation screen in the layout template |
| context.put(TurbineConstants.NAVIGATION_PLACEHOLDER, |
| new TemplateNavigation(data)); |
| |
| // Grab the layout template set in the VelocityPage. |
| // If null, then use the default layout template |
| // (done by the TemplateInfo object) |
| String templateName = data.getTemplateInfo().getLayoutTemplate(); |
| |
| // Set the locale and content type |
| data.getResponse().setLocale(data.getLocale()); |
| data.getResponse().setContentType(data.getContentType()); |
| |
| log.debug("Now trying to render layout " + templateName); |
| |
| // Finally, generate the layout template and send it to the browser |
| TurbineVelocity.handleRequest(context, |
| prefix + templateName, data.getOut()); |
| } |
| |
| /** |
| * Method called by LayoutLoader. |
| * |
| * |
| * @param data PipelineData |
| * @throws Exception generic exception |
| */ |
| public void doBuild(PipelineData pipelineData) |
| throws Exception |
| { |
| RunData data = (RunData) getRunData(pipelineData); |
| // Get the context needed by Velocity. |
| Context context = TurbineVelocity.getContext(pipelineData); |
| |
| // variable for the screen in the layout template |
| context.put(TurbineConstants.SCREEN_PLACEHOLDER, |
| new TemplateScreen(data)); |
| |
| // variable to reference the navigation screen in the layout template |
| context.put(TurbineConstants.NAVIGATION_PLACEHOLDER, |
| new TemplateNavigation(data)); |
| |
| // Grab the layout template set in the VelocityPage. |
| // If null, then use the default layout template |
| // (done by the TemplateInfo object) |
| String templateName = data.getTemplateInfo().getLayoutTemplate(); |
| |
| // Set the locale and content type |
| data.getResponse().setLocale(data.getLocale()); |
| data.getResponse().setContentType(data.getContentType()); |
| |
| log.debug("Now trying to render layout " + templateName); |
| |
| // Finally, generate the layout template and send it to the browser |
| TurbineVelocity.handleRequest(context, |
| prefix + templateName, data.getOut()); |
| } |
| |
| |
| } |
