Java Doc for VelocityViewServlet.java in  » Template-Engine » Velocity » org » apache » velocity » tools » view » servlet » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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

The servlet provides the following features:

• renders Velocity templates
• provides support for an auto-loaded, configurable toolbox
• 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

VelocityViewServlet supports the following configuration parameters in web.xml:

org.apache.velocity.toolbox

Path and name of the toolbox configuration file. The path must be relative to the web application root directory. If this parameter is not found, the servlet will check for a toolbox file at '/WEB-INF/toolbox.xml'.

org.apache.velocity.properties

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

There are methods you may wish to override to access, alter or control any part of the request processing chain. Please see the javadocs for more information on :

• VelocityViewServlet.loadConfiguration :
  for loading Velocity properties and configuring the Velocity runtime
• VelocityViewServlet.setContentType :
  for changing the content type on a request by request basis
• VelocityViewServlet.requestCleanup :
  post rendering resource or other cleanup
• VelocityViewServlet.error :
  error handling

Creates and returns an initialized Velocity context.

Procure a Writer with correct encoding which can be used even if HttpServletResponse's getOutputStream() method has already been called.

This is a transitional method which will be removed in a future version of Velocity.

Initializes servlet, toolbox and Velocity template engine.

Creates and returns an initialized Velocity context.

Procure a Writer with correct encoding which can be used even if HttpServletResponse's getOutputStream() method has already been called.

This is a transitional method which will be removed in a future version of Velocity. It is not recommended that you override this method.

Handle the template processing request.

Initializes servlet, toolbox and Velocity template engine. Called by the servlet container on loading.

NOTE: If no charset is specified in the default.contentType property (in your velocity.properties) and you have specified an output.encoding property, then that will be used as the charset for the default content-type of pages served by this servlet.

 <servlet>
 <servlet-name> YourServlet </servlet-name>
 <servlet-class> your.package.YourServlet </servlet-class>
 <init-param>
 <param-name> org.apache.velocity.properties </param-name>
 <param-value> velocity.properties </param-value>
 </init-param>
 </servlet>
 

 <context-param>
 <param-name> org.apache.velocity.properties </param-name>
 <param-value> velocity.properties </param-value>
 <description> Path to Velocity configuration </description>
 </context-param>
 

 ExtendedProperties p = super.loadConfiguration(config);
 

The default implementation is :

 response.setContentType(defaultContentType);