Class PersistFilter

  • All Implemented Interfaces:

    public final class PersistFilter
    extends Object
    implements jakarta.servlet.Filter
    Apply this filter to enable the HTTP Request unit of work and to have guice-persist manage the lifecycle of active units of work. The filter automatically starts and stops the relevant PersistService upon Filter.init(jakarta.servlet.FilterConfig) and Filter.destroy() respectively.

    To be able to use the open session-in-view pattern (i.e. work per request), register this filter once in your Guice ServletModule. It is important that you register this filter before any other filter.

    For multiple providers, you should register this filter once per provider, inside a private module for each persist module installed (this must be the same private module where the specific persist module is itself installed).

    Example configuration:

     public class MyModule extends ServletModule {
       public void configureServlets() {
         // Etc.

    This filter is thread safe and allows you to create injectors concurrently and deploy multiple guice-persist modules within the same injector, or even multiple injectors with persist modules withing the same JVM or web app.

    This filter requires the Guice Servlet extension.

    • Method Detail

      • init

        public void init​(jakarta.servlet.FilterConfig filterConfig)
                  throws jakarta.servlet.ServletException
        Specified by:
        init in interface jakarta.servlet.Filter
      • destroy

        public void destroy()
        Specified by:
        destroy in interface jakarta.servlet.Filter
      • doFilter

        public void doFilter​(jakarta.servlet.ServletRequest servletRequest,
                             jakarta.servlet.ServletResponse servletResponse,
                             jakarta.servlet.FilterChain filterChain)
                      throws IOException,
        Specified by:
        doFilter in interface jakarta.servlet.Filter