Package org.apache.tiles.servlet.context

Class ServletUtil

  • public final class ServletUtil
extends Object
    Utilities for Tiles servlet support.
    Since:
    2.0.6
    Version:
    $Rev$ $Date$

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static org.apache.tiles.ArrayStack<Object> getComposeStack​(javax.servlet.http.HttpServletRequest request)
      Returns the compose stack, that is used by the tags to compose definitions, attributes, etc.
      static org.apache.tiles.TilesContainer getContainer​(javax.servlet.ServletContext context)
      Returns the default Tiles container.
      static org.apache.tiles.TilesContainer getContainer​(javax.servlet.ServletContext context, String key)
      Returns a specific Tiles container.
      static org.apache.tiles.TilesContainer getCurrentContainer​(javax.servlet.ServletRequest request, javax.servlet.ServletContext context)
      Returns the current container that has been set, or the default one.
      static javax.servlet.ServletContext getServletContext​(org.apache.tiles.TilesApplicationContext applicationContext)
      Gets a servlet context from a TilesApplicationContext.
      static ServletTilesRequestContext getServletRequest​(org.apache.tiles.context.TilesRequestContext request)
      Opens a TilesRequestContext until it finds a ServletTilesRequestContext.
      static boolean isForceInclude​(javax.servlet.http.HttpServletRequest request)
      Returns true if forced include of the result is needed.
      static void setContainer​(javax.servlet.ServletContext context, org.apache.tiles.TilesContainer container)
      Configures the default container to be used in the application.
      static void setContainer​(javax.servlet.ServletContext context, org.apache.tiles.TilesContainer container, String key)
      Configures the container to be used in the application.
      static void setCurrentContainer​(javax.servlet.ServletRequest request, javax.servlet.ServletContext context, String key)
      Sets the current container to use in web pages.
      static void setCurrentContainer​(javax.servlet.ServletRequest request, javax.servlet.ServletContext context, org.apache.tiles.TilesContainer container)
      Sets the current container to use in web pages.
      static void setForceInclude​(javax.servlet.http.HttpServletRequest request, boolean forceInclude)
      Sets the option that enables the forced include of the response.
      static IOException wrapServletException​(javax.servlet.ServletException ex, String message)
      Wraps a ServletException to create an IOException with the root cause if present.

    • Field Detail

      • COMPOSE_STACK_ATTRIBUTE_NAME

        public static final String COMPOSE_STACK_ATTRIBUTE_NAME
        The name of the attribute that will contain the compose stack.
        See Also:
        Constant Field Values

      • FORCE_INCLUDE_ATTRIBUTE_NAME

        public static final String FORCE_INCLUDE_ATTRIBUTE_NAME
        Name of the attribute used to store the force-include option.
        Since:
        2.0.6
        See Also:
        Constant Field Values

      • CURRENT_CONTAINER_ATTRIBUTE_NAME

        public static final String CURRENT_CONTAINER_ATTRIBUTE_NAME
        Name of the attribute used to store the current used container.
        See Also:
        Constant Field Values

    • Method Detail

      • isForceInclude

        public static boolean isForceInclude​(javax.servlet.http.HttpServletRequest request)
        Returns true if forced include of the result is needed.
        Parameters:
        request - The HTTP request.
        Returns:
        If true the include operation must be forced.
        Since:
        2.0.6

      • setForceInclude

        public static void setForceInclude​(javax.servlet.http.HttpServletRequest request,
                                   boolean forceInclude)
        Sets the option that enables the forced include of the response.
        Parameters:
        request - The HTTP request.
        forceInclude - If true the include operation must be forced.
        Since:
        2.0.6

      • getContainer

        public static org.apache.tiles.TilesContainer getContainer​(javax.servlet.ServletContext context)
        Returns the default Tiles container.
        Parameters:
        context - The servlet context to use.
        Returns:
        The default Tiles container.
        Since:
        2.1.2

      • getContainer

        public static org.apache.tiles.TilesContainer getContainer​(javax.servlet.ServletContext context,
                                                           String key)
        Returns a specific Tiles container.
        Parameters:
        context - The servlet context to use.
        key - The key under which the container is stored. If null, the default container will be returned.
        Returns:
        The requested Tiles container.
        Since:
        2.1.2

      • setContainer

        public static void setContainer​(javax.servlet.ServletContext context,
                                org.apache.tiles.TilesContainer container)
        Configures the default container to be used in the application.
        Parameters:
        context - The servlet context object to use.
        container - The container object to set.
        Since:
        2.1.2

      • setContainer

        public static void setContainer​(javax.servlet.ServletContext context,
                                org.apache.tiles.TilesContainer container,
                                String key)
        Configures the container to be used in the application.
        Parameters:
        context - The servlet context object to use.
        container - The container object to set.
        key - The key under which the container will be stored.
        Since:
        2.1.2

      • setCurrentContainer

        public static void setCurrentContainer​(javax.servlet.ServletRequest request,
                                       javax.servlet.ServletContext context,
                                       String key)
        Sets the current container to use in web pages.
        Parameters:
        request - The request to use.
        context - The servlet context to use.
        key - The key under which the container is stored.
        Since:
        2.1.0

      • setCurrentContainer

        public static void setCurrentContainer​(javax.servlet.ServletRequest request,
                                       javax.servlet.ServletContext context,
                                       org.apache.tiles.TilesContainer container)
        Sets the current container to use in web pages.
        Parameters:
        request - The request to use.
        context - The servlet context to use.
        container - The container to use as the current container.
        Since:
        2.1.0

      • getCurrentContainer

        public static org.apache.tiles.TilesContainer getCurrentContainer​(javax.servlet.ServletRequest request,
                                                                  javax.servlet.ServletContext context)
        Returns the current container that has been set, or the default one.
        Parameters:
        request - The request to use.
        context - The servlet context to use.
        Returns:
        The current Tiles container to use in web pages.
        Since:
        2.1.0

      • wrapServletException

        public static IOException wrapServletException​(javax.servlet.ServletException ex,
                                               String message)
        Wraps a ServletException to create an IOException with the root cause if present.
        Parameters:
        ex - The exception to wrap.
        message - The message of the exception.
        Returns:
        The wrapped exception.
        Since:
        2.1.1

      • getComposeStack

        public static org.apache.tiles.ArrayStack<Object> getComposeStack​(javax.servlet.http.HttpServletRequest request)
        Returns the compose stack, that is used by the tags to compose definitions, attributes, etc.
        Parameters:
        request - The HTTP request.
        Returns:
        The compose stack.
        Since:
        2.2.0

      • getServletRequest

        public static ServletTilesRequestContext getServletRequest​(org.apache.tiles.context.TilesRequestContext request)
        Opens a TilesRequestContext until it finds a ServletTilesRequestContext.
        Parameters:
        request - The request to open.
        Returns:
        The servlet-based request context.
        Throws:
        NotAServletEnvironmentException - If a servlet-based request context could not be found.
        Since:
        2.2.0

      • getServletContext

        public static javax.servlet.ServletContext getServletContext​(org.apache.tiles.TilesApplicationContext applicationContext)
        Gets a servlet context from a TilesApplicationContext.
        Parameters:
        applicationContext - The application context to analyze.
        Returns:
        The servlet context.
        Throws:
        NotAServletEnvironmentException - If the application context is not servlet-based.
        Since:
        2.2.0