org.apache.struts.util

Class ModuleUtils

public class ModuleUtils extends Object

General purpose utility methods related to module processing.

Since: Struts 1.2

Version: $Rev: 54929 $

Field Summary
static ModuleUtilsinstance
The Singleton instance.
static Loglog
Commons logging instance.
Constructor Summary
protected ModuleUtils()
Constructor for ModuleUtils.
Method Summary
static ModuleUtilsgetInstance()
Returns the Singleton instance of TagUtils.
ModuleConfiggetModuleConfig(HttpServletRequest request)
Return the current ModuleConfig object stored in request, if it exists, null otherwise.
ModuleConfiggetModuleConfig(String prefix, ServletContext context)
Return the desired ModuleConfig object stored in context, if it exists, null otherwise.
ModuleConfiggetModuleConfig(String prefix, HttpServletRequest request, ServletContext context)
Return the desired ModuleConfig object stored in context, if it exists, otherwise return the current ModuleConfig
ModuleConfiggetModuleConfig(HttpServletRequest request, ServletContext context)
Return the ModuleConfig object is it exists, null otherwise.
StringgetModuleName(HttpServletRequest request, ServletContext context)
Get the module name to which the specified request belong.
StringgetModuleName(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.
voidselectModule(HttpServletRequest request, ServletContext context)
Select the module to which the specified request belongs, and add corresponding request attributes to this request.
voidselectModule(String prefix, HttpServletRequest request, ServletContext context)
Select the module to which the specified request belongs, and add corresponding request attributes to this request.

Field Detail

instance

private static final ModuleUtils instance
The Singleton instance.

log

private static final Log log
Commons logging instance.

Constructor Detail

ModuleUtils

protected ModuleUtils()
Constructor for ModuleUtils.

Method Detail

getInstance

public static ModuleUtils getInstance()
Returns the Singleton instance of TagUtils.

getModuleConfig

public ModuleConfig getModuleConfig(HttpServletRequest request)
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 RequestUtils .

Parameters: request The servlet request we are processing

Returns: the ModuleConfig object from request, or null if none is set in the request.

getModuleConfig

public ModuleConfig getModuleConfig(String prefix, ServletContext context)
Return the desired ModuleConfig object stored in context, if it exists, null otherwise.

Parameters: prefix The module prefix of the desired module context 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 module request The servlet request we are processing context The ServletContext for this web application

Returns: the ModuleConfig object specified, or null if not found in the context.

getModuleConfig

public ModuleConfig getModuleConfig(HttpServletRequest request, ServletContext context)
Return the ModuleConfig object is it exists, null otherwise.

Parameters: request The servlet request we are processing context The ServletContext for this web application

Returns: the ModuleConfig object

getModuleName

public String getModuleName(HttpServletRequest request, ServletContext context)
Get the module name to which the specified request belong.

Parameters: request The servlet request we are processing context The ServletContext for this web application

Returns: The module prefix or ""

getModuleName

public String getModuleName(String matchPath, ServletContext context)
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

public String[] getModulePrefixes(ServletContext context)
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

public void selectModule(HttpServletRequest request, ServletContext context)
Select the module to which the specified request belongs, and add corresponding request attributes to this request.

Parameters: request The servlet request we are processing context The ServletContext for this web application

selectModule

public 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.

Parameters: prefix The module prefix of the desired module request The servlet request we are processing context The ServletContext for this web application

Copyright B) 2000-2009 - The Apache Software Foundation