Class AbstractTilesInitializer

java.lang.Object
org.apache.tiles.startup.AbstractTilesInitializer
All Implemented Interfaces:
TilesInitializer
Direct Known Subclasses:
CompleteAutoloadTilesInitializer, DefaultTilesInitializer

public abstract class AbstractTilesInitializer extends Object implements TilesInitializer
Default Tiles initialization delegate implementation under a servlet environment. It uses init parameters to create the ApplicationContext and the TilesContainer.
Since:
2.2.0
Version:
$Rev: 1332134 $ $Date: 2012-04-30 19:23:19 +1000 (Mon, 30 Apr 2012) $
  • Field Details

    • CONTAINER_KEY_INIT_PARAMETER

      public static final String CONTAINER_KEY_INIT_PARAMETER
      Init parameter to define the key under which the container will be stored.
      Since:
      2.1.2
      See Also:
  • Constructor Details

    • AbstractTilesInitializer

      public AbstractTilesInitializer()
  • Method Details

    • initialize

      public void initialize(org.apache.tiles.request.ApplicationContext applicationContext)
      Initializes Tiles.
      Specified by:
      initialize in interface TilesInitializer
      Parameters:
      applicationContext - The preliminary application context to use. It will be overwritten with the real instance later. Use a context usable under your current environment, like ServletTilesApplicationContext or PortletTilesApplicationContext.
    • destroy

      public void destroy()
      Destroys the Tiles container.
      Specified by:
      destroy in interface TilesInitializer
    • createTilesApplicationContext

      protected org.apache.tiles.request.ApplicationContext createTilesApplicationContext(org.apache.tiles.request.ApplicationContext preliminaryContext)
      Creates the Tiles application context, to be used across all the Tiles-based application. If you override this class, please override this method or
      invalid reference
      #createAndInitializeTilesApplicationContextFactory(ApplicationContext)
      .
      This implementation returns the preliminary context passed as a parameter
      Parameters:
      preliminaryContext - The preliminary application context to use.
      Returns:
      The Tiles application context.
      Since:
      2.2.0
    • getContainerKey

      protected String getContainerKey(org.apache.tiles.request.ApplicationContext applicationContext)
      Returns the container key under which the container will be stored. This implementation returns null so that the container will be the default one.
      Parameters:
      applicationContext - The Tiles application context to use.
      Returns:
      The container key.
      Since:
      2.2.0
    • createContainer

      protected TilesContainer createContainer(org.apache.tiles.request.ApplicationContext context)
      Creates a Tiles container. If you override this class, please override this method or createContainerFactory(ApplicationContext).
      Parameters:
      context - The servlet context to use.
      Returns:
      The created container.
      Since:
      2.2.0
    • createContainerFactory

      protected abstract AbstractTilesContainerFactory createContainerFactory(org.apache.tiles.request.ApplicationContext context)
      Creates a Tiles container factory. If you override this class, please override this method or createContainer(ApplicationContext).
      Parameters:
      context - The servlet context to use.
      Returns:
      The created container factory.
      Since:
      2.2.0