Package org.apache.struts.tiles
Class DefinitionsUtil
java.lang.Object
org.apache.struts.tiles.TilesUtil
org.apache.struts.tiles.DefinitionsUtil
- All Implemented Interfaces:
ComponentConstants
Deprecated.
Utilities class for definitions factory.
Also define userDebugLevel property (TODO to be moved from this class ?).
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Deprecated.Constant name used to store definition in jsp context.static final String
Deprecated.Name of init property carrying debug level.static final String
Deprecated.Constant name used to store factory in context.static final String
Deprecated.Name of init property carrying factory class name.static final int
Deprecated.This will be removed in a release after Struts 1.2.static int
Deprecated.This will be removed in a release after Struts 1.2.Fields inherited from class org.apache.struts.tiles.TilesUtil
tilesUtilImpl
Fields inherited from interface org.apache.struts.tiles.taglib.ComponentConstants
COMPONENT_CONTEXT, COMPONENT_SCOPE, EXCEPTION_KEY, LOCALE_KEY
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DefinitionsFactory
createDefinitionsFactory
(ServletContext servletContext, ServletConfig servletConfig) Deprecated.Create Definition factory.static DefinitionsFactory
createDefinitionsFactory
(ServletContext servletContext, ServletConfig servletConfig, boolean checkIfExist) Deprecated.Create Definition factory.static DefinitionsFactory
createDefinitionsFactory
(ServletContext servletContext, Map<String, Object> properties) Deprecated.Create default Definition factory.static DefinitionsFactory
createDefinitionsFactory
(ServletContext servletContext, Map<String, Object> properties, String classname) Deprecated.Use createDefinitionsFactory(ServletContext servletContext, ServletConfig servletConfig)static ComponentDefinition
getActionDefinition
(ServletRequest request) Deprecated.Get Definition stored in jsp context by an action.static DefinitionsFactory
getDefinitionsFactory
(ServletContext servletContext) Deprecated.static void
populateDefinitionsFactoryConfig
(DefinitionsFactoryConfig factoryConfig, ServletConfig servletConfig) Deprecated.Populate Definition Factory Config from web.xml properties.protected static DefinitionsFactoryConfig
readFactoryConfig
(ServletConfig servletConfig) Deprecated.Create FactoryConfig and initialize it from web.xml.static void
removeActionDefinition
(ServletRequest request, ComponentDefinition definition) Deprecated.Remove Definition stored in jsp context.static void
setActionDefinition
(ServletRequest request, ComponentDefinition definition) Deprecated.Store definition in jsp context.Methods inherited from class org.apache.struts.tiles.TilesUtil
createDefinitionsFactory, doForward, doInclude, doInclude, doInclude, getDefinition, getDefinitionsFactory, getTilesUtil, setTilesUtil, testReset
-
Field Details
-
userDebugLevel
Deprecated.This will be removed in a release after Struts 1.2.Global user defined debug level. -
NO_DEBUG
Deprecated.This will be removed in a release after Struts 1.2.User Debug level.- See Also:
-
DEFINITIONS_CONFIG_USER_DEBUG_LEVEL
Deprecated.Name of init property carrying debug level.- See Also:
-
DEFINITIONS_FACTORY_CLASSNAME
Deprecated.Name of init property carrying factory class name.- See Also:
-
DEFINITIONS_FACTORY
Deprecated.Constant name used to store factory in context.- See Also:
-
ACTION_DEFINITION
Deprecated.Constant name used to store definition in jsp context. Used to pass definition from a Struts action to servlet forward.- See Also:
-
-
Constructor Details
-
DefinitionsUtil
public DefinitionsUtil()Deprecated.
-
-
Method Details
-
createDefinitionsFactory
@Deprecated public static DefinitionsFactory createDefinitionsFactory(ServletContext servletContext, Map<String, Object> properties, String classname) throws DefinitionsFactoryExceptionDeprecated.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:
servletContext
- Servlet Context passed to newly created factory.properties
- Map of name/property used to initialize factory configuration object.classname
- Class name of the factory to create.- Returns:
- newly created factory.
- Throws:
DefinitionsFactoryException
- If an error occur while initializing factory
-
createDefinitionsFactory
public static DefinitionsFactory createDefinitionsFactory(ServletContext servletContext, Map<String, Object> properties) throws DefinitionsFactoryExceptionDeprecated.Create default Definition 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
-
createDefinitionsFactory
public static DefinitionsFactory createDefinitionsFactory(ServletContext servletContext, ServletConfig servletConfig) throws DefinitionsFactoryException Deprecated.Create Definition factory. Create configuration object from servlet web.xml file, then create ConfigurableDefinitionsFactory and initialized it with object.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
-
createDefinitionsFactory
public static DefinitionsFactory createDefinitionsFactory(ServletContext servletContext, ServletConfig servletConfig, boolean checkIfExist) throws DefinitionsFactoryException Deprecated.Create Definition factory. Create configuration object from servlet web.xml file, then create ConfigurableDefinitionsFactory and initialized it with object.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
-
getDefinitionsFactory
Deprecated.Get definition factory from appropriate servlet context.- Returns:
- Definitions factory or null if not found.
- Since:
- 20020708
-
getActionDefinition
Deprecated.Get Definition stored in jsp context by an action.- Returns:
- ComponentDefinition or null if not found.
-
setActionDefinition
Deprecated.Store definition in jsp context. Mainly used by Struts to pass a definition defined in an Action to the forward. -
removeActionDefinition
Deprecated.Remove Definition stored in jsp context. Mainly used by Struts to pass a definition defined in an Action to the forward. -
populateDefinitionsFactoryConfig
public static void populateDefinitionsFactoryConfig(DefinitionsFactoryConfig factoryConfig, ServletConfig servletConfig) throws IllegalAccessException, InvocationTargetException Deprecated.Populate Definition Factory Config from web.xml properties.- 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 methodInvocationTargetException
- if the property accessor method throws an exception- Since:
- tiles 20020708
- See Also:
-
readFactoryConfig
protected static DefinitionsFactoryConfig readFactoryConfig(ServletConfig servletConfig) throws DefinitionsFactoryException Deprecated.Create FactoryConfig and initialize it from web.xml.- Parameters:
servletConfig
- ServletConfig for the module with which this plug in is associated- Throws:
DefinitionsFactoryException
- if thisPlugIn
cannot be successfully initialized
-
TilesUtil.createDefinitionsFactory(ServletContext, DefinitionsFactoryConfig)