|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.velocity.tools.view.ServletUtils
public class ServletUtils
A set of utility methods for supporting and using VelocityTools in the servlet environment.
Field Summary | |
---|---|
static String |
ALT_VELOCITY_VIEW_KEY
|
static String |
CONFIGURATION_KEY
Key used to access a live FactoryConfiguration previously
placed in the ServletContext attributes. |
static ServletUtils |
INSTANCE
|
static String |
SHARED_CONFIG_PARAM
|
static String |
VELOCITY_VIEW_KEY
|
Constructor Summary | |
---|---|
protected |
ServletUtils()
|
Method Summary | |
---|---|
static Object |
findTool(String key,
javax.servlet.http.HttpServletRequest request)
|
static Object |
findTool(String key,
javax.servlet.http.HttpServletRequest request,
javax.servlet.ServletContext application)
|
static Object |
findTool(String key,
javax.servlet.ServletContext application)
|
static Object |
findTool(String key,
String toolboxKey,
javax.servlet.http.HttpServletRequest request)
|
static Object |
findTool(String key,
String toolboxKey,
javax.servlet.http.HttpServletRequest request,
javax.servlet.ServletContext application)
|
static Object |
findTool(String key,
String toolboxKey,
javax.servlet.ServletContext application)
|
static FactoryConfiguration |
getConfiguration(javax.servlet.ServletContext application)
|
static FactoryConfiguration |
getConfiguration(String path,
javax.servlet.ServletContext application)
|
static FactoryConfiguration |
getConfiguration(String path,
javax.servlet.ServletContext application,
boolean deprecationSupportMode)
|
static InputStream |
getInputStream(String path,
javax.servlet.ServletContext application)
|
ServletUtils |
getInstance()
|
static Object |
getMutex(javax.servlet.http.HttpSession session,
String key,
Object caller)
Returns a mutex (lock object) unique to the specified session and stored under the specified key to allow for reliable synchronization on the session. |
static String |
getPath(javax.servlet.http.HttpServletRequest request)
Retrieves the path for the specified request regardless of whether this is a direct request or an include by the RequestDispatcher. |
static VelocityView |
getVelocityView(javax.servlet.FilterConfig config)
Returns the shared VelocityView for the specified
FilterConfig 's context. |
static VelocityView |
getVelocityView(JeeConfig config)
Returns the shared VelocityView for the specified
JeeConfig 's context. |
static VelocityView |
getVelocityView(javax.servlet.ServletConfig config)
Returns the shared VelocityView for the specified
ServletConfig 's context. |
static VelocityView |
getVelocityView(javax.servlet.ServletContext application)
Returns the shared VelocityView for the specified
ServletContext . |
static VelocityView |
getVelocityView(javax.servlet.ServletContext application,
boolean createIfMissing)
Returns the shared VelocityView for the specified
ServletContext . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String VELOCITY_VIEW_KEY
public static final String SHARED_CONFIG_PARAM
public static final String ALT_VELOCITY_VIEW_KEY
public static final String CONFIGURATION_KEY
FactoryConfiguration
previously
placed in the ServletContext attributes.
public static final ServletUtils INSTANCE
Constructor Detail |
---|
protected ServletUtils()
Method Detail |
---|
public ServletUtils getInstance()
public static String getPath(javax.servlet.http.HttpServletRequest request)
public static VelocityView getVelocityView(javax.servlet.ServletConfig config)
VelocityView
for the specified
ServletConfig
's context. If one has not yet been created, it
will create, store it for future access, and then return it.
public static VelocityView getVelocityView(javax.servlet.FilterConfig config)
VelocityView
for the specified
FilterConfig
's context. If one has not yet been created, it
will create, store it for future access, and then return it.
public static VelocityView getVelocityView(JeeConfig config)
VelocityView
for the specified
JeeConfig
's context. If one has not yet been created, it
will create, store it for future access, and then return it.
public static VelocityView getVelocityView(javax.servlet.ServletContext application)
VelocityView
for the specified
ServletContext
. If one has not yet been created,
it will create one, store it for future access, and then return it.
public static VelocityView getVelocityView(javax.servlet.ServletContext application, boolean createIfMissing)
VelocityView
for the specified
ServletContext
. If one has not yet been created and
the second parameter is true
, then it will
create one, store it for future access, and return it.
public static Object findTool(String key, javax.servlet.ServletContext application)
public static Object findTool(String key, String toolboxKey, javax.servlet.ServletContext application)
public static Object findTool(String key, javax.servlet.http.HttpServletRequest request)
public static Object findTool(String key, String toolboxKey, javax.servlet.http.HttpServletRequest request)
public static Object findTool(String key, javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext application)
public static Object findTool(String key, String toolboxKey, javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext application)
public static InputStream getInputStream(String path, javax.servlet.ServletContext application)
public static FactoryConfiguration getConfiguration(javax.servlet.ServletContext application)
public static FactoryConfiguration getConfiguration(String path, javax.servlet.ServletContext application)
public static FactoryConfiguration getConfiguration(String path, javax.servlet.ServletContext application, boolean deprecationSupportMode)
public static Object getMutex(javax.servlet.http.HttpSession session, String key, Object caller)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |