Class TilesConfigurer
- java.lang.Object
- org.springframework.web.servlet.view.tiles3.TilesConfigurer
- All Implemented Interfaces:
Aware
,DisposableBean
,InitializingBean
,ServletContextAware
public class TilesConfigurer extends Object implements ServletContextAware, InitializingBean, DisposableBean
Helper class to configure Tiles 3.x for the Spring Framework. See https://tiles.apache.org for more information about Tiles, which basically is a templating mechanism for web applications using JSPs and other template engines.The TilesConfigurer simply configures a TilesContainer using a set of files containing definitions, to be accessed by
TilesView
instances. This is a Spring-based alternative (for usage in Spring configuration) to the Tiles-providedServletContextListener
(e.g.CompleteAutoloadTilesListener
for usage inweb.xml
.TilesViews can be managed by any
ViewResolver
. For simple convention-based view resolution, consider usingTilesViewResolver
.A typical TilesConfigurer bean definition looks as follows:
<bean id="tilesConfigurer" class="org.springframework.web.servlet.view.tiles3.TilesConfigurer"> <property name="definitions"> <list> <value>/WEB-INF/defs/general.xml</value> <value>/WEB-INF/defs/widgets.xml</value> <value>/WEB-INF/defs/administrator.xml</value> <value>/WEB-INF/defs/customer.xml</value> <value>/WEB-INF/defs/templates.xml</value> </list> </property> </bean>
The values in the list are the actual Tiles XML files containing the definitions. If the list is not specified, the default is"/WEB-INF/tiles.xml"
.Note that in Tiles 3 an underscore in the name of a file containing Tiles definitions is used to indicate locale information, for example:
<bean id="tilesConfigurer" class="org.springframework.web.servlet.view.tiles3.TilesConfigurer"> <property name="definitions"> <list> <value>/WEB-INF/defs/tiles.xml</value> <value>/WEB-INF/defs/tiles_fr_FR.xml</value> </list> </property> </bean>
- Since:
- 3.2
- Author:
- mick semb wever, Rossen Stoyanchev, Juergen Hoeller
- See Also:
TilesView
,TilesViewResolver
Constructor Summary
Constructors Constructor Description TilesConfigurer()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
afterPropertiesSet()
Creates and exposes a TilesContainer for this web application, delegating to the TilesInitializer.void
destroy()
Removes the TilesContainer from this web application.void
setCheckRefresh(boolean checkRefresh)
Set whether to check Tiles definition files for a refresh at runtime.void
setCompleteAutoload(boolean completeAutoload)
Specify whether to apply Tiles 3.0's "complete-autoload" configuration.void
setDefinitions(String... definitions)
Set the Tiles definitions, i.e.void
setDefinitionsFactoryClass(Class<? extends DefinitionsFactory> definitionsFactoryClass)
Set theDefinitionsFactory
implementation to use.void
setPreparerFactoryClass(Class<? extends PreparerFactory> preparerFactoryClass)
Set thePreparerFactory
implementation to use.void
setServletContext(ServletContext servletContext)
Set theServletContext
that this object runs in.void
setTilesInitializer(TilesInitializer tilesInitializer)
Configure Tiles using a custom TilesInitializer, typically specified as an inner bean.void
setUseMutableTilesContainer(boolean useMutableTilesContainer)
Set whether to use a MutableTilesContainer (typically the CachingTilesContainer implementation) for this application.void
setValidateDefinitions(boolean validateDefinitions)
Set whether to validate the Tiles XML definitions.
Constructor Detail
TilesConfigurer
public TilesConfigurer()
Method Detail
setTilesInitializer
public void setTilesInitializer(TilesInitializer tilesInitializer)
Configure Tiles using a custom TilesInitializer, typically specified as an inner bean.Default is a variant of
DefaultTilesInitializer
, respecting the "definitions", "preparerFactoryClass" etc properties on this configurer.NOTE: Specifying a custom TilesInitializer effectively disables all other bean properties on this configurer. The entire initialization procedure is then left to the TilesInitializer as specified.
setCompleteAutoload
public void setCompleteAutoload(boolean completeAutoload)
Specify whether to apply Tiles 3.0's "complete-autoload" configuration.See
CompleteAutoloadTilesContainerFactory
for details on the complete-autoload mode.NOTE: Specifying the complete-autoload mode effectively disables all other bean properties on this configurer. The entire initialization procedure is then left to
CompleteAutoloadTilesInitializer
.
setDefinitions
public void setDefinitions(String... definitions)
Set the Tiles definitions, i.e. the list of files containing the definitions. Default is "/WEB-INF/tiles.xml".
setCheckRefresh
public void setCheckRefresh(boolean checkRefresh)
Set whether to check Tiles definition files for a refresh at runtime. Default is "false".
setValidateDefinitions
public void setValidateDefinitions(boolean validateDefinitions)
Set whether to validate the Tiles XML definitions. Default is "true".
setDefinitionsFactoryClass
public void setDefinitionsFactoryClass(Class<? extends DefinitionsFactory> definitionsFactoryClass)
Set theDefinitionsFactory
implementation to use. Default isUnresolvingLocaleDefinitionsFactory
, operating on definition resource URLs.Specify a custom DefinitionsFactory, e.g. a UrlDefinitionsFactory subclass, to customize the creation of Tiles Definition objects. Note that such a DefinitionsFactory has to be able to handle
URL
source objects, unless you configure a different TilesContainerFactory.
setPreparerFactoryClass
public void setPreparerFactoryClass(Class<? extends PreparerFactory> preparerFactoryClass)
Set thePreparerFactory
implementation to use. Default isBasicPreparerFactory
, creating shared instances for specified preparer classes.Specify
SimpleSpringPreparerFactory
to autowireViewPreparer
instances based on specified preparer classes, applying Spring's container callbacks as well as applying configured Spring BeanPostProcessors. If Spring's context-wide annotation-config has been activated, annotations in ViewPreparer classes will be automatically detected and applied.Specify
SpringBeanPreparerFactory
to operate on specified preparer names instead of classes, obtaining the corresponding Spring bean from the DispatcherServlet's application context. The full bean creation process will be in the control of the Spring application context in this case, allowing for the use of scoped beans etc. Note that you need to define one Spring bean definition per preparer name (as used in your Tiles definitions).
setUseMutableTilesContainer
public void setUseMutableTilesContainer(boolean useMutableTilesContainer)
Set whether to use a MutableTilesContainer (typically the CachingTilesContainer implementation) for this application. Default is "false".- See Also:
MutableTilesContainer
,CachingTilesContainer
setServletContext
public void setServletContext(ServletContext servletContext)
Description copied from interface:ServletContextAware
Set theServletContext
that this object runs in.Invoked after population of normal bean properties but before an init callback like InitializingBean's
afterPropertiesSet
or a custom init-method. Invoked after ApplicationContextAware'ssetApplicationContext
.- Specified by:
setServletContext
in interfaceServletContextAware
- Parameters:
servletContext
- ServletContext object to be used by this object- See Also:
InitializingBean.afterPropertiesSet()
,ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
afterPropertiesSet
public void afterPropertiesSet() throws TilesException
Creates and exposes a TilesContainer for this web application, delegating to the TilesInitializer.- Specified by:
afterPropertiesSet
in interfaceInitializingBean
- Throws:
TilesException
- in case of setup failure
destroy
public void destroy() throws TilesException
Removes the TilesContainer from this web application.- Specified by:
destroy
in interfaceDisposableBean
- Throws:
TilesException
- in case of cleanup failure