| <?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>VelocityScreen.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.screens</a> > <span class="el_source">VelocityScreen.java</span></div><h1>VelocityScreen.java</h1><pre class="source lang-java linenums">package org.apache.turbine.modules.screens; |
| |
| /* |
| * 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.lang3.StringUtils; |
| import org.apache.commons.lang3.exception.ExceptionUtils; |
| import org.apache.turbine.TurbineConstants; |
| import org.apache.turbine.annotation.TurbineConfiguration; |
| import org.apache.turbine.annotation.TurbineService; |
| import org.apache.turbine.pipeline.PipelineData; |
| import org.apache.turbine.services.template.TemplateService; |
| import org.apache.turbine.services.velocity.VelocityService; |
| import org.apache.turbine.util.RunData; |
| import org.apache.velocity.context.Context; |
| |
| /** |
| * Base Velocity Screen. The buildTemplate() assumes the template |
| * parameter has been set in the PipelineData object. This provides the |
| * ability to execute several templates from one Screen. |
| * |
| * <p> |
| * |
| * If you need more specific behavior in your application, extend this |
| * class and override the doBuildTemplate() method. |
| * |
| * @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$ |
| */ |
| <span class="nc" id="L48">public class VelocityScreen</span> |
| extends TemplateScreen |
| { |
| /** The prefix for lookup up screen pages */ |
| protected static final String prefix = PREFIX + "/"; |
| |
| /** Injected service instance */ |
| @TurbineService |
| protected VelocityService velocity; |
| |
| /** Injected service instance */ |
| @TurbineService |
| protected TemplateService templateService; |
| |
| <span class="nc" id="L62"> @TurbineConfiguration( TurbineConstants.TEMPLATE_ERROR_KEY )</span> |
| protected String templateError = TurbineConstants.TEMPLATE_ERROR_VM; |
| |
| /** |
| * Velocity Screens extending this class should override this |
| * method to perform any particular business logic and add |
| * information to the context. |
| * |
| * @param pipelineData Turbine information. |
| * @param context Context for web pages. |
| * @throws Exception a generic exception. |
| */ |
| protected void doBuildTemplate(PipelineData pipelineData, |
| Context context) |
| throws Exception |
| { |
| // empty |
| <span class="nc" id="L79"> }</span> |
| |
| /** |
| * Needs to be implemented to make TemplateScreen like us. The |
| * actual method that you should override is the one with the |
| * context in the parameter list. |
| * |
| * @param pipelineData Turbine information. |
| * @throws Exception a generic exception. |
| */ |
| @Override |
| protected void doBuildTemplate(PipelineData pipelineData) |
| throws Exception |
| { |
| <span class="nc" id="L93"> doBuildTemplate(pipelineData, velocity.getContext(pipelineData));</span> |
| <span class="nc" id="L94"> }</span> |
| |
| /** |
| * This builds the Velocity template. |
| * |
| * @param pipelineData Turbine information. |
| * @return the content of the screen |
| * @throws Exception a generic exception. |
| */ |
| @Override |
| public String buildTemplate(PipelineData pipelineData) |
| throws Exception |
| { |
| <span class="nc" id="L107"> RunData data = pipelineData.getRunData();</span> |
| <span class="nc" id="L108"> String screenData = null;</span> |
| |
| <span class="nc" id="L110"> Context context = velocity.getContext(pipelineData);</span> |
| |
| <span class="nc" id="L112"> String screenTemplate = data.getTemplateInfo().getScreenTemplate();</span> |
| <span class="nc" id="L113"> String templateName</span> |
| <span class="nc" id="L114"> = templateService.getScreenTemplateName(screenTemplate);</span> |
| |
| // The Template Service could not find the Screen |
| <span class="nc bnc" id="L117" title="All 2 branches missed."> if (StringUtils.isEmpty(templateName))</span> |
| { |
| <span class="nc" id="L119"> log.error("Screen " + screenTemplate + " not found!");</span> |
| <span class="nc" id="L120"> throw new Exception("Could not find screen for " + screenTemplate);</span> |
| } |
| |
| try |
| { |
| // if a layout has been defined return the results, otherwise |
| // send the results directly to the output stream. |
| <span class="nc bnc" id="L127" title="All 2 branches missed."> if (getLayout(pipelineData) == null)</span> |
| { |
| <span class="nc" id="L129"> velocity.handleRequest(context,</span> |
| prefix + templateName, |
| <span class="nc" id="L131"> data.getResponse().getOutputStream());</span> |
| } |
| else |
| { |
| <span class="nc" id="L135"> screenData =</span> |
| <span class="nc" id="L136"> velocity.handleRequest(context, prefix + templateName);</span> |
| } |
| } |
| <span class="nc" id="L139"> catch (Exception e)</span> |
| { |
| // If there is an error, build a $processingException and |
| // attempt to call the error.vm template in the screens |
| // directory. |
| <span class="nc" id="L144"> context.put (TurbineConstants.PROCESSING_EXCEPTION_PLACEHOLDER, e.toString());</span> |
| <span class="nc" id="L145"> context.put (TurbineConstants.STACK_TRACE_PLACEHOLDER, ExceptionUtils.getStackTrace(e));</span> |
| |
| <span class="nc" id="L147"> screenData = velocity.handleRequest(context, prefix + templateError);</span> |
| <span class="nc" id="L148"> }</span> |
| |
| <span class="nc" id="L150"> return screenData;</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> |
