Package org.apache.myfaces.renderkit
Class ErrorPageWriter
java.lang.Object
org.apache.myfaces.renderkit.ErrorPageWriter
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 ClassesModifier and TypeClassDescriptionstatic class
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
FieldsModifier and TypeFieldDescriptionstatic final String
Extended debug info is stored under this key in the request map for every UIInput component when in Development mode.static final String
Indicate if myfaces is responsible to handle errors.static final String
The key which is used to store the ErrorPageBean in the view map of a facelet error page.static final String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic 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)
-
Field Details
-
ERROR_PAGE_BEAN_KEY
The key which is used to store the ErrorPageBean in the view map of a facelet error page.- See Also:
-
VIEW_KEY
- See Also:
-
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:
-
ERROR_HANDLING_PARAMETER
@JSFWebConfigParam(defaultValue="false, on Development Project stage: true", expectedValues="true,false", since="1.2.4") public static final String ERROR_HANDLING_PARAMETERIndicate if myfaces is responsible to handle errors. See https://cwiki.apache.org/confluence/display/MYFACES/Handling+Server+Errors for details.- See Also:
-
-
Constructor Details
-
ErrorPageWriter
public ErrorPageWriter()
-
-
Method Details
-
debugHtml
Generates the HTML error page for the given Throwable and writes it to the given writer.- Parameters:
writer
-faces
-e
-- Throws:
IOException
-
debugHtml
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
-