* Convenience method. Calls createDefinitionsFactory(ServletContext servletContext, DefinitionsFactoryConfig factoryConfig) * * @param servletContext Servlet Context passed to newly created factory. * @param servletConfig Servlet config containing parameters to be passed to factory configuration object. * @return newly created factory of type ConfigurableDefinitionsFactory. * @throws DefinitionsFactoryException If an error occur while initializing factory */ public static DefinitionsFactory createDefinitionsFactory( ServletContext servletContext, ServletConfig servletConfig) throws DefinitionsFactoryException { DefinitionsFactoryConfig factoryConfig = readFactoryConfig(servletConfig); return createDefinitionsFactory(servletContext, factoryConfig); } /** * 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)
*
* @param servletContext Servlet Context passed to newly created factory.
* @param servletConfig Servlet config containing parameters to be passed to factory configuration object.
* @param 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.
* @return newly created factory of type ConfigurableDefinitionsFactory.
* @throws DefinitionsFactoryException If an error occur while initializing factory
*/
public static DefinitionsFactory createDefinitionsFactory(
ServletContext servletContext,
ServletConfig servletConfig,
boolean checkIfExist)
throws DefinitionsFactoryException {
if (checkIfExist) {
// Check if already exist in context
DefinitionsFactory factory = getDefinitionsFactory(servletContext);
if (factory != null)
return factory;
}
return createDefinitionsFactory(servletContext, servletConfig);
}
/**
* Get definition factory from appropriate servlet context.
* @return Definitions factory or null if not found.
* @deprecated Use {@link TilesUtil#getDefinitionsFactory(ServletRequest, ServletContext)}
* @since 20020708
*/
public static DefinitionsFactory getDefinitionsFactory(ServletContext servletContext) {
return (DefinitionsFactory) servletContext.getAttribute(DEFINITIONS_FACTORY);
}
/**
* Get Definition stored in jsp context by an action.
* @return ComponentDefinition or null if not found.
*/
public static ComponentDefinition getActionDefinition(ServletRequest request) {
return (ComponentDefinition) request.getAttribute(ACTION_DEFINITION);
}
/**
* Store definition in jsp context.
* Mainly used by Struts to pass a definition defined in an Action to the forward.
*/
public static void setActionDefinition(
ServletRequest request,
ComponentDefinition definition) {
request.setAttribute(ACTION_DEFINITION, definition);
}
/**
* Remove Definition stored in jsp context.
* Mainly used by Struts to pass a definition defined in an Action to the forward.
*/
public static void removeActionDefinition(
ServletRequest request,
ComponentDefinition definition) {
request.removeAttribute(ACTION_DEFINITION);
}
/**
* Populate Definition Factory Config from web.xml properties.
* @param factoryConfig Definition Factory Config to populate.
* @param servletConfig Current servlet config containing web.xml properties.
* @exception IllegalAccessException if the caller does not have
* access to the property accessor method
* @exception java.lang.reflect.InvocationTargetException if the property accessor method
* throws an exception
* @see org.apache.commons.beanutils.BeanUtils
* @since tiles 20020708
*/
public static void populateDefinitionsFactoryConfig(
DefinitionsFactoryConfig factoryConfig,
ServletConfig servletConfig)
throws IllegalAccessException, InvocationTargetException {
Map properties = new DefinitionsUtil.ServletPropertiesMap(servletConfig);
factoryConfig.populate(properties);
}
/**
* Create FactoryConfig and initialize it from web.xml.
*
* @param servletConfig ServletConfig for the module with which
* this plug in is associated
* @exception DefinitionsFactoryException if this PlugIn cannot
* be successfully initialized
*/
protected static DefinitionsFactoryConfig readFactoryConfig(ServletConfig servletConfig)
throws DefinitionsFactoryException {
// Create tiles definitions config object
DefinitionsFactoryConfig factoryConfig = new DefinitionsFactoryConfig();
// Get init parameters from web.xml files
try {
DefinitionsUtil.populateDefinitionsFactoryConfig(
factoryConfig,
servletConfig);
} catch (Exception ex) {
ex.printStackTrace();
throw new DefinitionsFactoryException(
"Can't populate DefinitionsFactoryConfig class from 'web.xml'.",
ex);
}
return factoryConfig;
}
/**
* Inner class.
* Wrapper for ServletContext init parameters.
* Object of this class is an hashmap containing parameters and values
* defined in the servlet config file (web.xml).
*/
static class ServletPropertiesMap extends HashMap {
/**
* Constructor.
*/
ServletPropertiesMap(ServletConfig config) {
// This implementation is very simple.
// It is possible to avoid creation of a new structure, but this need
// imply writing all Map interface.
Enumeration e = config.getInitParameterNames();
while (e.hasMoreElements()) {
String key = (String) e.nextElement();
put(key, config.getInitParameter(key));
}
}
} // end inner class
}