com.googlecode.objectify

Class ObjectifyFilter

java.lang.Object

com.googlecode.objectify.cache.AsyncCacheFilter

com.googlecode.objectify.ObjectifyFilter

All Implemented Interfaces:

javax.servlet.Filter

public class ObjectifyFilter
extends AsyncCacheFilter

Configure this filter to use Objectify in your application. It works in concert with ObjectifyService to provide the correct Objectify instance when ObjectifyService.ofy() is called. In your web.xml:

       <filter>
              <filter-name>ObjectifyFilter</filter-name>
              <filter-class>com.googlecode.objectify.ObjectifyFilter</filter-class>
      </filter>
      <filter-mapping>
              <filter-name>ObjectifyFilter</filter-name>
              <url-pattern>/*</url-pattern>
      </filter-mapping>

Or, if you use Guice:

      filter("/*").through(ObjectifyFilter.class);

If you use the Objectify outside of the context of a request (say, using the remote API or from a unit test), then you should call ObjectifyFilter.complete() after every operation that you consider a "request". For example, after each test.

Author:

Jeff Schnitzer

Constructor Summary

Constructors

Constructor and Description
ObjectifyFilter()

Method Summary

Methods

Modifier and Type	Method and Description
static void	complete() Perform the actions that are performed upon normal completion of a request.
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)

Methods inherited from class com.googlecode.objectify.cache.AsyncCacheFilter

destroy, init

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectifyFilter

public ObjectifyFilter()

Method Detail

doFilter

public void doFilter(javax.servlet.ServletRequest request,
            javax.servlet.ServletResponse response,
            javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Overrides:

doFilter in class AsyncCacheFilter

Throws:

IOException

javax.servlet.ServletException

complete

public static void complete()

Perform the actions that are performed upon normal completion of a request.