org.apache.struts.tiles
public class DefinitionsUtil extends TilesUtil implements ComponentConstants
Deprecated: Use TilesUtil
Utilities class for definitions factory. Also define userDebugLevel property (TODO to be moved from this class ?).Nested Class Summary | |
---|---|
static class | DefinitionsUtil.ServletPropertiesMap
Inner class.
|
Field Summary | |
---|---|
static String | ACTION_DEFINITION
Constant name used to store definition in jsp context.
|
static String | DEFINITIONS_CONFIG_USER_DEBUG_LEVEL
Name of init property carrying debug level. |
static String | DEFINITIONS_FACTORY
Constant name used to store factory in context. |
static String | DEFINITIONS_FACTORY_CLASSNAME
Name of init property carrying factory class name. |
protected static Log | log
Commons Logging instance. |
static int | NO_DEBUG
User Debug level. |
static int | userDebugLevel
Global user defined debug level. |
Method Summary | |
---|---|
static DefinitionsFactory | createDefinitionsFactory(ServletContext servletContext, Map properties, String classname)
Create Definition factory.
|
static DefinitionsFactory | createDefinitionsFactory(ServletContext servletContext, Map properties)
Create default Definition factory. |
static DefinitionsFactory | createDefinitionsFactory(ServletContext servletContext, ServletConfig servletConfig)
Create Definition factory.
|
static DefinitionsFactory | createDefinitionsFactory(ServletContext servletContext, ServletConfig servletConfig, boolean checkIfExist)
Create Definition factory.
|
static ComponentDefinition | getActionDefinition(ServletRequest request)
Get Definition stored in jsp context by an action. |
static DefinitionsFactory | getDefinitionsFactory(ServletContext servletContext)
Get definition factory from appropriate servlet context. |
static void | populateDefinitionsFactoryConfig(DefinitionsFactoryConfig factoryConfig, ServletConfig servletConfig)
Populate Definition Factory Config from web.xml properties. |
protected static DefinitionsFactoryConfig | readFactoryConfig(ServletConfig servletConfig)
Create FactoryConfig and initialize it from web.xml.
|
static void | removeActionDefinition(ServletRequest request, ComponentDefinition definition)
Remove Definition stored in jsp context.
|
static void | setActionDefinition(ServletRequest request, ComponentDefinition definition)
Store definition in jsp context.
|
Deprecated: This will be removed in a release after Struts 1.2.
User Debug level.Deprecated: This will be removed in a release after Struts 1.2.
Global user defined debug level.Deprecated: Use createDefinitionsFactory(ServletContext servletContext, ServletConfig servletConfig)
Create Definition factory. If a factory class name is provided, a factory of this class is created. Otherwise, default factory is created.Parameters: classname Class name of the factory to create. servletContext Servlet Context passed to newly created factory. properties Map of name/property used to initialize factory configuration object.
Returns: newly created factory.
Throws: DefinitionsFactoryException If an error occur while initializing factory
Parameters: servletContext Servlet Context passed to newly created factory. properties Map of name/property used to initialize factory configuration object.
Returns: newly created factory of type ConfigurableDefinitionsFactory.
Throws: DefinitionsFactoryException If an error occur while initializing factory
Convenience method. Calls createDefinitionsFactory(ServletContext servletContext, DefinitionsFactoryConfig factoryConfig)
Parameters: servletContext Servlet Context passed to newly created factory. servletConfig Servlet config containing parameters to be passed to factory configuration object.
Returns: newly created factory of type ConfigurableDefinitionsFactory.
Throws: DefinitionsFactoryException If an error occur while initializing factory
If checkIfExist is true, start by checking if factory already exist. If yes, return it. If no, create a new one.
If checkIfExist is false, factory is always created.
Convenience method. Calls createDefinitionsFactory(ServletContext servletContext, DefinitionsFactoryConfig factoryConfig)
Parameters: servletContext Servlet Context passed to newly created factory. servletConfig Servlet config containing parameters to be passed to factory configuration object. checkIfExist Check if factory already exist. If true and factory exist, return it. If true and factory doesn't exist, create it. If false, create it in all cases.
Returns: newly created factory of type ConfigurableDefinitionsFactory.
Throws: DefinitionsFactoryException If an error occur while initializing factory
Returns: ComponentDefinition or null if not found.
Deprecated: Use TilesUtil
Get definition factory from appropriate servlet context.Returns: Definitions factory or null if not found.
Since: 20020708
Parameters: factoryConfig Definition Factory Config to populate. servletConfig Current servlet config containing web.xml properties.
Throws: IllegalAccessException if the caller does not have access to the property accessor method java.lang.reflect.InvocationTargetException if the property accessor method throws an exception
Since: tiles 20020708
See Also: org.apache.commons.beanutils.BeanUtils
Parameters: servletConfig ServletConfig for the module with which this plug in is associated
Throws: DefinitionsFactoryException if this PlugIn
cannot
be successfully initialized