org.apache.jetspeed.velocity
Class JetspeedVelocityViewServlet

java.lang.Object
  extended by javax.servlet.GenericServlet
      extended by javax.servlet.http.HttpServlet
          extended by org.apache.velocity.tools.view.servlet.VelocityViewServlet
              extended by org.apache.portals.bridges.velocity.BridgesVelocityViewServlet
                  extended by org.apache.jetspeed.velocity.JetspeedVelocityViewServlet
All Implemented Interfaces:
java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class JetspeedVelocityViewServlet
extends org.apache.portals.bridges.velocity.BridgesVelocityViewServlet

Version:
$Id: JetspeedVelocityViewServlet.java 550655 2007-06-26 01:41:35Z taylor $
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.portals.bridges.velocity.BridgesVelocityViewServlet
PORTLET_CONFIG, PORTLET_REQUEST, PORTLET_RESPONSE, VELOCITY_CONTEXT_ATTR, VELOCITY_WRITER_ATTR
 
Fields inherited from class org.apache.velocity.tools.view.servlet.VelocityViewServlet
CONTENT_TYPE, DEFAULT_CONTENT_TYPE, DEFAULT_OUTPUT_ENCODING, DEFAULT_PROPERTIES_PATH, DEFAULT_TOOLBOX_PATH, DEFAULT_TOOLS_PROPERTIES, INIT_PROPS_KEY, SERVLET_CONTEXT_KEY, TOOLBOX_KEY, toolboxManager
 
Constructor Summary
JetspeedVelocityViewServlet()
           
 
Method Summary
protected  void error(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Exception e)
           
 org.apache.velocity.Template getTemplate(java.lang.String name)
          Retrieves the requested template.
 org.apache.velocity.Template getTemplate(java.lang.String name, java.lang.String encoding)
          Retrieves the requested template with the specified character encoding.
protected  org.apache.velocity.Template handleRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.apache.velocity.context.Context ctx)
          Handle the template processing request.
 void init(javax.servlet.ServletConfig config)
          Initialize servlet, BridgesVelocityViewServlet, and VelocityViewServlet.
protected  void initVelocity(javax.servlet.ServletConfig config)
          overriding VelocityViewServlet initialization of global Velocity to properly provide our own velocity.properties so to prevent an ERROR logging for not finding the default global VM_global_library.vm (which isn't available).
 
Methods inherited from class org.apache.portals.bridges.velocity.BridgesVelocityViewServlet
mergeTemplate
 
Methods inherited from class org.apache.velocity.tools.view.servlet.VelocityViewServlet
createContext, doGet, doPost, doRequest, fillContext, findInitParameter, getResponseWriter, getTemplate, getTemplate, getVelocityEngine, getVelocityProperty, initToolbox, loadConfiguration, performMerge, requestCleanup, setContentType, setVelocityEngine
 
Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service
 
Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JetspeedVelocityViewServlet

public JetspeedVelocityViewServlet()
Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException
Initialize servlet, BridgesVelocityViewServlet, and VelocityViewServlet.

Specified by:
init in interface javax.servlet.Servlet
Overrides:
init in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Parameters:
config - servlet configuation
Throws:
javax.servlet.ServletException
See Also:
org.apache.velocity.tools.view.servlet.VelocityViewServlet.init()

initVelocity

protected void initVelocity(javax.servlet.ServletConfig config)
                     throws javax.servlet.ServletException
overriding VelocityViewServlet initialization of global Velocity to properly provide our own velocity.properties so to prevent an ERROR logging for not finding the default global VM_global_library.vm (which isn't available).

Overrides:
initVelocity in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Throws:
javax.servlet.ServletException

handleRequest

protected org.apache.velocity.Template handleRequest(javax.servlet.http.HttpServletRequest request,
                                                     javax.servlet.http.HttpServletResponse response,
                                                     org.apache.velocity.context.Context ctx)
                                              throws java.lang.Exception
Handle the template processing request.

Overrides:
handleRequest in class org.apache.portals.bridges.velocity.BridgesVelocityViewServlet
Parameters:
request - client request
response - client response
ctx - VelocityContext to fill
Returns:
Velocity Template object or null
Throws:
java.lang.Exception
See Also:
org.apache.velocity.tools.view.servlet.VelocityViewServlet.handleRequest()

getTemplate

public org.apache.velocity.Template getTemplate(java.lang.String name)
                                         throws org.apache.velocity.exception.ResourceNotFoundException,
                                                org.apache.velocity.exception.ParseErrorException,
                                                java.lang.Exception
Retrieves the requested template.

Overrides:
getTemplate in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Parameters:
name - The file name of the template to retrieve relative to the template root.
Returns:
The requested template.
Throws:
org.apache.velocity.exception.ResourceNotFoundException - if template not found from any available source.
org.apache.velocity.exception.ParseErrorException - if template cannot be parsed due to syntax (or other) error.
java.lang.Exception - if an error occurs in template initialization
See Also:
org.apache.velocity.tools.view.servlet.VelocityViewServlet.getTemplate()

getTemplate

public org.apache.velocity.Template getTemplate(java.lang.String name,
                                                java.lang.String encoding)
                                         throws org.apache.velocity.exception.ResourceNotFoundException,
                                                org.apache.velocity.exception.ParseErrorException,
                                                java.lang.Exception
Retrieves the requested template with the specified character encoding.

Overrides:
getTemplate in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Parameters:
name - The file name of the template to retrieve relative to the template root.
encoding - the character encoding of the template
Returns:
The requested template.
Throws:
org.apache.velocity.exception.ResourceNotFoundException - if template not found from any available source.
org.apache.velocity.exception.ParseErrorException - if template cannot be parsed due to syntax (or other) error.
java.lang.Exception - if an error occurs in template initialization
See Also:
org.apache.velocity.tools.view.servlet.VelocityViewServlet.getTemplate()

error

protected void error(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     java.lang.Exception e)
              throws javax.servlet.ServletException
Overrides:
error in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Throws:
javax.servlet.ServletException


Copyright © 1999-2009 Apache Software Foundation. All Rights Reserved.