Package org.apache.turbine.services.jsp
Interface JspService
-
- All Known Implementing Classes:
TurbineJspService
public interface JspService extends Service
Implementations of the JspService interface.- Author:
- John D. McNally
-
-
Field Summary
Fields Modifier and Type Field Description static int
BUFFER_SIZE_DEFAULT
Default Value for Jsp Page Buffer Sizestatic String
BUFFER_SIZE_KEY
Property for Jsp Page Buffer Sizestatic String
JSP_EXTENSION
The default extension of JSPsstatic String
LINK
The key used to store an instance of JspLink in the requeststatic String
PIPELINE_DATA
The key used to store an instance of PipelineData in the requeststatic String
SERVICE_NAME
The name used to specify this service in Turbine.propertiesstatic String
TEMPLATE_PATH_KEY
Property key for Template Pathes
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addDefaultObjects(PipelineData pipelineData)
Adds some convenience objects to the request.int
getDefaultBufferSize()
Returns the default buffer size of the JspServiceString
getRelativeTemplateName(String template)
Searches for a template in the default.template path[s] and returns the template name with a relative path which is required by javax.servlet.RequestDispatchervoid
handleRequest(PipelineData pipelineData, String templateName)
executes the JSP given by templateName.void
handleRequest(PipelineData pipelineData, String templateName, boolean isForward)
executes the JSP given by templateName.-
Methods inherited from interface org.apache.turbine.services.Initable
getInit, init, init, setInitableBroker, shutdown
-
Methods inherited from interface org.apache.turbine.services.Service
getConfiguration, getName, getProperties, setName, setServiceBroker
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
The name used to specify this service in Turbine.properties- See Also:
- Constant Field Values
-
PIPELINE_DATA
static final String PIPELINE_DATA
The key used to store an instance of PipelineData in the request- See Also:
- Constant Field Values
-
LINK
static final String LINK
The key used to store an instance of JspLink in the request- See Also:
- Constant Field Values
-
JSP_EXTENSION
static final String JSP_EXTENSION
The default extension of JSPs- See Also:
- Constant Field Values
-
TEMPLATE_PATH_KEY
static final String TEMPLATE_PATH_KEY
Property key for Template Pathes- See Also:
- Constant Field Values
-
BUFFER_SIZE_KEY
static final String BUFFER_SIZE_KEY
Property for Jsp Page Buffer Size- See Also:
- Constant Field Values
-
BUFFER_SIZE_DEFAULT
static final int BUFFER_SIZE_DEFAULT
Default Value for Jsp Page Buffer Size- See Also:
- Constant Field Values
-
-
Method Detail
-
addDefaultObjects
void addDefaultObjects(PipelineData pipelineData)
Adds some convenience objects to the request. For example an instance of JspLink which can be used to generate links to other templates.- Parameters:
pipelineData
- the Turbine PipelineData object
-
handleRequest
void handleRequest(PipelineData pipelineData, String templateName, boolean isForward) throws TurbineException
executes the JSP given by templateName.- Parameters:
pipelineData
- A PipelineData ObjecttemplateName
- The template to executeisForward
- whether to perform a forward or include.- Throws:
TurbineException
- If a problem occurred while executing the JSP
-
handleRequest
void handleRequest(PipelineData pipelineData, String templateName) throws TurbineException
executes the JSP given by templateName.- Parameters:
pipelineData
- A PipelineData ObjecttemplateName
- The template to execute- Throws:
TurbineException
- If a problem occurred while executing the JSP
-
getDefaultBufferSize
int getDefaultBufferSize()
Returns the default buffer size of the JspService- Returns:
- The default buffer size.
-
getRelativeTemplateName
String getRelativeTemplateName(String template)
Searches 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
-
-