org.apache.struts.tiles

Class TilesUtilImpl

public class TilesUtilImpl extends Object implements Serializable

Default implementation of TilesUtil. This class contains default implementation of utilities. This implementation is intended to be used without Struts.
Field Summary
static StringDEFINITIONS_FACTORY
Constant name used to store factory in servlet context
protected Loglog
Commons Logging instance.
Method Summary
protected DefinitionsFactorycreateDefinitionFactoryInstance(String classname)
Create Definition factory of specified classname.
DefinitionsFactorycreateDefinitionsFactory(ServletContext servletContext, DefinitionsFactoryConfig factoryConfig)
Create Definition factory from specified configuration object.
voiddoForward(String uri, HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
Do a forward using request dispatcher.
voiddoInclude(String uri, HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
Do an include using request dispatcher.
voiddoInclude(String uri, PageContext pageContext)
Do an include using PageContext.include().
DefinitionsFactorygetDefinitionsFactory(ServletRequest request, ServletContext servletContext)
Get definition factory from appropriate servlet context.
protected voidmakeDefinitionsFactoryAccessible(DefinitionsFactory factory, ServletContext servletContext)
Make definition factory accessible to Tags.

Field Detail

DEFINITIONS_FACTORY

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

log

protected Log log
Commons Logging instance.

Method Detail

createDefinitionFactoryInstance

protected DefinitionsFactory createDefinitionFactoryInstance(String classname)
Create Definition factory of specified classname. Factory class must extend the DefinitionsFactory class. The factory is wrapped appropriately with ComponentDefinitionsFactoryWrapper if it is an instance of the deprecated ComponentDefinitionsFactory class.

Parameters: classname Class name of the factory to create.

Returns: newly created factory.

Throws: DefinitionsFactoryException If an error occur while initializing factory

createDefinitionsFactory

public DefinitionsFactory createDefinitionsFactory(ServletContext servletContext, DefinitionsFactoryConfig factoryConfig)
Create Definition factory from specified configuration object. Create an instance of the factory with the class specified in the config object. Then, initialize this factory and finally store the factory in appropriate context by calling TilesUtilImpl. Factory creation is done by createDefinitionFactoryInstance.

Parameters: servletContext Servlet Context passed to newly created factory. factoryConfig Configuration object passed to factory.

Returns: newly created factory of type specified in the config object.

Throws: DefinitionsFactoryException If an error occur while initializing factory

doForward

public void doForward(String uri, HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
Do a forward using request dispatcher. This method is used by the Tiles package anytime a forward is required.

Parameters: uri Uri or Definition name to forward. request Current page request. servletContext Current servlet context.

doInclude

public void doInclude(String uri, HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
Do an include using request dispatcher. This method is used by the Tiles package when an include is required. The Tiles package can use indifferently any form of this method.

Parameters: uri Uri or Definition name to forward. request Current page request. response Current page response. servletContext Current servlet context.

doInclude

public void doInclude(String uri, PageContext pageContext)
Do an include using PageContext.include(). This method is used by the Tiles package when an include is required. The Tiles package can use indifferently any form of this method.

Parameters: uri Uri or Definition name to forward. pageContext Current page context.

getDefinitionsFactory

public DefinitionsFactory getDefinitionsFactory(ServletRequest request, ServletContext servletContext)
Get definition factory from appropriate servlet context.

Returns: Definitions factory or null if not found.

makeDefinitionsFactoryAccessible

protected void makeDefinitionsFactoryAccessible(DefinitionsFactory factory, ServletContext servletContext)
Make definition factory accessible to Tags. Factory is stored in servlet context.

Parameters: factory Factory to be made accessible. servletContext Current servlet context.

Copyright B) 2000-2008 - The Apache Software Foundation