org.apache.struts.tiles

Class DefinitionsUtil

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 classDefinitionsUtil.ServletPropertiesMap
Inner class.
Field Summary
static StringACTION_DEFINITION
Constant name used to store definition in jsp context.
static StringDEFINITIONS_CONFIG_USER_DEBUG_LEVEL
Name of init property carrying debug level.
static StringDEFINITIONS_FACTORY
Constant name used to store factory in context.
static StringDEFINITIONS_FACTORY_CLASSNAME
Name of init property carrying factory class name.
protected static Loglog
Commons Logging instance.
static intNO_DEBUG
User Debug level.
static intuserDebugLevel
Global user defined debug level.
Method Summary
static DefinitionsFactorycreateDefinitionsFactory(ServletContext servletContext, Map properties, String classname)
Create Definition factory.
static DefinitionsFactorycreateDefinitionsFactory(ServletContext servletContext, Map properties)
Create default Definition factory.
static DefinitionsFactorycreateDefinitionsFactory(ServletContext servletContext, ServletConfig servletConfig)
Create Definition factory.
static DefinitionsFactorycreateDefinitionsFactory(ServletContext servletContext, ServletConfig servletConfig, boolean checkIfExist)
Create Definition factory.
static ComponentDefinitiongetActionDefinition(ServletRequest request)
Get Definition stored in jsp context by an action.
static DefinitionsFactorygetDefinitionsFactory(ServletContext servletContext)
Get definition factory from appropriate servlet context.
static voidpopulateDefinitionsFactoryConfig(DefinitionsFactoryConfig factoryConfig, ServletConfig servletConfig)
Populate Definition Factory Config from web.xml properties.
protected static DefinitionsFactoryConfigreadFactoryConfig(ServletConfig servletConfig)
Create FactoryConfig and initialize it from web.xml.
static voidremoveActionDefinition(ServletRequest request, ComponentDefinition definition)
Remove Definition stored in jsp context.
static voidsetActionDefinition(ServletRequest request, ComponentDefinition definition)
Store definition in jsp context.

Field Detail

ACTION_DEFINITION

public static final String ACTION_DEFINITION
Constant name used to store definition in jsp context. Used to pass definition from a Struts action to servlet forward.

DEFINITIONS_CONFIG_USER_DEBUG_LEVEL

public static final String DEFINITIONS_CONFIG_USER_DEBUG_LEVEL
Name of init property carrying debug level.

DEFINITIONS_FACTORY

public static final String DEFINITIONS_FACTORY
Constant name used to store factory in context.

DEFINITIONS_FACTORY_CLASSNAME

public static final String DEFINITIONS_FACTORY_CLASSNAME
Name of init property carrying factory class name.

log

protected static Log log
Commons Logging instance.

NO_DEBUG

public static final int NO_DEBUG

Deprecated: This will be removed in a release after Struts 1.2.

User Debug level.

userDebugLevel

public static int userDebugLevel

Deprecated: This will be removed in a release after Struts 1.2.

Global user defined debug level.

Method Detail

createDefinitionsFactory

public static DefinitionsFactory createDefinitionsFactory(ServletContext servletContext, Map properties, String classname)

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

createDefinitionsFactory

public static DefinitionsFactory createDefinitionsFactory(ServletContext servletContext, Map properties)
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)
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)
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

getActionDefinition

public static ComponentDefinition getActionDefinition(ServletRequest request)
Get Definition stored in jsp context by an action.

Returns: ComponentDefinition or null if not found.

getDefinitionsFactory

public static DefinitionsFactory getDefinitionsFactory(ServletContext servletContext)

Deprecated: Use TilesUtil

Get definition factory from appropriate servlet context.

Returns: Definitions factory or null if not found.

Since: 20020708

populateDefinitionsFactoryConfig

public static void populateDefinitionsFactoryConfig(DefinitionsFactoryConfig factoryConfig, ServletConfig servletConfig)
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 method java.lang.reflect.InvocationTargetException if the property accessor method throws an exception

Since: tiles 20020708

See Also: org.apache.commons.beanutils.BeanUtils

readFactoryConfig

protected static DefinitionsFactoryConfig readFactoryConfig(ServletConfig servletConfig)
Create FactoryConfig and initialize it from web.xml.

Parameters: servletConfig ServletConfig for the module with which this plug in is associated

Throws: DefinitionsFactoryException if this PlugIn cannot be successfully initialized

removeActionDefinition

public static void removeActionDefinition(ServletRequest request, ComponentDefinition definition)
Remove Definition stored in jsp context. Mainly used by Struts to pass a definition defined in an Action to the forward.

setActionDefinition

public static void setActionDefinition(ServletRequest request, ComponentDefinition definition)
Store definition in jsp context. Mainly used by Struts to pass a definition defined in an Action to the forward.
Copyright B) 2000-2009 - The Apache Software Foundation