Package org.apache.myfaces.renderkit

Class ErrorPageWriter

java.lang.Object

org.apache.myfaces.renderkit.ErrorPageWriter

public final class ErrorPageWriter
extends Object

This class provides utility methods to generate the MyFaces error and debug pages.

Author:

Jacob Hookom (ICLA with ASF filed), Jakob Korherr (refactored and moved here from jakarta.faces.webapp._ErrorPageWriter)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ErrorPageWriter.ErrorPageBean	This bean aims to generate the error page html for inclusion on a facelet error page via <ui:include src="jakarta.faces.error.xhtml" />.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEBUG_INFO_KEY	Extended debug info is stored under this key in the request map for every UIInput component when in Development mode.
static String	ERROR_HANDLING_PARAMETER	Indicate if myfaces is responsible to handle errors.
static String	ERROR_PAGE_BEAN_KEY	The key which is used to store the ErrorPageBean in the view map of a facelet error page.
static String	VIEW_KEY

Constructor Summary

Constructors

Constructor	Description
ErrorPageWriter()

Method Summary

Modifier and Type	Method	Description
static void	debugHtml(Writer writer, FacesContext faces)	Generates the HTML debug page for the current view and writes it to the given writer.
static void	debugHtml(Writer writer, FacesContext faces, Throwable e)	Generates the HTML error page for the given Throwable and writes it to the given writer.
static void	handle(FacesContext facesContext, Collection<UIComponent> components, Throwable... exs)

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_PAGE_BEAN_KEY

public static final String ERROR_PAGE_BEAN_KEY

The key which is used to store the ErrorPageBean in the view map of a facelet error page.

See Also:

Constant Field Values

VIEW_KEY

public static final String VIEW_KEY

See Also:

Constant Field Values

DEBUG_INFO_KEY

public static final String DEBUG_INFO_KEY

Extended debug info is stored under this key in the request map for every UIInput component when in Development mode. ATTENTION: this constant is duplicate in jakarta.faces.component.UIInput

See Also:

Constant Field Values

ERROR_HANDLING_PARAMETER

@JSFWebConfigParam(defaultValue="false, on Development Project stage: true",
                   expectedValues="true,false",
                   since="1.2.4")
public static final String ERROR_HANDLING_PARAMETER

Indicate if myfaces is responsible to handle errors. See https://cwiki.apache.org/confluence/display/MYFACES/Handling+Server+Errors for details.

See Also:

Constant Field Values

Constructor Detail

ErrorPageWriter

public ErrorPageWriter()

Method Detail

debugHtml

public static void debugHtml(Writer writer,
                             FacesContext faces,
                             Throwable e)
                      throws IOException

Generates the HTML error page for the given Throwable and writes it to the given writer.

Parameters:

writer -

faces -

e -

Throws:

IOException

debugHtml

public static void debugHtml(Writer writer,
                             FacesContext faces)
                      throws IOException

Generates the HTML debug page for the current view and writes it to the given writer.

Parameters:

writer -

faces -

Throws:

IOException

handle

public static void handle(FacesContext facesContext,
                          Collection<UIComponent> components,
                          Throwable... exs)
                   throws FacesException

Throws:

FacesException