|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.velocity.tools.struts.StrutsUtils
A package-internal utility class to expose the Struts shared resources. All methods are static.
This class is provided for use by Velocity view tools that need access to Struts resources. By having all Struts- specific code in this utility class, maintenance is simplified and reuse fostered.
It is the aim, that sooner or later the functionality in this class is integrated into Struts itself. Ideally, they will yank the JSP-centric code (PageContext, etc.) out of their RequestUtils to allow other view layers to leverage that code.
Constructor Summary | |
(package private) |
StrutsUtils()
|
Method Summary | |
(package private) static java.lang.String |
errorMarkup(java.lang.String property,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpSession session,
javax.servlet.ServletContext application)
Returns a formatted error message. |
(package private) static org.apache.struts.action.ActionErrors |
getActionErrors(javax.servlet.http.HttpServletRequest request)
Returns the org.apache.struts.action.ActionErrors
object for this request or null if none exists. |
(package private) static org.apache.struts.action.ActionForm |
getActionForm(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpSession session)
Returns the ActionForm bean associated with
this request of null if none exists. |
(package private) static org.apache.struts.action.ActionFormBeans |
getActionFormBeans(javax.servlet.ServletContext application)
Returns the org.apache.struts.action.ActionFormBeans
collection for this application or null if not found. |
(package private) static org.apache.struts.action.ActionForward |
getActionForward(java.lang.String name,
javax.servlet.ServletContext application)
Returns the forwarding associated with the specified logical name or null if not found. |
(package private) static org.apache.struts.action.ActionForwards |
getActionForwards(javax.servlet.ServletContext application)
Returns the org.apache.struts.action.ActionForwards
collection for this application or null if not found. |
(package private) static org.apache.struts.action.ActionMapping |
getActionMapping(java.lang.String path,
javax.servlet.ServletContext application)
Returns the mapping associated with the specified request path, or null if not found. |
(package private) static java.lang.String |
getActionMappingName(java.lang.String action)
Returns the form action converted into an action mapping path. |
(package private) static org.apache.struts.action.ActionMappings |
getActionMappings(javax.servlet.ServletContext application)
Returns the org.apache.struts.action.ActionMappings
collection for this application or null if not found. |
(package private) static java.lang.String |
getActionMappingURL(javax.servlet.ServletContext application,
javax.servlet.http.HttpServletRequest request,
java.lang.String action)
Returns the form action converted into a server-relative URI reference. |
(package private) static java.lang.String |
getCancelName()
Returns the query parameter name under which a cancel button press must be reported if form validation is to be skipped. |
(package private) static javax.sql.DataSource |
getDataSource(javax.servlet.ServletContext application)
Returns the default configured data source (which must implement javax.sql.DataSource ) or null if not found. |
(package private) static java.lang.Throwable |
getException(javax.servlet.http.HttpServletRequest request)
Returns the runtime Exception that may have been thrown by a Struts view tool or compatible presentation extension, and placed in the request. |
(package private) static org.apache.struts.action.ActionFormBean |
getFormBean(java.lang.String name,
javax.servlet.ServletContext application)
Returns the form bean definition associated with the specified logical name or null if not found. |
(package private) static java.lang.String |
getGlobalErrorName()
Returns the default "GLOBAL" category name that can be used with messages that are not associated with a particular property. |
(package private) static java.util.Locale |
getLocale(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpSession session)
Returns the java.util.Locale for the user. |
(package private) static org.apache.struts.action.ActionMapping |
getMapping(javax.servlet.http.HttpServletRequest request)
Returns the org.apache.struts.ActionMapping instance
for this request or null if none exists. |
(package private) static org.apache.struts.util.MessageResources |
getMessageResources(javax.servlet.ServletContext application)
Returns the message resources for this application or null
if not found. |
(package private) static org.apache.struts.upload.MultipartRequestWrapper |
getMultipartRequestWrapper(javax.servlet.http.HttpServletRequest request)
Returns the multipart object for this request or null
if none exists. |
(package private) static java.lang.String |
getServletMapping(javax.servlet.ServletContext application)
Returns the servlet mapping used for this application or null if not found. |
(package private) static java.lang.String |
getToken(javax.servlet.http.HttpSession session)
Returns the transaction token stored in this session or null if not used. |
(package private) static java.lang.String |
getTokenName()
Returns the query parameter name under which a transaction token must be reported. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
StrutsUtils()
Method Detail |
static javax.sql.DataSource getDataSource(javax.servlet.ServletContext application)
javax.sql.DataSource
) or null
if not found.
application
- the servlet contextstatic org.apache.struts.action.ActionFormBeans getActionFormBeans(javax.servlet.ServletContext application)
org.apache.struts.action.ActionFormBeans
collection for this application or null
if not found.
application
- the servlet contextstatic org.apache.struts.action.ActionFormBean getFormBean(java.lang.String name, javax.servlet.ServletContext application)
null
if not found.
name
- logical name of the requested form bean definitionapplication
- the servlet contextstatic org.apache.struts.action.ActionForwards getActionForwards(javax.servlet.ServletContext application)
org.apache.struts.action.ActionForwards
collection for this application or null
if not found.
application
- the servlet contextstatic org.apache.struts.action.ActionForward getActionForward(java.lang.String name, javax.servlet.ServletContext application)
null
if not found.
name
- Logical name of the requested forwardingstatic org.apache.struts.action.ActionMappings getActionMappings(javax.servlet.ServletContext application)
org.apache.struts.action.ActionMappings
collection for this application or null
if not found.
application
- the servlet contextstatic org.apache.struts.action.ActionMapping getActionMapping(java.lang.String path, javax.servlet.ServletContext application)
null
if not found.
path
- Request path for which a mapping is requestedapplication
- the servlet contextstatic org.apache.struts.util.MessageResources getMessageResources(javax.servlet.ServletContext application)
null
if not found.
application
- the servlet contextstatic java.lang.String getServletMapping(javax.servlet.ServletContext application)
null
if not found. The servlet mapping is
either a path-mapped pattern (/action/*
) or an
extension mapped pattern (*.do
).
application
- the servlet contextstatic java.util.Locale getLocale(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpSession session)
java.util.Locale
for the user. If a
locale object is not found in the user's session, the system
default locale is returned.
request
- the servlet requestsession
- the HTTP sessionstatic java.lang.String getToken(javax.servlet.http.HttpSession session)
null
if not used.
session
- the HTTP sessionstatic org.apache.struts.action.ActionErrors getActionErrors(javax.servlet.http.HttpServletRequest request)
org.apache.struts.action.ActionErrors
object for this request or null
if none exists.
request
- the servlet requeststatic java.lang.Throwable getException(javax.servlet.http.HttpServletRequest request)
null
if none found.
request
- the servlet requeststatic org.apache.struts.upload.MultipartRequestWrapper getMultipartRequestWrapper(javax.servlet.http.HttpServletRequest request)
null
if none exists.
request
- the servlet requeststatic org.apache.struts.action.ActionMapping getMapping(javax.servlet.http.HttpServletRequest request)
org.apache.struts.ActionMapping
instance
for this request or null
if none exists.
request
- the servlet requeststatic org.apache.struts.action.ActionForm getActionForm(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpSession session)
ActionForm
bean associated with
this request of null
if none exists.
request
- the servlet requestsession
- the HTTP sessionstatic java.lang.String getCancelName()
static java.lang.String getGlobalErrorName()
static java.lang.String getTokenName()
static java.lang.String getActionMappingName(java.lang.String action)
action
property is manipulated as follows in
computing the name of the requested mapping:
action
- the name of an action as per struts-config.xmlstatic java.lang.String getActionMappingURL(javax.servlet.ServletContext application, javax.servlet.http.HttpServletRequest request, java.lang.String action)
application
- the servlet contextrequest
- the servlet requestaction
- the name of an action as per struts-config.xmlstatic java.lang.String errorMarkup(java.lang.String property, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpSession session, javax.servlet.ServletContext application)
property
- the category of errors to markup and returnrequest
- the servlet requestsession
- the HTTP sessionapplication
- the servlet context
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |