Apache Tiles

Configuration reference

In this page you can find a fast reference on configuring the various parts of Tiles. These configuration parameters can be used as context parameters of a web application, or as init parameters of servlets, filters or portlets.

Summary

Standard configuration

Main configuration.

`org.apache.tiles.context.AbstractTilesApplicationContextFactory`	Tiles application context factory class name
`org.apache.tiles.context.TilesRequestContextFactory`	Tiles request context factory class name
`org.apache.tiles.factory.AbstractTilesContainerFactory`	Class name of the container factory
`org.apache.tiles.factory.TilesContainerFactory.MUTABLE`	Flag to use a mutable container
`org.apache.tiles.definition.DefinitionsFactory`	Definitions factory class name
`org.apache.tiles.definition.DefinitionsFactory.DEFINITIONS_CONFIG`	List of paths that contain Tiles definitions
`org.apache.tiles.evaluator.AttributeEvaluator`	Attribute evaluator class name
`org.apache.tiles.preparer.PreparerFactory`	View preparer factory class name
`org.apache.tiles.renderer.RendererFactory`	Attribute renderer factory class name
`org.apache.tiles.renderer.impl.BasicRendererFactory.TYPE_RENDERERS`	Attribute renderers class name
`org.apache.tiles.renderer.impl.BasicRendererFactory.DEFAULT_RENDERER`	Default attribute renderer class name

CachingLocaleUrlDefinitionDAO configuration.
org.apache.tiles.definition.dao.LocaleUrlDefinitionDAO.CHECK_REFRESH Flag to enable automatic refresh check
ChainedTilesApplicationContextFactory configuration.
org.apache.tiles.context.ChainedTilesApplicationContextFactory.FACTORY_CLASS_NAMES List of elementary application factory class names
ChainedTilesRequestContextFactory configuration.
org.apache.tiles.context.ChainedTilesRequestContextFactory.FACTORY_CLASS_NAMES List of elementary request factory class names
DigesterDefinitionsReader configuration.
org.apache.tiles.definition.digester.DigesterDefinitionsReader.PARSER_VALIDATE Flag to deactivate XML parser validation
UrlDefinitionsFactory configuration.
org.apache.tiles.definition.DefinitionsReader Definitions reader class name

org.apache.tiles.locale.LocaleResolver Locale resolver class name
Initialization configuration.
org.apache.tiles.startup.BasicTilesInitializer.CONTAINER_KEY Container key

Extended configuration

KeyedDefinitionsFactoryTilesContainerFactory configuration.

`org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer.KeyExtractor`	Key extractor class name
`org.apache.tiles.factory.KeyedDefinitionsFactoryTilesContainerFactory.KEYS`	List of keys to be used
`org.apache.tiles.DEFINITIONS_CONFIG@${key}`	List of paths containing definitions for the given `key`

Deprecated configuration

The following configuration parameters are deprecated:

org.apache.tiles.context.ChainedTilesContextFactory.FACTORY_CLASS_NAMES: use org.apache.tiles.context.ChainedTilesApplicationContextFactory.FACTORY_CLASS_NAMES or org.apache.tiles.context.ChainedTilesRequestContextFactory.FACTORY_CLASS_NAMES
org.apache.tiles.context.TilesContextFactory: use org.apache.tiles.context.AbstractTilesApplicationContextFactory or org.apache.tiles.context.TilesRequestContextFactory
org.apache.tiles.factory.TilesContainerFactory: use org.apache.tiles.factory.AbstractTilesContainerFactory
org.apache.tiles.impl.BasicTilesContainer.DEFINITIONS_CONFIG: use org.apache.tiles.definition.DefinitionsFactory.DEFINITIONS_CONFIG

Standard configuration parameters

Main configuration

`org.apache.tiles.context.AbstractTilesApplicationContextFactory`

Specifies the application context factory class name to use.

Specified in: org.apache.tiles.context.AbstractTilesApplicationContextFactory.
Default: org.apache.tiles.context.ChainedTilesApplicationContextFactory.
Usage: when specified, it must contain the name of a class that implements the AbstractTilesApplicationContextFactory interface.

`org.apache.tiles.context.TilesRequestContextFactory`

Specifies the request context factory class name to use.

Specified in: org.apache.tiles.factory.TilesContainerFactory.
Default: org.apache.tiles.context.ChainedTilesRequestContextFactory.
Usage: when specified, it must contain the name of a class that implements the TilesRequestContextFactory interface.

`org.apache.tiles.factory.AbstractTilesContainerFactory`

Specifies the container factory class name to use.

Specified in: org.apache.tiles.factory.AbstractTilesContainerFactory.
Default: org.apache.tiles.factory.TilesContainerFactory.
Usage: when specified, it must contain the name of a class that extends the AbstractTilesContainerFactory class.

`org.apache.tiles.factory.TilesContainerFactory.MUTABLE`

Flag to use a mutable container.

Specified in: org.apache.tiles.factory.TilesContainerFactory.
Default: false (the container is not mutable).
Usage: when specified and when its value is true, the container to be created will be mutable, i.e. definitions can be created at runtime.

`org.apache.tiles.definition.DefinitionsFactory`

Specifies the context factory class name to use.

Specified in: org.apache.tiles.factory.TilesContainerFactory.
Default: org.apache.tiles.definition.UrlDefinitionsFactory.
Usage: when specified, it must contain the name of a class that implements the DefinitionsFactory interface.

`org.apache.tiles.evaluator.AttributeEvaluator`

Specifies the attribute evaluator class name to use.

Specified in: org.apache.tiles.factory.TilesContainerFactory.
Default: org.apache.tiles.evaluator.impl.DirectAttributeEvaluator.
Usage: when specified, it must contain the name of a class that implements the AttributeEvaluator interface.

`org.apache.tiles.preparer.PreparerFactory`

Specifies the view preparer factory class name to use.

Specified in: org.apache.tiles.factory.TilesContainerFactory.
Default: org.apache.tiles.preparer.BasicPreparerFactory.
Usage: when specified, it must contain the name of a class that implements the PreparerFactory interface.

`org.apache.tiles.renderer.RendererFactory`

Specify the class of the attribute renderer factory to use.

Specified in: org.apache.tiles.factory.TilesContainerFactory.
Default: org.apache.tiles.renderer.impl.BasicRendererFactory
Usage: when specified, it must contain the class name of the attribute renderer factory to use.

`org.apache.tiles.renderer.impl.BasicRendererFactory.TYPE_RENDERERS`

Specifies the named attribute renderers that can be used.

Specified in: org.apache.tiles.renderer.impl.BasicRendererFactory.
Default: string,org.apache.tiles.renderer.impl.StringAttributeRenderer; definition,org.apache.tiles.renderer.impl.DefinitionAttributeRenderer; template,org.apache.tiles.renderer.impl.TemplateAttributeRenderer.
Usage: when specified, it must contain a semicolon (;) separated list of comma-separated pairs (,) in which:
the first element is the name of the renderer;
the second element is the class name of the attribute renderer.

`org.apache.tiles.renderer.impl.BasicRendererFactory.DEFAULT_RENDERER`

Specifies the named attribute renderers that can be used.

Specified in: org.apache.tiles.renderer.impl.BasicRendererFactory.
Default: org.apache.tiles.renderer.impl.UntypedAttributeRenderer
Usage: when specified, it must contain the class name of the attribute renderer to use in case the type of an attribute is not specified.

`BasicTilesContainer` configuration

`org.apache.tiles.definition.DefinitionsFactory.DEFINITIONS_CONFIG`

Specifies the list of files that contain the definitions.

Specified in: org.apache.tiles.definition.DefinitionsFactory.
Default: /WEB-INF/tiles.xml.
Usage: when specified, it must contain a comma-separated list of paths of files that contain Tiles definitions.

`CachingLocaleUrlDefinitionDAO` configuration

`org.apache.tiles.definition.dao.LocaleUrlDefinitionDAO.CHECK_REFRESH`

Flag that indicates whether to auto-refresh definitions when definition files are modified.

