001: package org.apache.turbine.services.jsp;
002:
003: /*
004: * Licensed to the Apache Software Foundation (ASF) under one
005: * or more contributor license agreements. See the NOTICE file
006: * distributed with this work for additional information
007: * regarding copyright ownership. The ASF licenses this file
008: * to you under the Apache License, Version 2.0 (the
009: * "License"); you may not use this file except in compliance
010: * with the License. You may obtain a copy of the License at
011: *
012: * http://www.apache.org/licenses/LICENSE-2.0
013: *
014: * Unless required by applicable law or agreed to in writing,
015: * software distributed under the License is distributed on an
016: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017: * KIND, either express or implied. See the License for the
018: * specific language governing permissions and limitations
019: * under the License.
020: */
021:
022: import org.apache.turbine.services.Service;
023:
024: import org.apache.turbine.util.RunData;
025: import org.apache.turbine.util.TurbineException;
026:
027: /**
028: * Implementations of the JspService interface.
029: *
030: * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
031: * @version $Id: JspService.java 534527 2007-05-02 16:10:59Z tv $
032: */
033: public interface JspService extends Service {
034: /** The name used to specify this service in Turbine.properties */
035: String SERVICE_NAME = "JspService";
036:
037: /** The key used to store an instance of RunData in the request */
038: String RUNDATA = "rundata";
039:
040: /** The key used to store an instance of JspLink in the request */
041: String LINK = "link";
042:
043: /** The default extension of JSPs */
044: String JSP_EXTENSION = "jsp";
045:
046: /** Property key for Template Pathes */
047: String TEMPLATE_PATH_KEY = "templates";
048:
049: /** Property for Jsp Page Buffer Size */
050: String BUFFER_SIZE_KEY = "buffer.size";
051:
052: /** Default Value for Jsp Page Buffer Size */
053: int BUFFER_SIZE_DEFAULT = 8192;
054:
055: /**
056: * Adds some convenience objects to the request. For example an instance
057: * of JspLink which can be used to generate links to other templates.
058: *
059: * @param data the turbine rundata object
060: */
061: void addDefaultObjects(RunData data);
062:
063: /**
064: * executes the JSP given by templateName.
065: *
066: * @param data A RunData Object
067: * @param templateName The template to execute
068: * @param isForward whether to perform a forward or include.
069: *
070: * @throws TurbineException If a problem occured while executing the JSP
071: */
072: void handleRequest(RunData data, String templateName,
073: boolean isForward) throws TurbineException;
074:
075: /**
076: * executes the JSP given by templateName.
077: *
078: * @param data A RunData Object
079: * @param templateName The template to execute
080: *
081: * @throws TurbineException If a problem occured while executing the JSP
082: */
083: void handleRequest(RunData data, String templateName)
084: throws TurbineException;
085:
086: /**
087: * Returns the default buffer size of the JspService
088: *
089: * @return The default buffer size.
090: */
091: int getDefaultBufferSize();
092:
093: /**
094: * Searchs for a template in the default.template path[s] and
095: * returns the template name with a relative path which is required
096: * by <a href="http://java.sun.com/products/servlet/2.3/javadoc/javax/servlet/ServletContext.html#getRequestDispatcher(java.lang.String)">javax.servlet.RequestDispatcher</a>
097: *
098: * @param template The name of the template to search for.
099: *
100: * @return the template with a relative path
101: */
102: String getRelativeTemplateName(String template);
103:
104: }
|