org.apache.catalina.valves

Class ErrorReportValve

java.lang.Object

org.apache.catalina.valves.ValveBase

org.apache.catalina.valves.ErrorReportValve

All Implemented Interfaces:

Contained, Lifecycle, Valve, GlassFishValve

public class ErrorReportValve
extends ValveBase

Implementation of a Valve that outputs HTML error pages.

This Valve should be attached at the Host level, although it will work if attached to a Context.

HTML code from the Cocoon 2 project.

Version:

$Revision: 1.19 $ $Date: 2007/05/05 05:32:41 $

Author:

Remy Maucherat, Craig R. McClanahan, Nicola Ken Barozzi Aisa, Stefano Mazzocchi

Field Summary

Fields

Modifier and Type	Field and Description
protected static StringManager	sm The StringManager for this package.

Fields inherited from class org.apache.catalina.valves.ValveBase

container, controller, domain, lifecycle, log, next, oname, rb, started

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, INIT_EVENT, START_EVENT, STOP_EVENT

Fields inherited from interface org.glassfish.web.valve.GlassFishValve

END_PIPELINE, INVOKE_NEXT

Constructor Summary

Constructors

Constructor and Description
ErrorReportValve()

Method Summary

Modifier and Type	Method and Description
String	getInfo() Return descriptive information about this Valve implementation.
int	invoke(Request request, Response response) Invoke the next Valve in the sequence.
protected void	log(String message) Log a message on the Logger associated with our Container (if any).
protected void	log(String message, Throwable t) Log a message on the Logger associated with our Container (if any).
static String	makeErrorPage(int statusCode, String message, Throwable throwable, Throwable rootCause, String report, javax.servlet.http.HttpServletResponse response)
void	postInvoke(Request request, Response response) A post-request processing implementation that does nothing.
protected void	report(Request request, Response response, Throwable throwable) Prints out an error report.
String	toString() Return a String rendering of this object.

Methods inherited from class org.apache.catalina.valves.ValveBase

addLifecycleListener, backgroundProcess, createObjectName, event, findLifecycleListeners, getContainer, getController, getDebug, getDomain, getNext, getObjectName, getParentName, invoke, isStarted, removeLifecycleListener, setContainer, setController, setDebug, setNext, setObjectName, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

sm

protected static final StringManager sm

The StringManager for this package.

Constructor Detail

ErrorReportValve

public ErrorReportValve()

Method Detail

getInfo

public String getInfo()

Return descriptive information about this Valve implementation.

Specified by:

getInfo in interface Valve

Specified by:

getInfo in interface GlassFishValve

Overrides:

getInfo in class ValveBase

invoke

public int invoke(Request request,
                  Response response)
           throws IOException,
                  javax.servlet.ServletException

Invoke the next Valve in the sequence. When the invoke returns, check the response state, and output an error report is necessary.

Specified by:

invoke in interface GlassFishValve

Specified by:

invoke in class ValveBase

Parameters:

request - The servlet request to be processed

response - The servlet response to be created

Returns:

INVOKE_NEXT or END_PIPELINE

Throws:

IOException - if an input/output error occurs

javax.servlet.ServletException - if a servlet error occurs

postInvoke

public void postInvoke(Request request,
                       Response response)
                throws IOException,
                       javax.servlet.ServletException

Description copied from class: ValveBase

A post-request processing implementation that does nothing. Very few Valves override this behaviour as most Valve logic is used for request processing.

Specified by:

postInvoke in interface GlassFishValve

Overrides:

postInvoke in class ValveBase

Parameters:

request - The servlet request to be processed

response - The servlet response to be created

Throws:

IOException - if an input/output error occurs

javax.servlet.ServletException - if a servlet error occurs

toString

public String toString()

Return a String rendering of this object.

Overrides:

toString in class Object

report

protected void report(Request request,
                      Response response,
                      Throwable throwable)
               throws IOException

Prints out an error report.

Parameters:

request - The request being processed

response - The response being generated

throwable - The exception that occurred (which possibly wraps a root cause exception

Throws:

IOException

log

protected void log(String message)

Log a message on the Logger associated with our Container (if any).

Parameters:

message - Message to be logged

log

protected void log(String message,
                   Throwable t)

Log a message on the Logger associated with our Container (if any).

Parameters:

message - Message to be logged

t - Associated exception

makeErrorPage

public static String makeErrorPage(int statusCode,
                                   String message,
                                   Throwable throwable,
                                   Throwable rootCause,
                                   String report,
                                   javax.servlet.http.HttpServletResponse response)