This project has retired. For details please refer to its Attic page.
Apache Tiles - Framework - Tiles Configuration reference

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.

Standard configuration parameters

Main configuration

org.apache.tiles.factory.TilesContainerFactory

Specifies the container factory class name to use.

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.context.TilesContextFactory

Specifies the context factory class name to use.

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

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.preparer.PreparerFactory

Specifies the view preparer factory class name to use.

BasicTilesContainer configuration

org.apache.tiles.impl.BasicTilesContainer.DEFINITIONS_CONFIG

Specifies the list of files that contain the definitions.

ChainedTilesContextFactory configuration

org.apache.tiles.context.ChainedTilesContextFactory.FACTORY_CLASS_NAMES

Specifies the list of elementary Tiles context factory class names.

  • Specified in: org.apache.tiles.context.ChainedTilesContextFactory.
  • Default: org.apache.tiles.servlet.context.ServletTilesContextFactory, org.apache.tiles.portlet.context.PortletTilesContextFactory, org.apache.tiles.jsp.context.JspTilesContextFactory
  • Usage: when specified, it must contain a comma-separated list of class names implementing TilesContextFactory.

DigesterDefinitionsReader configuration

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

Specifies if the digester should validate input XML files.

UrlDefinitionsFactory configuration

org.apache.tiles.definition.DefinitionsReader

Specifies the implementation of DefinitionsReader to use.

org.apache.tiles.locale.LocaleResolver

Specifies the implementation of LocaleResolver to use.

Extended configuration parameters

KeyedDefinitionsFactoryTilesContainerFactory configuration

org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer.KeyExtractor

Specifies the implementation of KeyExtractor to use.

org.apache.tiles.factory.KeyedDefinitionsFactoryTilesContainerFactory.KEYS

Specifies the 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}.