Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

info.crossbar.filtersAndListeners
Class PersistenceFilter  view PersistenceFilter download PersistenceFilter.java

java.lang.Object
  extended byinfo.crossbar.filtersAndListeners.PersistenceFilter
All Implemented Interfaces:
javax.servlet.Filter

public class PersistenceFilter
extends java.lang.Object
implements javax.servlet.Filter

PersistenceFilter class for use by Crossbar.

Version:
View source, revision history $Revision: 1.3 $ $Date: 2003/06/04 04:55:33 $

DESCRIPTION: Filter which manages a ThreadLocal hibernate session. Obtain the session by calling PersistenceFilter.getSession(). Based on an example by Jeff Schnitzer.


Field Summary
protected static SessionFactory factory
           
protected static java.lang.ThreadLocal hibernateHolder
          Holds the current hibernate session, if one has been created.
private static java.util.logging.Logger log
          Set up logging.
 
Constructor Summary
PersistenceFilter()
           
 
Method Summary
 void destroy()
          Called by the web container to indicate to a filter that it is being taken out of service.
 void doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
          The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain.
static Session getSession()
          ONLY ever call this method from within the context of a servlet request (specifically, one that has been associated with this filter).
static SessionFactory getSessionFactory()
           
 void init(javax.servlet.FilterConfig filterConfig)
          Called by the web container to indicate to a filter that it is being placed into service.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

private static java.util.logging.Logger log
Set up logging.


hibernateHolder

protected static java.lang.ThreadLocal hibernateHolder
Holds the current hibernate session, if one has been created.


factory

protected static SessionFactory factory
Constructor Detail

PersistenceFilter

public PersistenceFilter()
Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException
Description copied from interface: javax.servlet.Filter
Called by the web container to indicate to a filter that it is being placed into service. The servlet container calls the init method exactly once after instantiating the filter. The init method must complete successfully before the filter is asked to do any filtering work.

The web container cannot place the filter into service if the init method either
1.Throws a ServletException
2.Does not return within a time period defined by the web container

Specified by:
init in interface javax.servlet.Filter

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws java.io.IOException,
                     javax.servlet.ServletException
Description copied from interface: javax.servlet.Filter
The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain. The FilterChain passed in to this method allows the Filter to pass on the request and response to the next entity in the chain.

A typical implementation of this method would follow the following pattern:-
1. Examine the request
2. Optionally wrap the request object with a custom implementation to filter content or headers for input filtering
3. Optionally wrap the response object with a custom implementation to filter content or headers for output filtering
4. a) Either invoke the next entity in the chain using the FilterChain object (chain.doFilter()),
4. b) or not pass on the request/response pair to the next entity in the filter chain to block the request processing
5. Directly set headers on the response after invocation of the next entity in the filter chain.

Specified by:
doFilter in interface javax.servlet.Filter

getSession

public static Session getSession()
                          throws HibernateException
ONLY ever call this method from within the context of a servlet request (specifically, one that has been associated with this filter). If you want a Hibernate session at some other time, call getSessionFactory() and open/close the session yourself.


getSessionFactory

public static SessionFactory getSessionFactory()

destroy

public void destroy()
Description copied from interface: javax.servlet.Filter
Called by the web container to indicate to a filter that it is being taken out of service. This method is only called once all threads within the filter's doFilter method have exited or after a timeout period has passed. After the web container calls this method, it will not call the doFilter method again on this instance of the filter.

This method gives the filter an opportunity to clean up any resources that are being held (for example, memory, file handles, threads) and make sure that any persistent state is synchronized with the filter's current state in memory.

Specified by:
destroy in interface javax.servlet.Filter