public final class

PersistFilter

extends Object
java.lang.Object
   ↳ com.google.inject.persist.PersistFilter

Class Overview

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 javax.servlet.Filter#init(javax.servlet.FilterConfig) and javax.servlet.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() {
      filter("/*").through(PersistFilter.class);

      serve("/index.html").with(MyHtmlServlet.class);
      // 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.

Summary

Public Constructors
PersistFilter(UnitOfWork unitOfWork, PersistService persistService)
Public Methods
void destroy()
void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
void init(FilterConfig filterConfig)
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PersistFilter (UnitOfWork unitOfWork, PersistService persistService)

Public Methods

public void destroy ()

public void doFilter (ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)

Throws
IOException
ServletException

public void init (FilterConfig filterConfig)

Throws
ServletException