cedric 2002/07/11 09:20:32
Added: src/share/org/apache/struts/tiles DefinitionsFactory.java
DefinitionsFactoryConfig.java
Log:
Define a new interface for Tiles definition factories, and a configuration class.
The new interface provide methods for factory life cycle (init and destroy),
as well as for setting factory configuration object.
Revision Changes Path
1.1
jakarta-struts/src/share/org/apache/struts/tiles/DefinitionsFactory.java
Index: DefinitionsFactory.java
===================================================================
/*
* $Header:
/home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/DefinitionsFactory.java,v
1.1 2002/07/11 16:20:32 cedric Exp $
* $Revision: 1.1 $
* $Date: 2002/07/11 16:20:32 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Struts", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.struts.tiles;
import org.apache.struts.tiles.*;
import java.io.Serializable;
import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.ServletRequest;
import org.apache.struts.tiles.DefinitionsFactoryException;
import org.apache.struts.tiles.NoSuchDefinitionException;
/**
* Tiles Definition factory.
* This interface replace old ComponentDefinitionsFactory.
* Main method getDefinition() is exactly the same. Initialization method change.
* This interface allows to retrieve a definition by its name, independently of
* the factory implementation.
* Object life cycle is as follow:
* <ul>
* <li>Constructor: create object</li>
* <li>setConfig: set config and initialize factory. After first call to this
* method, factory is operational.</li>
* <li>destroy: factory is being shutdown.</li>
* </ul>
* Implementation must be Serializable, in order to be compliant with web Container
* having this constraint (Weblogic 6.x).
*/
public interface DefinitionsFactory extends Serializable
{
/**
* Get a definition by its name.
* @param name Name of requested definition.
* @param request Current servelet request
* @param servletContext current servlet context
* @throws DefinitionsFactoryException An error occur while getting definition.
* @throws NoSuchDefinitionException No definition found for specified name
* Implementation can throw more accurate exception as a subclass of this
exception
*/
public ComponentDefinition getDefinition(String name, ServletRequest request,
ServletContext servletContext)
throws NoSuchDefinitionException,DefinitionsFactoryException;
/**
* Init definition factory.
* This method is called immediately after factory creation, and prior any call
* to setConfig().
*
* @param config Configuration object used to set factory configuration.
* @param servletContext Servlet Context passed to factory.
* @throws DefinitionsFactoryException An error occur during initialization.
*/
public void init(DefinitionsFactoryConfig config, ServletContext servletContext)
throws DefinitionsFactoryException;
/**
* <p>Receive notification that the factory is being
* shut down.</p>
*/
public void destroy();
/**
* Set factory configuration.
* This method is used to change factory configuration.
* This method is optional, and can send an exception if implementation
* doesn't allow change in configuration.
*
* @param config Configuration object used to set factory configuration.
* @param servletContext Servlet Context passed to factory.
* @throws DefinitionsFactoryException An error occur during initialization.
*/
public void setConfig(DefinitionsFactoryConfig config, ServletContext
servletContext)
throws DefinitionsFactoryException;
/**
* Get factory configuration.
* @return TilesConfig
*/
public DefinitionsFactoryConfig getConfig();
}
1.1
jakarta-struts/src/share/org/apache/struts/tiles/DefinitionsFactoryConfig.java
Index: DefinitionsFactoryConfig.java
===================================================================
/*
* $Header:
/home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/DefinitionsFactoryConfig.java,v
1.1 2002/07/11 16:20:32 cedric Exp $
* $Revision: 1.1 $
* $Date: 2002/07/11 16:20:32 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Struts", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.struts.tiles;
import org.apache.struts.tiles.*;
import java.util.Map;
import java.util.HashMap;
import java.util.Set;
import java.util.Iterator;
import org.apache.commons.beanutils.BeanUtils;
/**
* A TilesFactoryConfig object hold configuration attributes for a tile
* definition factory.
*
* @author Cedric Dumoulin
* @since 1.1
* @version $Revision: 1.1 $ $Date: 2002/07/11 16:20:32 $
*/
public class DefinitionsFactoryConfig
{
/**
* Fully qualfied classname of the factory to create.
* If no classname is set, a default factory is created
* (of class "org.apache.struts.tiles.xmlDefinition.I18nFactorySet").
*/
protected String factoryClassname =
"org.apache.struts.tiles.xmlDefinition.I18nFactorySet";
/**
* Debug level value. 0=no debug info >0 = debug info.
*/
protected int debugLevel = 0;
/**
* Debug level value used when parsing configuration file.
* . 0=no debug info >0 = debug info.
*/
protected int parserDebugLevel = 0;
/**
* Do we want the parser to validate configuration file ?
* Default value is true.
*/
protected boolean parserValidate = true;
/** Definition configuration file specofied by user */
protected String definitionConfigFiles;
/** Alternate name for parser debug details properties in configuration file */
public static final String PARSER_DETAILS_PARAMETER_NAME =
"definitions-parser-details";
/** Alternate name for parser validate properties in configuration file */
public static final String PARSER_VALIDATE_PARAMETER_NAME =
"definitions-parser-validate";
/** Alternate name for factory classname properties in configuration file */
public static final String FACTORY_CLASSNAME_PARAMETER_NAME =
"definitions-factory-class";
/** Alternate name for definition files properties in configuration file */
public static final String DEFINITIONS_CONFIG_PARAMETER_NAME =
"definitions-config";
/** Alternate name for definition debug details properties in configuration
file */
public static final String TILES_DETAILS_PARAMETER_NAME = "definitions-debug";
/**
* Map of extra attribute available.
*/
private Map extraAttributes = new HashMap();
/**
* Default constructor.
*/
public DefinitionsFactoryConfig()
{
}
/**
* Constructor.
* Create configuration object, and initialize it with parameters from Map.
* Parameters corresponding to an attribute are filtered and stored in appropriate
* attribute.
* @param initParameters
*/
public DefinitionsFactoryConfig(Map initParameters)
{
}
/**
* Access method for the factoryClassname property.
*
* @return the current value of the factoryClassname property
*/
public String getFactoryClassname()
{
return factoryClassname;
}
/**
* Sets the value of the factoryClassname property.
*
* @param aFactoryClassname the new value of the factoryClassname property
*/
public void setFactoryClassname(String aFactoryClassname)
{
factoryClassname = aFactoryClassname;
}
/**
* Access method for the debugLevel property.
*
* @return the current value of the debugLevel property
*/
public int getDebugLevel()
{
return debugLevel;
}
/**
* Sets the value of the debugLevel property.
*
* @param aDebugLevel the new value of the debugLevel property
*/
public void setDebugLevel(int aDebugLevel)
{
debugLevel = aDebugLevel;
}
/**
* Access method for the parserDebugLevel property.
*
* @return the current value of the parserDebugLevel property
*/
public int getParserDebugLevel()
{
return parserDebugLevel;
}
/**
* Sets the value of the parserDebugLevel property.
*
* @param aParserDebugLevel the new value of the parserDebugLevel property
*/
public void setParserDebugLevel(int aParserDebugLevel)
{
parserDebugLevel = aParserDebugLevel;
}
/**
* Determines if the parserValidate property is true.
*
* @return <code>true<code> if the parserValidate property is true
*/
public boolean getParserValidate()
{
return parserValidate;
}
/**
* Sets the value of the parserValidate property.
*
* @param aParserValidate the new value of the parserValidate property
*/
public void setParserValidate(boolean aParserValidate)
{
parserValidate = aParserValidate;
}
/**
* Access method for the definitionConfigFiles property.
*
* @return the current value of the definitionConfigFiles property
*/
public String getDefinitionConfigFiles()
{
return definitionConfigFiles;
}
/**
* Sets the value of the definitionConfigFiles property.
*
* @param aDefinitionConfigFiles the new value of the definitionConfigFiles
property
*/
public void setDefinitionConfigFiles(String aDefinitionConfigFiles)
{
definitionConfigFiles = aDefinitionConfigFiles;
}
/**
* Set a new extra attribute value.
* @param name Name of the attribute.
* @param value Value of the attribute.
*/
public void setAttribute(String name, Object value)
{
extraAttributes.put(name, value);
}
/**
* Get extra attribute value.
* @param name Name of the attribute.
* @return Value of the attribute, or null if not found.
*/
public Object getAttribute(String name)
{
return extraAttributes.get(name);
}
/**
* Get extra attributes as a Map.
* @return Map A Map containing attribute name - value pair.
*/
public Map getAttributes()
{
Map map = new HashMap(extraAttributes);
// Add property attributes using old names
/*
map.put(DEFINITIONS_CONFIG_PARAMETER_NAME, getDefinitionConfigFiles());
map.put(TILES_DETAILS_PARAMETER_NAME, Integer.toString(getDebugLevel()) );
map.put(PARSER_DETAILS_PARAMETER_NAME, Integer.toString(getParserDebugLevel()) );
map.put(PARSER_VALIDATE_PARAMETER_NAME, new
Boolean(getParserValidate()).toString() );
if( !
"org.apache.struts.tiles.xmlDefinition.I18nFactorySet".equals(getFactoryClassname()) )
map.put(FACTORY_CLASSNAME_PARAMETER_NAME, getFactoryClassname());
*/
return map;
}
/**
* Populate this config object from properties map, based on
* the specified name/value pairs. This method uses the populate() method from
* org.apache.commons.beanutils.BeanUtil.
* <p>
* Properties keys are scanned for old property names, and linked to new name
* if necessary. This modify the properties map.
* <p>
* The particular setter method to be called for each property is
* determined using the usual JavaBeans introspection mechanisms. Thus,
* you may identify custom setter methods using a BeanInfo class that is
* associated with the class of the bean itself. If no such BeanInfo
* class is available, the standard method name conversion ("set" plus
* the capitalized name of the property in question) is used.
* <p>
* <strong>NOTE</strong>: It is contrary to the JavaBeans Specification
* to have more than one setter method (with different argument
* signatures) for the same property.
*
* @param properties Map keyed by property name, with the
* corresponding (String or String[]) value(s) to be set
*
* @exception IllegalAccessException if the caller does not have
* access to the property accessor method
* @exception InvocationTargetException if the property accessor method
* throws an exception
* @see org.apache.commons.beanutils.BeanUtil
*/
public void populate( Map properties)
throws
java.lang.IllegalAccessException,java.lang.reflect.InvocationTargetException
{
// link old parameter names for backward compatibility
linkOldPropertyNames(properties);
BeanUtils.populate( this, properties);
}
/**
* Link old property names to new property names.
* This modify the map.
* @param properties Map keyed by property name, with the
* corresponding (String or String[]) value(s) to be set
*
*/
static public void linkOldPropertyNames( Map properties)
{
Set entries = properties.entrySet();
Map toAdd = new HashMap();
Iterator i = entries.iterator();
while( i.hasNext() )
{
Map.Entry entry = (Map.Entry)i.next();
if(DEFINITIONS_CONFIG_PARAMETER_NAME.equals(entry.getKey()))
toAdd.put( "definitionConfigFiles", entry.getValue());
else if(FACTORY_CLASSNAME_PARAMETER_NAME.equals(entry.getKey()))
toAdd.put( "factoryClassname", entry.getValue());
else if(PARSER_DETAILS_PARAMETER_NAME.equals(entry.getKey()))
toAdd.put( "parserDebugLevel", entry.getValue());
else if(PARSER_VALIDATE_PARAMETER_NAME.equals(entry.getKey()))
toAdd.put( "parserValidate", entry.getValue());
else if(TILES_DETAILS_PARAMETER_NAME.equals(entry.getKey()))
toAdd.put( "debugLevel", entry.getValue());
} // end loop
if( toAdd.size() > 0 )
properties.putAll( toAdd );
}
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
