Package com.google.inject.servlet

Class GuiceFilter

java.lang.Object

com.google.inject.servlet.GuiceFilter

All Implemented Interfaces:

jakarta.servlet.Filter

public class GuiceFilter
extends Object
implements jakarta.servlet.Filter

Apply this filter in web.xml above all other filters (typically), to all requests where you plan to use servlet scopes. This is also needed in order to dispatch requests to injectable filters and servlets:

  <filter>
    <filter-name>guiceFilter</filter-name>
    <filter-class>com.google.inject.servlet.GuiceFilter</filter-class>
  </filter>

  <filter-mapping>
    <filter-name>guiceFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
  

This filter must appear before every filter that makes use of Guice injection or servlet scopes functionality. Typically, you will only register this filter in web.xml and register any other filters (and servlets) using a ServletModule.

Constructor Summary

Constructors

Constructor	Description
GuiceFilter()

Method Summary

Modifier and Type	Method	Description
void	destroy()
void	doFilter(jakarta.servlet.ServletRequest servletRequest, jakarta.servlet.ServletResponse servletResponse, jakarta.servlet.FilterChain filterChain)
void	init(jakarta.servlet.FilterConfig filterConfig)

Methods inherited from class java.lang.Object

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

Constructor Detail

GuiceFilter

public GuiceFilter()

Method Detail

doFilter

public void doFilter(jakarta.servlet.ServletRequest servletRequest,
                     jakarta.servlet.ServletResponse servletResponse,
                     jakarta.servlet.FilterChain filterChain)
              throws IOException,
                     jakarta.servlet.ServletException

Specified by:

doFilter in interface jakarta.servlet.Filter

Throws:

IOException

jakarta.servlet.ServletException

init

public void init(jakarta.servlet.FilterConfig filterConfig)
          throws jakarta.servlet.ServletException

Specified by:

init in interface jakarta.servlet.Filter

Throws:

jakarta.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface jakarta.servlet.Filter