Package org.apache.struts.util
Class ModuleUtils
java.lang.Object
org.apache.struts.util.ModuleUtils
General purpose utility methods related to module processing.
- Since:
- Struts 1.2
- Version:
- $Rev$
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ModuleUtils
Returns the Singleton instance of TagUtils.getModuleConfig
(HttpServletRequest request) Return the current ModuleConfig object stored in request, if it exists, null otherwise.getModuleConfig
(HttpServletRequest request, ServletContext context) Return the ModuleConfig object is it exists, null otherwise.getModuleConfig
(String prefix, HttpServletRequest request, ServletContext context) Return the desired ModuleConfig object stored in context, if it exists, otherwise return the current ModuleConfiggetModuleConfig
(String prefix, ServletContext context) Return the desired ModuleConfig object stored in context, if it exists, null otherwise.getModuleName
(HttpServletRequest request, ServletContext context) Get the module name to which the specified request belong.getModuleName
(String matchPath, ServletContext context) Get the module name to which the specified uri belong.String[]
getModulePrefixes
(ServletContext context) Return the list of module prefixes that are defined for this web application.void
selectModule
(HttpServletRequest request, ServletContext context) Select the module to which the specified request belongs, and add corresponding request attributes to this request.void
selectModule
(String prefix, HttpServletRequest request, ServletContext context) Select the module to which the specified request belongs, and add corresponding request attributes to this request.
-
Constructor Details
-
ModuleUtils
protected ModuleUtils()Constructor for ModuleUtils.
-
-
Method Details
-
getInstance
Returns the Singleton instance of TagUtils. -
getModuleConfig
Return the current ModuleConfig object stored in request, if it exists, null otherwise. This method can be used by plugin to retrieve the current module config object. If no moduleConfig is found, this means that the request haven't hit the server throught the struts servlet. The appropriate module config can be set and found with
.selectModule(HttpServletRequest, ServletContext)
- Parameters:
request
- The servlet request we are processing- Returns:
- the ModuleConfig object from request, or null if none is set in the request.
-
getModuleConfig
Return the desired ModuleConfig object stored in context, if it exists, null otherwise.- Parameters:
prefix
- The module prefix of the desired modulecontext
- The ServletContext for this web application- Returns:
- the ModuleConfig object specified, or null if not found in the context.
-
getModuleConfig
public ModuleConfig getModuleConfig(String prefix, HttpServletRequest request, ServletContext context) Return the desired ModuleConfig object stored in context, if it exists, otherwise return the current ModuleConfig- Parameters:
prefix
- The module prefix of the desired modulerequest
- The servlet request we are processingcontext
- The ServletContext for this web application- Returns:
- the ModuleConfig object specified, or null if not found in the context.
-
getModuleConfig
Return the ModuleConfig object is it exists, null otherwise.- Parameters:
request
- The servlet request we are processingcontext
- The ServletContext for this web application- Returns:
- the ModuleConfig object
-
getModuleName
Get the module name to which the specified request belong.- Parameters:
request
- The servlet request we are processingcontext
- The ServletContext for this web application- Returns:
- The module prefix or ""
-
getModuleName
Get the module name to which the specified uri belong.- Parameters:
matchPath
- The uri from which we want the module name.context
- The ServletContext for this web application- Returns:
- The module prefix or ""
-
getModulePrefixes
Return the list of module prefixes that are defined for this web application. NOTE - the "" prefix for the default module is not included in this list.- Parameters:
context
- The ServletContext for this web application.- Returns:
- An array of module prefixes.
-
selectModule
Select the module to which the specified request belongs, and add corresponding request attributes to this request.- Parameters:
request
- The servlet request we are processingcontext
- The ServletContext for this web application
-
selectModule
Select the module to which the specified request belongs, and add corresponding request attributes to this request.- Parameters:
prefix
- The module prefix of the desired modulerequest
- The servlet request we are processingcontext
- The ServletContext for this web application
-