Specified in: org.apache.tiles.definition.dao.CachingLocaleUrlDefinitionDAO.
Default: false (no caching)
Usage: Set to true if you want to enable auto refresh of definitions files.

`ChainedTilesApplicationContextFactory` configuration

`org.apache.tiles.context.ChainedTilesApplicationContextFactory.FACTORY_CLASS_NAMES`

Specifies the list of elementary Tiles application context factory class names.

Specified in: org.apache.tiles.context.ChainedTilesApplicationContextFactory.
Default: org.apache.tiles.servlet.context.ServletTilesApplicationContextFactory, org.apache.tiles.portlet.context.PortletApplicationTilesApplicationContextFactory
Usage: when specified, it must contain a comma-separated list of class names extending AbstractTilesApplicationContextFactory.

`ChainedTilesRequestContextFactory` configuration

`org.apache.tiles.context.ChainedTilesRequestContextFactory.FACTORY_CLASS_NAMES`

Specifies the list of elementary Tiles request context factory class names.

Specified in: org.apache.tiles.context.ChainedTilesRequestContextFactory.
Default: org.apache.tiles.servlet.context.ServletTilesRequestContextFactory, org.apache.tiles.portlet.context.PortletTilesRequestContextFactory, org.apache.tiles.jsp.context.JspTilesRequestContextFactory
Usage: when specified, it must contain a comma-separated list of class names implementing TilesRequestContextFactory.

`DigesterDefinitionsReader` configuration

`org.apache.tiles.definition.digester.DigesterDefinitionsReader.PARSER_VALIDATE`

Specifies if the digester should validate input XML files.

Specified in: org.apache.tiles.definition.digester.DigesterDefinitionsReader.
Default: true
Usage: when specified, it must be true if you want to enable validation, false otherwise..

`UrlDefinitionsFactory` configuration

`org.apache.tiles.definition.DefinitionsReader`

Specifies the implementation of DefinitionsReader to use.

Specified in: org.apache.tiles.definition.DefinitionsFactory.
Default: org.apache.tiles.definition.digester.DigesterDefinitionsReader
Usage: when specified, it must contain the name of a class implementing DefinitionsReader.

`org.apache.tiles.locale.LocaleResolver`

Specifies the implementation of LocaleResolver to use.

Specified in: org.apache.tiles.definition.DefinitionsFactory.
Default: org.apache.tiles.locale.impl.DefaultLocaleResolver
Usage: when specified, it must contain the name of a class implementing LocaleResolver.

Initialization configuration

`org.apache.tiles.startup.BasicTilesInitializer.CONTAINER_KEY`

Specifies the key under which the Tiles container will be stored.

Specified in: org.apache.tiles.startup.BasicTilesInitializer.
Default: null (default container)
Usage: when specified, it must contain the key under which the container will be stored.

Extended configuration parameters

`KeyedDefinitionsFactoryTilesContainerFactory` configuration

`org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer.KeyExtractor`

Specifies the implementation of KeyExtractor to use.

Specified in: org.apache.tiles.factory.KeyedDefinitionsFactoryTilesContainerFactory.
Default: org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer.DefaultKeyExtractor
Usage: when specified, it must contain the name of a class implementing KeyExtractor.

`org.apache.tiles.factory.KeyedDefinitionsFactoryTilesContainerFactory.KEYS`

Specifies the list of keys to be used to assign a key to each Definitions Factory.

Specified in: org.apache.tiles.factory.KeyedDefinitionsFactoryTilesContainerFactory.
Default: None, it must be specified explicitly.
Usage: when specified, it must contain a comma-separated list of keys to be used to assign a key to each definitions factory.

`org.apache.tiles.DEFINITIONS_CONFIG@${key}`

Specifies the list of files that contain the definitions for the corresponding ${key}.

Specified in: org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer.
Default: /WEB-INF/tiles.xml.
Usage: when specified, it must contain a comma-separated list of paths of files that contain Tiles definitions to assign to the needed ${key}.

`org.apache.tiles.definition.DefinitionsReader`	Definitions reader class name
`org.apache.tiles.locale.LocaleResolver`	Locale resolver class name

Documentation

Reference

Developers

Modules