org.apache.velocity.tools.view.context
Class ChainedContext

java.lang.Object
  extended by org.apache.velocity.tools.ToolContext
      extended by org.apache.velocity.tools.view.ViewToolContext
          extended by org.apache.velocity.tools.view.context.ChainedContext
All Implemented Interfaces:
org.apache.velocity.context.Context, ViewContext

Deprecated. Use ViewToolContext instead

@Deprecated
public class ChainedContext
extends ViewToolContext
implements ViewContext

Velocity context implementation specific to the Servlet environment.

It provides the following special features:

The internalGet(String key) method implements the following search order for objects:

  1. toolbox
  2. servlet request, servlet response, servlet session, servlet context
  3. local hashtable of objects (traditional use)
  4. servlet request attribues, servlet session attribute, servlet context attributes

The purpose of this class is to make it easy for web designer to work with Java servlet based web applications. They do not need to be concerned with the concepts of request, session or application attributes and the lifetime of objects in these scopes.

Note that the put() method always puts objects into the local hashtable.

Version:
$Id: ChainedContext.java 534682 2007-05-03 01:50:54Z nbubna $
Author:
Geir Magnusson Jr., Gabe Sidler

Field Summary
private  java.util.Map<java.lang.String,java.lang.Object> oldToolbox
          Deprecated.  
 
Fields inherited from class org.apache.velocity.tools.ToolContext
CATCH_EXCEPTIONS_KEY, CONTEXT_KEY, ENGINE_KEY, LOG_KEY, PATH_KEY
 
Fields inherited from interface org.apache.velocity.tools.view.context.ViewContext
XHTML
 
Fields inherited from interface org.apache.velocity.tools.view.ViewContext
APPLICATION, DEFAULT_TOOLBOX_KEY, REQUEST, RESPONSE, SERVLET_CONTEXT_KEY, SESSION
 
Constructor Summary
ChainedContext(org.apache.velocity.context.Context ctx, org.apache.velocity.app.VelocityEngine velocity, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext application)
          Deprecated.  
ChainedContext(org.apache.velocity.app.VelocityEngine velocity, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext application)
          Deprecated.  
 
Method Summary
 java.util.Map<java.lang.String,java.lang.Object> getToolbox()
          Deprecated. Returns the tools for this context
protected  java.lang.Object internalGet(java.lang.String key)
          Deprecated.  
 void setToolbox(java.util.Map<java.lang.String,java.lang.Object> box)
          Deprecated.  
 
Methods inherited from class org.apache.velocity.tools.view.ViewToolContext
addToolboxesUnderKey, get, getAttribute, getRequest, getResponse, getServletApi, getServletContext, getSession, getToolboxes, getVelocityContext, getVelocityEngine, putToolProperties
 
Methods inherited from class org.apache.velocity.tools.ToolContext
addToolbox, containsKey, findTool, getKeys, getToolProperties, keySet, put, putToolProperty, remove
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.velocity.tools.view.ViewContext
getAttribute, getRequest, getResponse, getServletContext, getVelocityContext, getVelocityEngine
 

Field Detail

oldToolbox

private java.util.Map<java.lang.String,java.lang.Object> oldToolbox
Deprecated. 
Constructor Detail

ChainedContext

public ChainedContext(org.apache.velocity.app.VelocityEngine velocity,
                      javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      javax.servlet.ServletContext application)
Deprecated. 

ChainedContext

public ChainedContext(org.apache.velocity.context.Context ctx,
                      org.apache.velocity.app.VelocityEngine velocity,
                      javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      javax.servlet.ServletContext application)
Deprecated. 
Method Detail

setToolbox

public void setToolbox(java.util.Map<java.lang.String,java.lang.Object> box)
Deprecated. 

Sets a "toolbox" in the style of VelocityTools 1.x.


getToolbox

public java.util.Map<java.lang.String,java.lang.Object> getToolbox()
Deprecated. 

Returns the tools for this context

Overrides:
getToolbox in class ViewToolContext
Returns:
any tools passed in via setToolbox() plus the results of ViewToolContext.getToolbox().
Since:
VelocityTools 1.3

internalGet

protected java.lang.Object internalGet(java.lang.String key)
Deprecated. 
Overrides:
internalGet in class ToolContext


Copyright (c) 2003-2007 Apache Software Foundation