org.omnifaces.filter

Class FacesExceptionFilter

java.lang.Object

org.omnifaces.filter.HttpFilter

org.omnifaces.filter.FacesExceptionFilter

All Implemented Interfaces:

Filter

public class FacesExceptionFilter
extends HttpFilter

The FacesExceptionFilter will solve 2 problems with exceptions thrown in JSF methods.

1. Mojarra's FacesFileNotFoundException needs to be interpreted as 404.
2. Root cause needs to be unwrapped from FacesException and ELException to utilize standard Servlet API error page handling.

Noted should be that this filter won't run on exceptions thrown during ajax requests. To handle them using web.xml configured error pages, use FullAjaxExceptionHandler.

Installation

To get it to run, map this filter on the <servlet-name> of the FacesServlet in the same web.xml.

 <filter>
     <filter-name>facesExceptionFilter</filter-name>
     <filter-class>org.omnifaces.filter.FacesExceptionFilter</filter-class>
 </filter>
 <filter-mapping>
     <filter-name>facesExceptionFilter</filter-name>
     <servlet-name>facesServlet</servlet-name>
 </filter-mapping>
 

Configuration

By default only FacesException and ELException are unwrapped. You can supply a context parameter "org.omnifaces.EXCEPTION_TYPES_TO_UNWRAP" to specify additional exception types to unwrap. The context parameter value must be a commaseparated string of fully qualified names of additional exception types.

 <context-param>
     <param-name>org.omnifaces.EXCEPTION_TYPES_TO_UNWRAP</param-name>
     <param-value>javax.ejb.EJBException,javax.persistence.RollbackException</param-value>
 </context-param>
 

This context parameter will also be read and used by FullAjaxExceptionHandler.

Author:

Bauke Scholtz

See Also:

FullAjaxExceptionHandler, HttpFilter

Constructor Summary

Constructors

Constructor and Description
FacesExceptionFilter()

Method Summary

Modifier and Type	Method and Description
void	doFilter(HttpServletRequest request, HttpServletResponse response, HttpSession session, FilterChain chain) Filter the HTTP request.
void	init() Convenience init() method without FilterConfig parameter which will be called by init(FilterConfig).

Methods inherited from class org.omnifaces.filter.HttpFilter

destroy, doFilter, getFilterConfig, getInitParameter, getServletContext, init

Methods inherited from class java.lang.Object

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

Constructor Detail

FacesExceptionFilter

public FacesExceptionFilter()

Method Detail

init

public void init()
          throws ServletException

Description copied from class: HttpFilter

Convenience init() method without FilterConfig parameter which will be called by init(FilterConfig).

Overrides:

init in class HttpFilter

Throws:

ServletException - When filter's initialization failed.

doFilter

public void doFilter(HttpServletRequest request,
                     HttpServletResponse response,
                     HttpSession session,
                     FilterChain chain)
              throws ServletException,
                     IOException

Description copied from class: HttpFilter

Filter the HTTP request. The session argument is null if there is no session.

Specified by:

doFilter in class HttpFilter

Parameters:

request - The HTTP request.

response - The HTTP response.

session - The HTTP session, if any, else null.

chain - The filter chain to continue.

Throws:

ServletException - As wrapper exception when something fails in the request processing.

IOException - Whenever something fails at I/O level.

See Also:

Filter.doFilter(ServletRequest, ServletResponse, FilterChain)