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

  1. 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
  2. CachingLocaleUrlDefinitionDAO configuration.
    org.apache.tiles.definition.dao.LocaleUrlDefinitionDAO.CHECK_REFRESH Flag to enable automatic refresh check
  3. ChainedTilesApplicationContextFactory configuration.
    org.apache.tiles.context.ChainedTilesApplicationContextFactory.FACTORY_CLASS_NAMES List of elementary application factory class names
  4. ChainedTilesRequestContextFactory configuration.
    org.apache.tiles.context.ChainedTilesRequestContextFactory.FACTORY_CLASS_NAMES List of elementary request factory class names
  5. DigesterDefinitionsReader configuration.
    org.apache.tiles.definition.digester.DigesterDefinitionsReader.PARSER_VALIDATE Flag to deactivate XML parser validation
  6. UrlDefinitionsFactory configuration.
    org.apache.tiles.definition.DefinitionsReader Definitions reader class name
    org.apache.tiles.locale.LocaleResolver Locale resolver class name
  7. Initialization configuration.
    org.apache.tiles.startup.BasicTilesInitializer.CONTAINER_KEY Container key

Deprecated configuration

The following configuration parameters are deprecated:

Standard configuration parameters

Main configuration

org.apache.tiles.context.AbstractTilesApplicationContextFactory

Specifies the application context factory class name to use.

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.

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.

org.apache.tiles.renderer.RendererFactory

Specify the class 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.

CachingLocaleUrlDefinitionDAO configuration

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

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

ChainedTilesApplicationContextFactory configuration

org.apache.tiles.context.ChainedTilesApplicationContextFactory.FACTORY_CLASS_NAMES

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

ChainedTilesRequestContextFactory configuration

org.apache.tiles.context.ChainedTilesRequestContextFactory.FACTORY_CLASS_NAMES

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

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.

Initialization configuration

org.apache.tiles.startup.BasicTilesInitializer.CONTAINER_KEY

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

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