org.apache.struts.tiles
Class DefinitionsUtil

java.lang.Object
  |
  +--org.apache.struts.tiles.TilesUtil
        |
        +--org.apache.struts.tiles.DefinitionsUtil
All Implemented Interfaces:
ComponentConstants

Deprecated. Use TilesUtil.createDefinitionsFactory(ServletContext, DefinitionsFactoryConfig)

public class DefinitionsUtil
extends TilesUtil
implements ComponentConstants

Utilities class for definitions factory. Also define userDebugLevel property (TODO to be moved from this class ?).


Inner Class Summary
(package private) static class DefinitionsUtil.ServletPropertiesMap
          Deprecated. Inner class.
 
Field Summary
static java.lang.String ACTION_DEFINITION
          Deprecated. Constant name used to store definition in jsp context.
static java.lang.String DEFINITIONS_CONFIG_USER_DEBUG_LEVEL
          Deprecated. Name of init property carrying debug level.
static java.lang.String DEFINITIONS_FACTORY
          Deprecated. Constant name used to store factory in context.
static java.lang.String DEFINITIONS_FACTORY_CLASSNAME
          Deprecated. Name of init property carrying factory class name.
protected static org.apache.commons.logging.Log log
          Deprecated. Commons Logging instance.
static int NO_DEBUG
          Deprecated. This will be removed in a release after Struts 1.2.
static int userDebugLevel
          Deprecated. This will be removed in a release after Struts 1.2.
 
Fields inherited from class org.apache.struts.tiles.TilesUtil
implAlreadySet, tilesUtilImpl
 
Fields inherited from interface org.apache.struts.taglib.tiles.ComponentConstants
COMPONENT_CONTEXT, COMPONENT_SCOPE, EXCEPTION_KEY, LOCALE_KEY
 
Constructor Summary
DefinitionsUtil()
          Deprecated.  
 
Method Summary
static DefinitionsFactory createDefinitionsFactory(javax.servlet.ServletContext servletContext, java.util.Map properties)
          Deprecated. Create default Definition factory.
static DefinitionsFactory createDefinitionsFactory(javax.servlet.ServletContext servletContext, java.util.Map properties, java.lang.String classname)
          Deprecated. Use createDefinitionsFactory(ServletContext servletContext, ServletConfig servletConfig)
static DefinitionsFactory createDefinitionsFactory(javax.servlet.ServletContext servletContext, javax.servlet.ServletConfig servletConfig)
          Deprecated. Create Definition factory.
static DefinitionsFactory createDefinitionsFactory(javax.servlet.ServletContext servletContext, javax.servlet.ServletConfig servletConfig, boolean checkIfExist)
          Deprecated. Create Definition factory.
static ComponentDefinition getActionDefinition(javax.servlet.ServletRequest request)
          Deprecated. Get Definition stored in jsp context by an action.
static DefinitionsFactory getDefinitionsFactory(javax.servlet.ServletContext servletContext)
          Deprecated. Use TilesUtil.getDefinitionsFactory(ServletRequest, ServletContext)
static void populateDefinitionsFactoryConfig(DefinitionsFactoryConfig factoryConfig, javax.servlet.ServletConfig servletConfig)
          Deprecated. Populate Definition Factory Config from web.xml properties.
protected static DefinitionsFactoryConfig readFactoryConfig(javax.servlet.ServletConfig servletConfig)
          Deprecated. Create FactoryConfig and initialize it from web.xml.
static void removeActionDefinition(javax.servlet.ServletRequest request, ComponentDefinition definition)
          Deprecated. Remove Definition stored in jsp context.
static void setActionDefinition(javax.servlet.ServletRequest request, ComponentDefinition definition)
          Deprecated. Store definition in jsp context.
 
Methods inherited from class org.apache.struts.tiles.TilesUtil
createDefinitionsFactory, doForward, doInclude, doInclude, getDefinition, getDefinitionsFactory, getTilesUtil, isTilesUtilImplSet, setTilesUtil, testReset
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

log

protected static org.apache.commons.logging.Log log
Deprecated. 
Commons Logging instance.

userDebugLevel

public static int userDebugLevel
Deprecated. This will be removed in a release after Struts 1.2.

Global user defined debug level.

NO_DEBUG

public static final int NO_DEBUG
Deprecated. This will be removed in a release after Struts 1.2.

User Debug level.

DEFINITIONS_CONFIG_USER_DEBUG_LEVEL

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

DEFINITIONS_FACTORY_CLASSNAME

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

DEFINITIONS_FACTORY

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

ACTION_DEFINITION

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

DefinitionsUtil

public DefinitionsUtil()
Deprecated. 
Method Detail

createDefinitionsFactory

public static DefinitionsFactory createDefinitionsFactory(javax.servlet.ServletContext servletContext,
                                                          java.util.Map properties,
                                                          java.lang.String classname)
                                                   throws DefinitionsFactoryException
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(javax.servlet.ServletContext servletContext,
                                                          java.util.Map properties)
                                                   throws DefinitionsFactoryException
Deprecated. 
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(javax.servlet.ServletContext servletContext,
                                                          javax.servlet.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(javax.servlet.ServletContext servletContext,
                                                          javax.servlet.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

public static DefinitionsFactory getDefinitionsFactory(javax.servlet.ServletContext servletContext)
Deprecated. Use TilesUtil.getDefinitionsFactory(ServletRequest, ServletContext)

Get definition factory from appropriate servlet context.
Returns:
Definitions factory or null if not found.
Since:
20020708

getActionDefinition

public static ComponentDefinition getActionDefinition(javax.servlet.ServletRequest request)
Deprecated. 
Get Definition stored in jsp context by an action.
Returns:
ComponentDefinition or null if not found.

setActionDefinition

public static void setActionDefinition(javax.servlet.ServletRequest request,
                                       ComponentDefinition definition)
Deprecated. 
Store definition in jsp context. Mainly used by Struts to pass a definition defined in an Action to the forward.

removeActionDefinition

public static void removeActionDefinition(javax.servlet.ServletRequest request,
                                          ComponentDefinition definition)
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,
                                                    javax.servlet.ServletConfig servletConfig)
                                             throws java.lang.IllegalAccessException,
                                                    java.lang.reflect.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:
java.lang.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:
BeanUtils

readFactoryConfig

protected static DefinitionsFactoryConfig readFactoryConfig(javax.servlet.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 this PlugIn cannot be successfully initialized


Copyright 2000-2006 - The Apache Software Foundation