| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| JspService |
|
| 1.0;1 |
| 1 | package org.apache.fulcrum.template.jsp; | |
| 2 | ||
| 3 | ||
| 4 | /* | |
| 5 | * Licensed to the Apache Software Foundation (ASF) under one | |
| 6 | * or more contributor license agreements. See the NOTICE file | |
| 7 | * distributed with this work for additional information | |
| 8 | * regarding copyright ownership. The ASF licenses this file | |
| 9 | * to you under the Apache License, Version 2.0 (the | |
| 10 | * "License"); you may not use this file except in compliance | |
| 11 | * with the License. You may obtain a copy of the License at | |
| 12 | * | |
| 13 | * http://www.apache.org/licenses/LICENSE-2.0 | |
| 14 | * | |
| 15 | * Unless required by applicable law or agreed to in writing, | |
| 16 | * software distributed under the License is distributed on an | |
| 17 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| 18 | * KIND, either express or implied. See the License for the | |
| 19 | * specific language governing permissions and limitations | |
| 20 | * under the License. | |
| 21 | */ | |
| 22 | ||
| 23 | ||
| 24 | ||
| 25 | /** | |
| 26 | * Implementations of the JspService interface. | |
| 27 | * | |
| 28 | * @author <a href="mailto:jmcnally@collab.net">John D. McNally</a> | |
| 29 | */ | |
| 30 | public interface JspService | |
| 31 | { | |
| 32 | String ROLE = JspService.class.getName(); | |
| 33 | ||
| 34 | /** The key used to store an instance of RunData in the request */ | |
| 35 | public static final String RUNDATA = "rundata"; | |
| 36 | /** The key used to store an instance of JspLink in the request */ | |
| 37 | public static final String LINK = "link"; | |
| 38 | ||
| 39 | /** | |
| 40 | * Adds some useful objects to the request, so they are available to the JSP. | |
| 41 | */ | |
| 42 | //public void addDefaultObjects(RunData data); | |
| 43 | ||
| 44 | /** | |
| 45 | * executes the JSP given by templateName. | |
| 46 | */ | |
| 47 | /* | |
| 48 | * public void handleRequest(RunData data, String templateName, boolean isForward) | |
| 49 | * throws ServiceException; | |
| 50 | */ | |
| 51 | ||
| 52 | /** | |
| 53 | * executes the JSP given by templateName. | |
| 54 | */ | |
| 55 | /* | |
| 56 | * public void handleRequest(RunData data, String templateName) | |
| 57 | * throws ServiceException; | |
| 58 | */ | |
| 59 | ||
| 60 | /** | |
| 61 | * The buffer size | |
| 62 | */ | |
| 63 | public int getDefaultBufferSize(); | |
| 64 | ||
| 65 | /** | |
| 66 | * Searchs for a template in the default.template path[s] and | |
| 67 | * returns the template name with a relative path which is required | |
| 68 | * by <a href="http://java.sun.com/products/servlet/2.3/javadoc/javax/servlet/ServletContext.html#getRequestDispatcher(java.lang.String)">javax.servlet.RequestDispatcher</a> | |
| 69 | * | |
| 70 | * @param template The name of the template to search for. | |
| 71 | * @return the template with a relative path | |
| 72 | */ | |
| 73 | public String getRelativeTemplateName(String template); | |
| 74 | ||
| 75 | } |