org.omnifaces.facesviews

Class FacesViewsForwardingFilter

java.lang.Object

org.omnifaces.filter.HttpFilter

org.omnifaces.facesviews.FacesViewsForwardingFilter

All Implemented Interfaces:

Filter

public class FacesViewsForwardingFilter
extends HttpFilter

This filter makes sure extensionless requests arrive at the FacesServlet using an extension on which that Servlet is mapped, and that non-extensionless requests are handled according to a set preference.

For dispatching to the FacesServlet, 2 methods are available:

• DO_FILTER (continues the filter chain but modifies request)
• FORWARD (starts a new filter chain by using a Servlet requestDispatcher.forward)

A filter like this is needed for extensionless requests, since the FacesServlet in at least JSF 2.1 and before does not take into account any other mapping than prefix- and extension (suffix) mapping.

For a guide on FacesViews, please see the package summary.

Author:

Arjan Tijms

Constructor Summary

Constructors

Constructor and Description
FacesViewsForwardingFilter()

Method Summary

Modifier and Type	Method and Description
void	doFilter(HttpServletRequest request, HttpServletResponse response, HttpSession session, FilterChain chain) Filter the HTTP request.
void	init(FilterConfig filterConfig) Called by the servlet container when the filter is about to be placed into service.

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

FacesViewsForwardingFilter

public FacesViewsForwardingFilter()

Method Detail

init

public void init(FilterConfig filterConfig)
          throws ServletException

Description copied from class: HttpFilter

Called by the servlet container when the filter is about to be placed into service. This implementation stores the FilterConfig object for later use by the getter methods. It's recommended to not override this method. Instead, just use HttpFilter.init() method. When overriding this method anyway, don't forget to call super.init(config), otherwise the getter methods will throw an illegal state exception.

Specified by:

init in interface Filter

Overrides:

init in class HttpFilter

Throws:

ServletException

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)