package org.apache.turbine.modules.layouts;

 /*

  * Licensed to the Apache Software Foundation (ASF) under one

  * or more contributor license agreements.  See the NOTICE file

  * distributed with this work for additional information

  * regarding copyright ownership.  The ASF licenses this file

  * to you under the Apache License, Version 2.0 (the

  * "License"); you may not use this file except in compliance

  * with the License.  You may obtain a copy of the License at

  *

  *   http://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing,

  * software distributed under the License is distributed on an

  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

  * KIND, either express or implied.  See the License for the

  * specific language governing permissions and limitations

  * under the License.

  */

 import org.apache.commons.logging.Log;

 import org.apache.commons.logging.LogFactory;

 import org.apache.turbine.TurbineConstants;

 import org.apache.turbine.annotation.TurbineService;

 import org.apache.turbine.modules.Layout;

 import org.apache.turbine.pipeline.PipelineData;

 import org.apache.turbine.services.velocity.VelocityService;

 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: VelocityDirectLayout.java 1706239 2015-10-01 13:18:35Z tv $

  */

 public class VelocityDirectLayout

     extends Layout

 {

     /** Logging */

     private static Log log = LogFactory.getLog(VelocityDirectLayout.class);

     /** The prefix for lookup up layout pages */

     private String prefix = Layout.PREFIX + "/";

     /** Injected service instance */

     @TurbineService

     private VelocityService velocityService;

     /**

      * Method called by LayoutLoader.

      *

      *

      * @param pipelineData PipelineData

      * @throws Exception generic exception

      */

     @Override

     public void doBuild(PipelineData pipelineData)

         throws Exception

     {

         RunData data = getRunData(pipelineData);

         // Get the context needed by Velocity.

         Context context = velocityService.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

         velocityService.handleRequest(context,

                 prefix + templateName, data.getResponse().getOutputStream());

     }

 }