org.rythmengine.web.servlet

Class RythmServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.rythmengine.web.servlet.RythmServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class RythmServlet
extends javax.servlet.http.HttpServlet

A servlet to process Rythm templates. This is comparable to the the JspServlet for JSP-based applications.

The servlet provides the following features:

• renders Rythm templates
• provides transparent access to the servlet request attributes, servlet session attributes and servlet context attributes by auto-searching them
• logs to the logging facility of the servlet API

RythmViewServlet supports the following configuration parameters in web.xml:

org.rythmengine.properties

Path and name of the Rythm configuration file. The path must be relative to the web application root directory. If this parameter is not present, Rythm will check for a properties file at '/WEB-INF/rythm.properties'. If no file is found there, then Rythm is initialized with the settings in the classpath at 'org.rythmengine.web.servlet.properties'.

org.rythmengine.tools.shared.config

By default, this is true. If set to false, then the RythmView used by this servlet will not be shared with RythmViewFilters, other RythmViewServlets or org.rythmengine.tools.view.jsp.RythmViewTags in the application.

org.rythmengine.tools.loadDefaults

By default, this is true. If set to false, then the default toolbox configuration will not be added to your (if any) custom configuration. NOTE: The default configuration will also be suppressed if you are using a deprecated toolbox.xml format and do not explicitly set this to true.

org.rythmengine.tools.cleanConfiguration

By default, this is false. If set to true, then then the final toolbox configuration (the combination of any custom one(s) provided by yourself and/or the default configuration(s)) will have all invalid tools, properties, and/or data removed prior to configuring the ToolboxFactory for this servlet by a org.rythmengine.tools.config.ConfigurationCleaner

org.rythmengine.tools.bufferOutput

By default, the processed templates are merged directly into the HttpServletResponse's writer. If this parameter is set to true, then the output of the merge process will be buffered before being fed to the response. This allows the #error method to be overridden to return a "500 Internal Server Error" or at least not return any of the failed request content. Essentially, setting this to true degrades performance in order to enable a more "correct" error response"

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RythmServlet()

Method Summary

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

RythmServlet

public RythmServlet()