public class ViewToolContext extends ToolContext implements ViewContext
ToolContext implementation specific to the servlet environment.
It provides the following special features:
The get(String key) method implements the following search order
for objects:
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 map and does not allow tools or servlet classes to be overridden.
CATCH_EXCEPTIONS_KEY, CONTEXT_KEY, ENGINE_KEY, LOCALE_KEY, LOG_KEY, PATH_KEYAPPLICATION, DEFAULT_TOOLBOX_KEY, REQUEST, RESPONSE, SERVLET_CONTEXT_KEY, SESSION| Constructor and Description |
|---|
ViewToolContext(org.apache.velocity.app.VelocityEngine velocity,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
javax.servlet.ServletContext application) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
addToolboxesUnderKey(String toolboxKey) |
boolean |
containsKey(String key)
Indicates whether the specified key is in the context.
|
Object |
get(String key)
Looks up and returns the object with the specified key.
|
Object |
getAttribute(String key)
Searches for the named attribute in request, session (if valid),
and application scope(s) in order and returns the value associated
or null.
|
javax.servlet.http.HttpServletRequest |
getRequest()
Returns the current servlet request.
|
javax.servlet.http.HttpServletResponse |
getResponse()
Returns the current servlet response.
|
protected Object |
getServletApi(String key)
Returns the current matching servlet request, response, session,
or servlet context instance, or null if the key matches none of those
keys.
|
javax.servlet.ServletContext |
getServletContext()
Returns the servlet context.
|
javax.servlet.http.HttpSession |
getSession()
Returns the current session, if any.
|
protected List<Toolbox> |
getToolboxes() |
protected Object |
getToolVar(String key)
Finds the automatically provided values, either configured
tools or servlet API objects (request, response, etc).
|
protected Object |
getUserVar(String key)
Finds "user" set values, either in the local context
or in the scoped attributes if none is in the local context.
|
org.apache.velocity.context.Context |
getVelocityContext()
Returns a reference to the Velocity context (this object).
|
org.apache.velocity.app.VelocityEngine |
getVelocityEngine()
Returns a reference to the VelocityEngine.
|
protected void |
putToolProperties() |
protected void |
setToolboxKey(String key) |
addToolbox, containsKey, findTool, getKeys, getToolbox, getToolClassMap, getToolProperties, getUserCanOverwriteTools, internalGet, keySet, put, putAll, putToolProperties, putToolProperty, putVelocityEngine, remove, setUserCanOverwriteToolspublic ViewToolContext(org.apache.velocity.app.VelocityEngine velocity,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
javax.servlet.ServletContext application)
protected void setToolboxKey(String key)
protected void putToolProperties()
protected List<Toolbox> getToolboxes()
getToolboxes in class ToolContextprotected void addToolboxesUnderKey(String toolboxKey)
public Object get(String key)
Looks up and returns the object with the specified key.
See the class documentation for more details.
get in interface org.apache.velocity.context.Contextget in class ToolContextkey - the key of the object requestedToolContext.setUserCanOverwriteTools(boolean),
getUserVar(java.lang.String),
getToolVar(java.lang.String)protected Object getUserVar(String key)
protected Object getToolVar(String key)
protected Object getServletApi(String key)
public Object getAttribute(String key)
Searches for the named attribute in request, session (if valid), and application scope(s) in order and returns the value associated or null.
getAttribute in interface ViewContextpublic javax.servlet.http.HttpServletRequest getRequest()
Returns the current servlet request.
getRequest in interface ViewContextpublic javax.servlet.http.HttpServletResponse getResponse()
Returns the current servlet response.
getResponse in interface ViewContextpublic javax.servlet.http.HttpSession getSession()
Returns the current session, if any.
public javax.servlet.ServletContext getServletContext()
Returns the servlet context.
getServletContext in interface ViewContextpublic org.apache.velocity.context.Context getVelocityContext()
Returns a reference to the Velocity context (this object).
getVelocityContext in interface ViewContextpublic org.apache.velocity.app.VelocityEngine getVelocityEngine()
Returns a reference to the VelocityEngine.
getVelocityEngine in interface ViewContextpublic boolean containsKey(String key)
key - The key to look for.Copyright © 2002–2023 Apache Software Foundation. All rights reserved.