org.norther.tammi.spray.servlet
Interface JSPEngine

All Superinterfaces:

CacheClient<String,String>, Configurable, ForwardEngine, Refreshable, Startable, TemplateEngine

All Known Implementing Classes:

DefaultJSPEngine

public interface JSPEngine
extends ForwardEngine

JSPEngine is an extension to ServletEngine for rendering JSP templates.

Version:

$Id: JSPEngine.java,v 1.19 2009/09/28 15:08:27 cvsimp Exp $

Author:

Ilkka Priha

Field Summary

Fields inherited from interface org.norther.tammi.spray.servlet.ForwardEngine

CONTEXT_NAME_PROPERTY, FOLDER_PATHS_PROPERTY, FORWARDED_PROPERTY, TEMPLATE_KEY_PROPERTY

Method Summary

String	getToolPrefix() Gets the prefix to be applied to tool attribute keys if the transfer tools option is set.
boolean	isContextTools() Gets the context tools option.
void	setContextTools(boolean option) Sets the context tools option.
void	setToolPrefix(String prefix) Sets the prefix to be applied to tool attribute keys if the tranfer tools option set.

Methods inherited from interface org.norther.tammi.spray.servlet.ForwardEngine

addFolderPath, addFolderPath, clearFolders, getContextName, getFolderPaths, getTemplateKey, isForwarded, removeFolderPath, setContextName, setFolderPaths, setForwarded, setTemplateKey

Methods inherited from interface org.norther.tammi.spray.engine.TemplateEngine

evaluate, evaluate, evaluate, execute, execute, execute, getDefaultEncoding, resolveLocalizedTemplate, setDefaultEncoding, templateExists

Methods inherited from interface org.norther.tammi.core.config.Configurable

addProperty, addProperty, addPropertyFilePath, addPropertyFilePath, clearProperties, containsProperty, getConfigKey, getProperties, getProperty, getPropertyFilePath, getPropertyFilePaths, indexOfProperty, propertyMap, propertyMap, removeProperty, removeProperty, removePropertyFilePath, setConfigKey, setProperties, setProperty, setPropertyFilePath, setPropertyFilePath, setPropertyFilePaths, setPropertyFilePaths, storeProperties

Methods inherited from interface org.norther.tammi.core.base.Startable

isStarted, start, stop

Methods inherited from interface org.norther.tammi.core.cache.CacheClient

clearCached, expireCached, expireFraction, getCache, getSharedCacheName, isCachingDisabled, removeCache, setCachingDisabled, setSharedCacheName

Methods inherited from interface org.norther.tammi.core.base.Refreshable

getRefreshed, refresh

Method Detail

isContextTools

boolean isContextTools()

Gets the context tools option.

Returns:

true if the context tools option is set, otherwise false.

setContextTools

void setContextTools(boolean option)

Sets the context tools option. If set, the template context tools are included in the JSP request scope as request attributes.

Parameters:

option - true to set the context tools option, otherwise false.

getToolPrefix

String getToolPrefix()

Gets the prefix to be applied to tool attribute keys if the transfer tools option is set.

Returns:

return the tool prefix.

setToolPrefix

void setToolPrefix(String prefix)

Sets the prefix to be applied to tool attribute keys if the tranfer tools option set. The purpose of the prefix is to avoid collisions within the JSP request scope.

Parameters:

prefix - tool prefix.