1 package org.apache.turbine.modules.screens; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 import org.apache.commons.lang.StringUtils; 23 import org.apache.ecs.ConcreteElement; 24 import org.apache.turbine.pipeline.PipelineData; 25 import org.apache.turbine.services.jsp.TurbineJsp; 26 import org.apache.turbine.services.template.TurbineTemplate; 27 import org.apache.turbine.util.RunData; 28 29 /** 30 * Base JSP Screen that should be subclassed by screens that want to 31 * use JSP. Subclasses should override the doBuildTemplate() method. 32 * 33 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a> 34 * @author Frank Y. Kim 35 * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a> 36 * @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a> 37 * @version $Id: BaseJspScreen.java 938645 2010-04-27 20:57:51Z tv $ 38 */ 39 public class BaseJspScreen 40 extends TemplateScreen 41 { 42 /** The prefix for lookup up screen pages */ 43 private String prefix = getPrefix() + "/"; 44 45 /** 46 * Method that sets up beans and forward the request to the JSP. 47 * 48 * @deprecated Use PipelineData version instead. 49 * @param data Turbine information. 50 * @return null - the JSP sends the information. 51 * @exception Exception, a generic exception. 52 */ 53 public ConcreteElement buildTemplate(RunData data) 54 throws Exception 55 { 56 String screenTemplate = data.getTemplateInfo().getScreenTemplate(); 57 // get the name of the JSP we want to use 58 String templateName 59 = TurbineTemplate.getScreenTemplateName(screenTemplate); 60 61 // The Template Service could not find the Screen 62 if (StringUtils.isEmpty(templateName)) 63 { 64 log.error("Screen " + screenTemplate + " not found!"); 65 throw new Exception("Could not find screen for " + screenTemplate); 66 } 67 68 // let service know whether we are using a layout 69 TurbineJsp.handleRequest(data, prefix + templateName, 70 getLayout(data) == null); 71 72 return null; 73 } 74 75 /** 76 * Method that sets up beans and forward the request to the JSP. 77 * 78 * @param data Turbine information. 79 * @return null - the JSP sends the information. 80 * @exception Exception, a generic exception. 81 */ 82 public ConcreteElement buildTemplate(PipelineData pipelineData) 83 throws Exception 84 { 85 RunData data = getRunData(pipelineData); 86 String screenTemplate = data.getTemplateInfo().getScreenTemplate(); 87 // get the name of the JSP we want to use 88 String templateName 89 = TurbineTemplate.getScreenTemplateName(screenTemplate); 90 91 // The Template Service could not find the Screen 92 if (StringUtils.isEmpty(templateName)) 93 { 94 log.error("Screen " + screenTemplate + " not found!"); 95 throw new Exception("Could not find screen for " + screenTemplate); 96 } 97 98 // let service know whether we are using a layout 99 TurbineJsp.handleRequest(pipelineData, prefix + templateName, 100 getLayout(pipelineData) == null); 101 102 return null; 103 } 104 105 /** 106 * Method to be overidden by subclasses to include data in beans, etc. 107 * 108 * @deprecated Use PipelineData version instead. 109 * @param data, the Rundata object 110 * @exception Exception, a generic exception. 111 */ 112 protected void doBuildTemplate(RunData data) 113 throws Exception 114 { 115 // abstract method 116 } 117 118 /** 119 * Method to be overidden by subclasses to include data in beans, etc. 120 * 121 * @param data, the Rundata object 122 * @exception Exception, a generic exception. 123 */ 124 protected void doBuildTemplate(PipelineData pipelineData) 125 throws Exception 126 { 127 // abstract method 128 } 129 130 }