org.apache.turbine.services.jsp
Interface JspService

All Superinterfaces:
Initable, Service
All Known Implementing Classes:
TurbineJspService

public interface JspService
extends Service

Implementations of the JspService interface.

Author:
John D. McNally

Field Summary
static java.lang.String LINK
          The key used to store an instance of JspLink in the request
static java.lang.String RUNDATA
          The key used to store an instance of RunData in the request
static java.lang.String SERVICE_NAME
          The name used to specify this service in TurbineResources.properties
 
Method Summary
 void addDefaultObjects(RunData data)
          Adds some useful objects to the request, so they are available to the JSP.
 int getDefaultBufferSize()
          The buffer size
 java.lang.String getRelativeTemplateName(java.lang.String template)
          Searchs for a template in the default.template path[s] and returns the template name with a relative path which is required by javax.servlet.RequestDispatcher
 void handleRequest(RunData data, java.lang.String templateName)
          executes the JSP given by templateName.
 void handleRequest(RunData data, java.lang.String templateName, boolean isForward)
          executes the JSP given by templateName.
 
Methods inherited from interface org.apache.turbine.services.Service
getConfiguration, getName, getProperties, setName, setServiceBroker
 
Methods inherited from interface org.apache.turbine.services.Initable
getInit, init, init, setInitableBroker, shutdown
 

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME
The name used to specify this service in TurbineResources.properties

RUNDATA

public static final java.lang.String RUNDATA
The key used to store an instance of RunData in the request

LINK

public static final java.lang.String LINK
The key used to store an instance of JspLink in the request
Method Detail

addDefaultObjects

public void addDefaultObjects(RunData data)
Adds some useful objects to the request, so they are available to the JSP.

handleRequest

public void handleRequest(RunData data,
                          java.lang.String templateName,
                          boolean isForward)
                   throws TurbineException
executes the JSP given by templateName.

handleRequest

public void handleRequest(RunData data,
                          java.lang.String templateName)
                   throws TurbineException
executes the JSP given by templateName.

getDefaultBufferSize

public int getDefaultBufferSize()
The buffer size

getRelativeTemplateName

public java.lang.String getRelativeTemplateName(java.lang.String template)
Searchs for a template in the default.template path[s] and returns the template name with a relative path which is required by javax.servlet.RequestDispatcher
Parameters:
template - The name of the template to search for.
Returns:
the template with a relative path


Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.