Module com.aoapps.servlet.util

Package com.aoapps.servlet.http

Class Includer

java.lang.Object

com.aoapps.servlet.http.Includer

public final class Includer
extends Object

Performs an include while allowing SkipPageException and sendError to escape the include. This is required to support redirecting from within an included page.

Author:

AO Industries, Inc.

Method Summary

Modifier and Type	Method	Description
static void	dispatchInclude(RequestDispatcher dispatcher, HttpServletRequest request, HttpServletResponse response)	Performs the actual include, supporting propagation of SkipPageException and sendError.
static void	sendError(HttpServletRequest request, HttpServletResponse response, int status)	Sends an error.
static void	sendError(HttpServletRequest request, HttpServletResponse response, int status, String message)	Sends an error.
static void	setLocation(HttpServletRequest request, HttpServletResponse response, String location)	Sets a Location header.
static void	setPageSkipped(ServletRequest request)	Sets the skip page flag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

dispatchInclude

public static void dispatchInclude(RequestDispatcher dispatcher,
 HttpServletRequest request,
 HttpServletResponse response)
                            throws ServletException,
IOException,
SkipPageException

Performs the actual include, supporting propagation of SkipPageException and sendError.

When response is committed will not call HttpServletResponse.sendError(int, java.lang.String).

Throws:

ServletException

IOException

SkipPageException

setLocation

public static void setLocation(HttpServletRequest request,
 HttpServletResponse response,
 String location)

Sets a Location header. When not in an included page, calls setHeader directly. When inside of an include will set request attribute so outermost include can call setHeader. Encodes the location to US-ASCII format.

sendError

public static void sendError(HttpServletRequest request,
 HttpServletResponse response,
 int status,
 String message)
                      throws IOException

Sends an error. When not in an included page, calls sendError directly. When inside of an include will set request attribute so outermost include can call sendError.

When response is committed will not call HttpServletResponse.sendError(int, java.lang.String).

Throws:

IOException

sendError

public static void sendError(HttpServletRequest request,
 HttpServletResponse response,
 int status)
                      throws IOException

Sends an error. When not in an included page, calls sendError directly. When inside of an include will set request attribute so outermost include can call sendError.

When response is committed will not call HttpServletResponse.sendError(int).

Throws:

IOException

setPageSkipped

public static void setPageSkipped(ServletRequest request)

Sets the skip page flag.