org.apache.tiles.servlet.context
Class ServletUtil

Package class diagram package ServletUtil
java.lang.Object
  extended by org.apache.tiles.servlet.context.ServletUtil

public final class ServletUtil
extends java.lang.Object

Utilities for Tiles servlet support.

Since:
2.0.6

Field Summary
static java.lang.String CURRENT_CONTAINER_ATTRIBUTE_NAME
          Name of the attribute used to store the current used container.
static java.lang.String FORCE_INCLUDE_ATTRIBUTE_NAME
          Name of the attribute used to store the force-include option.
 
Method Summary
static TilesContainer getCurrentContainer(javax.servlet.ServletRequest request, javax.servlet.ServletContext context)
          Returns the current container that has been set, or the default one.
static boolean isForceInclude(javax.servlet.http.HttpServletRequest request)
          Returns true if forced include of the result is needed.
static void setCurrentContainer(javax.servlet.ServletRequest request, javax.servlet.ServletContext context, java.lang.String key)
          Sets the current container to use in web pages.
static void setCurrentContainer(javax.servlet.ServletRequest request, javax.servlet.ServletContext context, 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 java.io.IOException wrapServletException(javax.servlet.ServletException ex, java.lang.String message)
          Wraps a ServletException to create an IOException with the root cause if present.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FORCE_INCLUDE_ATTRIBUTE_NAME

public static final java.lang.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 java.lang.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

setCurrentContainer

public static void setCurrentContainer(javax.servlet.ServletRequest request,
                                       javax.servlet.ServletContext context,
                                       java.lang.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,
                                       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 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 java.io.IOException wrapServletException(javax.servlet.ServletException ex,
                                                       java.lang.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