org.norther.tammi.spray.servlet
Class DefaultJSPEngine

java.lang.Object
  org.norther.tammi.core.base.Adaptee
      org.norther.tammi.core.config.DefaultConfigurable
          org.norther.tammi.spray.engine.AbstractTemplateEngine
              org.norther.tammi.spray.servlet.DefaultServletEngine
                  org.norther.tammi.spray.servlet.DefaultJSPEngine

All Implemented Interfaces:

Serializable, EventListener, NotificationBroadcaster, NotificationEmitter, TraceListener, Manageable, MBeanDelegate, Refreshable, Startable, CacheClient, Configurable, TemplateEngine, JSPEngine, ServletEngine

public class DefaultJSPEngine
extends DefaultServletEngine
implements JSPEngine

DefaultJSPEngine implements TemplateEngine for JSP templates.

Author:

Ilkka Priha

See Also:

Serialized Form

Field Summary

Fields inherited from class org.norther.tammi.core.config.DefaultConfigurable

MODIFIED, SYNCHRONIZED, UNMODIFIED

Fields inherited from class org.norther.tammi.core.base.Adaptee

ADAPTEE_NOTIF_DESCRIPTION, ADAPTEE_NOTIFICATIONS

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

CONTEXT_NAME_PROPERTY, FOLDER_PATHS_PROPERTY, FORWARDED_PROPERTY, TEMPLATE_KEY_PROPERTY

Fields inherited from interface org.norther.tammi.core.base.MBeanDelegate

ARRAY_TYPE, OBJECT_TYPE, PRIMITIVE_TYPE, STRING_TYPE

Constructor Summary

DefaultJSPEngine()
Constructs a new engine.

Method Summary

protected void	dispatch(String path, TemplateContext context, ServletRequest request, ServletResponse response, Writer writer) Dispatches the specified template path.
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 class org.norther.tammi.spray.servlet.DefaultServletEngine

addFolderPath, addFolderPath, checkProperties, clearFolders, getContextName, getFolderPaths, getTemplateKey, isForwarded, postmanaged, process, removeFolderPath, setContextName, setFolderPaths, setForwarded, setTemplateKey, templateExists, unmanaged, updateProperties

Methods inherited from class org.norther.tammi.spray.engine.AbstractTemplateEngine

clearCached, evaluate, evaluate, evaluate, execute, execute, execute, expireCached, expireFraction, getCache, getDefaultEncoding, getRefreshed, getTemplateEncoding, isCachingDisabled, isStarted, refresh, removeCache, resolveLocalizedTemplate, setCachingDisabled, setDefaultEncoding, start, stop

Methods inherited from class org.norther.tammi.core.config.DefaultConfigurable

addProperty, addProperty, clearProperties, containsProperty, getConfigKey, getConfiguration, getModifiedState, getProperties, getProperty, getPropertyFilePath, indexOfProperty, loadConfiguration, loadConfiguration, loadConfiguration, modified, propertyMap, propertyMap, removeProperty, removeProperty, setConfigKey, setModifiedState, setProperties, setProperty, setPropertyFilePath, setPropertyFilePath, storeProperties

Methods inherited from class org.norther.tammi.core.base.Adaptee

addAdaptee, addNotificationListener, getAttributeSupport, getBroker, getCanonicalName, getDomain, getFactory, getLoader, getLog, getLog, getMBean, getMBeanServer, getNotificationInfo, getObjectName, getRegistrationTime, getSequenceNumber, hasListeners, isRegistered, premanaged, removeNotificationListener, removeNotificationListener, sendNotification, sendNotification, sendNotification, sendNotification, unregister

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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, clearProperties, containsProperty, getConfigKey, getProperties, getProperty, getPropertyFilePath, indexOfProperty, propertyMap, propertyMap, removeProperty, removeProperty, setConfigKey, setProperties, setProperty, setPropertyFilePath, setPropertyFilePath, storeProperties

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

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

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

getRefreshed, refresh

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

isStarted, start, stop

Constructor Detail

DefaultJSPEngine

public DefaultJSPEngine()

Constructs a new engine.

Method Detail

isContextTools

public boolean isContextTools()

Description copied from interface: JSPEngine

Gets the context tools option.

Specified by:

isContextTools in interface JSPEngine

Returns:

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

setContextTools

public void setContextTools(boolean option)

Description copied from interface: JSPEngine

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

Specified by:

setContextTools in interface JSPEngine

Parameters:

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

getToolPrefix

public String getToolPrefix()

Description copied from interface: JSPEngine

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

Specified by:

getToolPrefix in interface JSPEngine

Returns:

return the tool prefix.

setToolPrefix

public void setToolPrefix(String prefix)

Description copied from interface: JSPEngine

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.

Specified by:

setToolPrefix in interface JSPEngine

Parameters:

prefix - tool prefix.

dispatch

protected void dispatch(String path,
                        TemplateContext context,
                        ServletRequest request,
                        ServletResponse response,
                        Writer writer)
                 throws IOException,
                        ServletException

Description copied from class: DefaultServletEngine

Dispatches the specified template path.

Overrides:

dispatch in class DefaultServletEngine

Parameters:

path - the resolved template path.

context - the template context.

request - the servlet request.

response - the servlet response.

writer - the content writer.

Throws:

IOException - on I/O errors.

ServletException - on servlet errors.