| <?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang=""><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../jacoco-resources/report.gif" type="image/gif"/><title>VelocityLayout.java</title><link rel="stylesheet" href="../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../index.html" class="el_report">Apache Turbine</a> > <a href="index.source.html" class="el_package">org.apache.turbine.modules.layouts</a> > <span class="el_source">VelocityLayout.java</span></div><h1>VelocityLayout.java</h1><pre class="source lang-java linenums">package org.apache.turbine.modules.layouts; |
| |
| |
| import jakarta.servlet.http.HttpServletResponse; |
| |
| import org.apache.logging.log4j.LogManager; |
| |
| /* |
| * 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.logging.log4j.Logger; |
| import org.apache.turbine.Turbine; |
| 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.velocity.context.Context; |
| |
| /** |
| * This Layout module allows Velocity templates |
| * to be used as layouts. |
| * |
| * @author <a href="mailto:tv@apache.org">Thomas Vandahl</a> |
| */ |
| <span class="nc" id="L43">public abstract class VelocityLayout implements Layout</span> |
| { |
| /** Logging */ |
| <span class="nc" id="L46"> protected final Logger log = LogManager.getLogger(this.getClass());</span> |
| |
| /** The prefix for lookup up layout pages */ |
| protected static final String prefix = PREFIX + "/"; |
| |
| /** Injected service instance */ |
| @TurbineService |
| protected VelocityService velocityService; |
| |
| /** |
| * Method called by LayoutLoader. |
| * |
| * |
| * @param pipelineData PipelineData |
| * @throws Exception generic exception |
| */ |
| @Override |
| public void doBuild(PipelineData pipelineData) |
| throws Exception |
| { |
| <span class="nc" id="L66"> RunData data = pipelineData.getRunData();</span> |
| // Get the context needed by Velocity. |
| <span class="nc" id="L68"> Context context = velocityService.getContext(pipelineData);</span> |
| |
| // Provide objects to Velocity context |
| <span class="nc" id="L71"> populateContext(pipelineData, context);</span> |
| |
| // Grab the layout template set in the VelocityPage. |
| // If null, then use the default layout template |
| // (done by the TemplateInfo object) |
| <span class="nc" id="L76"> String templateName = data.getTemplateInfo().getLayoutTemplate();</span> |
| |
| // Set the locale and content type |
| <span class="nc" id="L79"> data.getResponse().setLocale(data.getLocale());</span> |
| <span class="nc" id="L80"> data.getResponse().setContentType(data.getContentType());</span> |
| |
| <span class="nc" id="L82"> log.debug("Now trying to render layout {}", templateName);</span> |
| |
| // Finally, generate the layout template and send it to the browser |
| <span class="nc" id="L85"> render(pipelineData, context, templateName);</span> |
| <span class="nc" id="L86"> }</span> |
| |
| /** |
| * Populate Velocity context |
| * |
| * @param pipelineData PipelineData |
| * @param context the Velocity context |
| * |
| * @throws Exception if evaluation fails |
| */ |
| protected abstract void populateContext(PipelineData pipelineData, Context context) |
| throws Exception; |
| |
| /** |
| * Render layout |
| * |
| * @param pipelineData PipelineData |
| * @param context the Velocity context |
| * @param templateName relative path to Velocity template |
| * |
| * @throws Exception if rendering fails |
| */ |
| protected void render(PipelineData pipelineData, Context context, String templateName) |
| throws Exception |
| { |
| <span class="nc" id="L111"> velocityService.handleRequest(context,</span> |
| prefix + templateName, |
| <span class="nc" id="L113"> pipelineData.get(Turbine.class, HttpServletResponse.class)</span> |
| <span class="nc" id="L114"> .getOutputStream());</span> |
| <span class="nc" id="L115"> }</span> |
| } |
| </pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.12.202403310830</span></div></body></html> |
