docs/2.0/api/cayenne/org/apache/cayenne/conf/WebApplicationContextFilter.html - cayenne-website - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!--NewPage-->
 <HTML>
 <HEAD>
 <!-- Generated by javadoc (build 1.5.0_06) on Wed Jul 19 14:45:45 EDT 2006 -->
 <TITLE>
 WebApplicationContextFilter (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT)
 </TITLE>

 <META NAME="keywords" CONTENT="org.apache.cayenne.conf.WebApplicationContextFilter class">

 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../apache-javadoc.css" TITLE="Style">

 <SCRIPT type="text/javascript">
 function windowTitle()
 {
     parent.document.title="WebApplicationContextFilter (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT)";
 }
 </SCRIPT>
 <NOSCRIPT>
 </NOSCRIPT>

 </HEAD>

 <BODY BGCOLOR="white" onload="windowTitle();">


 <!-- ========= START OF TOP NAVBAR ======= -->
 <A NAME="navbar_top"><!-- --></A>
 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 <TR>
 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 <A NAME="navbar_top_firstrow"><!-- --></A>
 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
   <TR ALIGN="center" VALIGN="top">
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
   </TR>
 </TABLE>
 </TD>
 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 </EM>
 </TD>
 </TR>

 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 &nbsp;<A HREF="../../../../org/apache/cayenne/conf/ServletUtil.html" title="class in org.apache.cayenne.conf"><B>PREV CLASS</B></A>&nbsp;
 &nbsp;<A HREF="../../../../org/apache/cayenne/conf/WebApplicationContextProvider.html" title="class in org.apache.cayenne.conf"><B>NEXT CLASS</B></A></FONT></TD>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
   <A HREF="../../../../index.html?org/apache/cayenne/conf/WebApplicationContextFilter.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 &nbsp;<A HREF="WebApplicationContextFilter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 &nbsp;<SCRIPT type="text/javascript">
   <!--
   if(window==top) {
     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
   }
   //-->
 </SCRIPT>
 <NOSCRIPT>
   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
 </NOSCRIPT>


 </FONT></TD>
 </TR>
 <TR>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 </TR>
 </TABLE>
 <A NAME="skip-navbar_top"></A>
 <!-- ========= END OF TOP NAVBAR ========= -->

 <HR>
 <!-- ======== START OF CLASS DATA ======== -->
 <H2>
 <FONT SIZE="-1">
 org.apache.cayenne.conf</FONT>
 <BR>
 Class WebApplicationContextFilter</H2>
 <PRE>
 java.lang.Object
   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.cayenne.conf.WebApplicationContextFilter</B>
 </PRE>
 <DL>
 <DT><B>All Implemented Interfaces:</B> <DD>javax.servlet.Filter</DD>
 </DL>
 <HR>
 <DL>
 <DT><PRE>public class <B>WebApplicationContextFilter</B><DT>extends java.lang.Object<DT>implements javax.servlet.Filter</DL>
 </PRE>

 <P>
 <p>
  <code>WebApplicationContextFilter</code> is another helper class to help integrate
  Cayenne with web applications. The implementation is similar to
  <code>org.apache.cayenne.conf.WebApplicationContextProvider</code> however it
  allows for integration with containers that support version 2.3 of the servlet
  specification for example Tomcat 4.x. via the usage of filers.
  </p>
  <p>
  Whenever this filter is processed it attempts bind a <code>DataContext</code> to the
  thread. It retrieves the <code>DataContext</code> via the
  <code>BasicServletConfiguration.getDefaultDataContext()</code> and binds it to the
  thread using <code>DataContext.bindThreadDataContext()</code> method. If the session
  has not been created this filter will also create a new session.
  </p>
  <p>
  During initialization (init() method) this filter initializes the
  <code>BasicServletConfiguration</code> with the servlet context via the
  initializeConfiguration() method
  </p>
  <p>
  This filter can be installed in the web container as a &quot;filter&quot; as follows:

  <pre>
           &lt;filter&gt;
               &lt;filter-name&gt;WebApplicationContextFilter&lt;/filter-name&gt;
               &lt;filter-class&gt;org.apache.cayenne.conf.WebApplicationContextFilter&lt;/filter-class&gt;
          &lt;/filter&gt;
  </pre>

  Then the mapping needs to be created to direct all or some requests to be processed by
  the filter as follows:

  <pre>
          &lt;filter-mapping&gt;
               &lt;filter-name&gt;WebApplicationContextFilter&lt;/filter-name&gt;
               &lt;url-pattern&gt;/*&lt;/url-pattern&gt;
           &lt;/filter-mapping&gt;
  </pre>

  The above example the filter would be applied to all the servlets and static content
  pages in the Web application, because every request URI matches the '/*' URL pattern.
  The problem with this mapping however is the fact that this filter will run for every
  request made, whether for images and/or static content and dynamic content request.
  This maybe detrimental to performance. Hence the mapping url patter should be set
  accordingly.
  </p>
 <P>

 <P>
 <DL>
 <DT><B>Author:</B></DT>
   <DD>Gary Jarrel</DD>
 </DL>
 <HR>

 <P>

 <!-- ======== CONSTRUCTOR SUMMARY ======== -->

 <A NAME="constructor_summary"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 <B>Constructor Summary</B></FONT></TH>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/WebApplicationContextFilter.html#WebApplicationContextFilter()">WebApplicationContextFilter</A></B>()</CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 </TR>
 </TABLE>
 &nbsp;
 <!-- ========== METHOD SUMMARY =========== -->

 <A NAME="method_summary"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 <B>Method Summary</B></FONT></TH>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;void</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/WebApplicationContextFilter.html#destroy()">destroy</A></B>()</CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Does nothing.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;void</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/WebApplicationContextFilter.html#doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)">doFilter</A></B>(javax.servlet.ServletRequest&nbsp;request,
          javax.servlet.ServletResponse&nbsp;response,
          javax.servlet.FilterChain&nbsp;chain)</CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the <code>DataContext</code> bound to the <code>HttpSession</code>
  via <code>BasicServletConfiguration.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;void</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/WebApplicationContextFilter.html#init(javax.servlet.FilterConfig)">init</A></B>(javax.servlet.FilterConfig&nbsp;config)</CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initializes the <code>BasicServletConfiguration</code> via the
  initializeConfiguration() method.</TD>
 </TR>
 </TABLE>
 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
 </TR>
 </TABLE>
 &nbsp;
 <P>

 <!-- ========= CONSTRUCTOR DETAIL ======== -->

 <A NAME="constructor_detail"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 <B>Constructor Detail</B></FONT></TH>
 </TR>
 </TABLE>

 <A NAME="WebApplicationContextFilter()"><!-- --></A><H3>
 WebApplicationContextFilter</H3>
 <PRE>
 public <B>WebApplicationContextFilter</B>()</PRE>
 <DL>
 </DL>

 <!-- ============ METHOD DETAIL ========== -->

 <A NAME="method_detail"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 <B>Method Detail</B></FONT></TH>
 </TR>
 </TABLE>

 <A NAME="destroy()"><!-- --></A><H3>
 destroy</H3>
 <PRE>
 public void <B>destroy</B>()</PRE>
 <DL>
 <DD>Does nothing. As per the servlet specification, gets called by the container when
  the filter is taken out of service.
 <P>
 <DD><DL>
 <DT><B>Specified by:</B><DD><CODE>destroy</CODE> in interface <CODE>javax.servlet.Filter</CODE></DL>
 </DD>
 <DD><DL>
 </DL>
 </DD>
 </DL>
 <HR>

 <A NAME="init(javax.servlet.FilterConfig)"><!-- --></A><H3>
 init</H3>
 <PRE>
 public void <B>init</B>(javax.servlet.FilterConfig&nbsp;config)
           throws javax.servlet.ServletException</PRE>
 <DL>
 <DD>Initializes the <code>BasicServletConfiguration</code> via the
  initializeConfiguration() method. Also saves the FilterConfing to a private local
  variable for possible later access. This method is part of the <code>Filter</code>
  interface and is called by the container when the filter is placed into service.
 <P>
 <DD><DL>
 <DT><B>Specified by:</B><DD><CODE>init</CODE> in interface <CODE>javax.servlet.Filter</CODE></DL>
 </DD>
 <DD><DL>

 <DT><B>Throws:</B>
 <DD><CODE>javax.servlet.ServletException</CODE></DL>
 </DD>
 </DL>
 <HR>

 <A NAME="doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)"><!-- --></A><H3>
 doFilter</H3>
 <PRE>
 public void <B>doFilter</B>(javax.servlet.ServletRequest&nbsp;request,
                      javax.servlet.ServletResponse&nbsp;response,
                      javax.servlet.FilterChain&nbsp;chain)
               throws java.io.IOException,
                      javax.servlet.ServletException</PRE>
 <DL>
 <DD>Retrieves the <code>DataContext</code> bound to the <code>HttpSession</code>
  via <code>BasicServletConfiguration.

  getDefaultContext()</code>, and binds it to
  the current thread.
 <P>
 <DD><DL>
 <DT><B>Specified by:</B><DD><CODE>doFilter</CODE> in interface <CODE>javax.servlet.Filter</CODE></DL>
 </DD>
 <DD><DL>

 <DT><B>Throws:</B>
 <DD><CODE>java.io.IOException</CODE>
 <DD><CODE>javax.servlet.ServletException</CODE></DL>
 </DD>
 </DL>
 <!-- ========= END OF CLASS DATA ========= -->
 <HR>


 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <A NAME="navbar_bottom"><!-- --></A>
 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 <TR>
 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
   <TR ALIGN="center" VALIGN="top">
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
   </TR>
 </TABLE>
 </TD>
 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 </EM>
 </TD>
 </TR>

 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 &nbsp;<A HREF="../../../../org/apache/cayenne/conf/ServletUtil.html" title="class in org.apache.cayenne.conf"><B>PREV CLASS</B></A>&nbsp;
 &nbsp;<A HREF="../../../../org/apache/cayenne/conf/WebApplicationContextProvider.html" title="class in org.apache.cayenne.conf"><B>NEXT CLASS</B></A></FONT></TD>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
   <A HREF="../../../../index.html?org/apache/cayenne/conf/WebApplicationContextFilter.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 &nbsp;<A HREF="WebApplicationContextFilter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 &nbsp;<SCRIPT type="text/javascript">
   <!--
   if(window==top) {
     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
   }
   //-->
 </SCRIPT>
 <NOSCRIPT>
   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
 </NOSCRIPT>


 </FONT></TD>
 </TR>
 <TR>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 </TR>
 </TABLE>
 <A NAME="skip-navbar_bottom"></A>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->

 <HR>

 					<i>Copyright &#169; 2001-2006 <a href=
 					"http://apache.org" target="_top">Apache.org</a> All Rights Reserved.</i>

 </BODY>
 </HTML>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<!--NewPage-->
	<HTML>
	<HEAD>
	<!-- Generated by javadoc (build 1.5.0_06) on Wed Jul 19 14:45:45 EDT 2006 -->
	<TITLE>
	WebApplicationContextFilter (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT)
	</TITLE>

	<META NAME="keywords" CONTENT="org.apache.cayenne.conf.WebApplicationContextFilter class">

	<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../apache-javadoc.css" TITLE="Style">

	<SCRIPT type="text/javascript">
	function windowTitle()
	{
	parent.document.title="WebApplicationContextFilter (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT)";
	}
	</SCRIPT>
	<NOSCRIPT>
	</NOSCRIPT>

	</HEAD>

	<BODY BGCOLOR="white" onload="windowTitle();">


	<!-- ========= START OF TOP NAVBAR ======= -->
	<A NAME="navbar_top"><!-- --></A>
	<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
	<TR>
	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
	<A NAME="navbar_top_firstrow"><!-- --></A>
	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
	<TR ALIGN="center" VALIGN="top">
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
	</TR>
	</TABLE>
	</TD>
	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
	</EM>
	</TD>
	</TR>

	<TR>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../../../org/apache/cayenne/conf/ServletUtil.html" title="class in org.apache.cayenne.conf"><B>PREV CLASS</B></A>
	<A HREF="../../../../org/apache/cayenne/conf/WebApplicationContextProvider.html" title="class in org.apache.cayenne.conf"><B>NEXT CLASS</B></A></FONT></TD>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../../../index.html?org/apache/cayenne/conf/WebApplicationContextFilter.html" target="_top"><B>FRAMES</B></A>
	<A HREF="WebApplicationContextFilter.html" target="_top"><B>NO FRAMES</B></A>
	<SCRIPT type="text/javascript">
	<!--
	if(window==top) {
	document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
	}
	//-->
	</SCRIPT>
	<NOSCRIPT>
	<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
	</NOSCRIPT>


	</FONT></TD>
	</TR>
	<TR>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	SUMMARY: NESTED \| FIELD \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	DETAIL: FIELD \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
	</TR>
	</TABLE>
	<A NAME="skip-navbar_top"></A>
	<!-- ========= END OF TOP NAVBAR ========= -->

	<HR>
	<!-- ======== START OF CLASS DATA ======== -->
	<H2>
	<FONT SIZE="-1">
	org.apache.cayenne.conf</FONT>
	<BR>
	Class WebApplicationContextFilter</H2>
	<PRE>
	java.lang.Object
	<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.cayenne.conf.WebApplicationContextFilter</B>
	</PRE>
	<DL>
	<DT><B>All Implemented Interfaces:</B> <DD>javax.servlet.Filter</DD>
	</DL>
	<HR>
	<DL>
	<DT><PRE>public class <B>WebApplicationContextFilter</B><DT>extends java.lang.Object<DT>implements javax.servlet.Filter</DL>
	</PRE>

	<P>
	<p>
	<code>WebApplicationContextFilter</code> is another helper class to help integrate
	Cayenne with web applications. The implementation is similar to
	<code>org.apache.cayenne.conf.WebApplicationContextProvider</code> however it
	allows for integration with containers that support version 2.3 of the servlet
	specification for example Tomcat 4.x. via the usage of filers.
	</p>
	<p>
	Whenever this filter is processed it attempts bind a <code>DataContext</code> to the
	thread. It retrieves the <code>DataContext</code> via the
	<code>BasicServletConfiguration.getDefaultDataContext()</code> and binds it to the
	thread using <code>DataContext.bindThreadDataContext()</code> method. If the session
	has not been created this filter will also create a new session.
	</p>
	<p>
	During initialization (init() method) this filter initializes the
	<code>BasicServletConfiguration</code> with the servlet context via the
	initializeConfiguration() method
	</p>
	<p>
	This filter can be installed in the web container as a "filter" as follows:

	<pre>
	<filter>
	<filter-name>WebApplicationContextFilter</filter-name>
	<filter-class>org.apache.cayenne.conf.WebApplicationContextFilter</filter-class>
	</filter>
	</pre>

	Then the mapping needs to be created to direct all or some requests to be processed by
	the filter as follows:

	<pre>
	<filter-mapping>
	<filter-name>WebApplicationContextFilter</filter-name>
	<url-pattern>/*</url-pattern>
	</filter-mapping>
	</pre>

	The above example the filter would be applied to all the servlets and static content
	pages in the Web application, because every request URI matches the '/*' URL pattern.
	The problem with this mapping however is the fact that this filter will run for every
	request made, whether for images and/or static content and dynamic content request.
	This maybe detrimental to performance. Hence the mapping url patter should be set
	accordingly.
	</p>
	<P>

	<P>
	<DL>
	<DT><B>Author:</B></DT>
	<DD>Gary Jarrel</DD>
	</DL>
	<HR>

	<P>

	<!-- ======== CONSTRUCTOR SUMMARY ======== -->

	<A NAME="constructor_summary"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
	<B>Constructor Summary</B></FONT></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/WebApplicationContextFilter.html#WebApplicationContextFilter()">WebApplicationContextFilter</A></B>()</CODE>

	<BR>
	</TD>
	</TR>
	</TABLE>

	<!-- ========== METHOD SUMMARY =========== -->

	<A NAME="method_summary"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
	<B>Method Summary</B></FONT></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> void</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/WebApplicationContextFilter.html#destroy()">destroy</A></B>()</CODE>

	<BR>
	Does nothing.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> void</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/WebApplicationContextFilter.html#doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)">doFilter</A></B>(javax.servlet.ServletRequest request,
	javax.servlet.ServletResponse response,
	javax.servlet.FilterChain chain)</CODE>

	<BR>
	Retrieves the <code>DataContext</code> bound to the <code>HttpSession</code>
	via <code>BasicServletConfiguration.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> void</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/WebApplicationContextFilter.html#init(javax.servlet.FilterConfig)">init</A></B>(javax.servlet.FilterConfig config)</CODE>

	<BR>
	Initializes the <code>BasicServletConfiguration</code> via the
	initializeConfiguration() method.</TD>
	</TR>
	</TABLE>
	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
	<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
	</TR>
	</TABLE>

	<P>

	<!-- ========= CONSTRUCTOR DETAIL ======== -->

	<A NAME="constructor_detail"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
	<B>Constructor Detail</B></FONT></TH>
	</TR>
	</TABLE>

	<A NAME="WebApplicationContextFilter()"><!-- --></A><H3>
	WebApplicationContextFilter</H3>
	<PRE>
	public <B>WebApplicationContextFilter</B>()</PRE>
	<DL>
	</DL>

	<!-- ============ METHOD DETAIL ========== -->

	<A NAME="method_detail"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
	<B>Method Detail</B></FONT></TH>
	</TR>
	</TABLE>

	<A NAME="destroy()"><!-- --></A><H3>
	destroy</H3>
	<PRE>
	public void <B>destroy</B>()</PRE>
	<DL>
	<DD>Does nothing. As per the servlet specification, gets called by the container when
	the filter is taken out of service.
	<P>
	<DD><DL>
	<DT><B>Specified by:</B><DD><CODE>destroy</CODE> in interface <CODE>javax.servlet.Filter</CODE></DL>
	</DD>
	<DD><DL>
	</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="init(javax.servlet.FilterConfig)"><!-- --></A><H3>
	init</H3>
	<PRE>
	public void <B>init</B>(javax.servlet.FilterConfig config)
	throws javax.servlet.ServletException</PRE>
	<DL>
	<DD>Initializes the <code>BasicServletConfiguration</code> via the
	initializeConfiguration() method. Also saves the FilterConfing to a private local
	variable for possible later access. This method is part of the <code>Filter</code>
	interface and is called by the container when the filter is placed into service.
	<P>
	<DD><DL>
	<DT><B>Specified by:</B><DD><CODE>init</CODE> in interface <CODE>javax.servlet.Filter</CODE></DL>
	</DD>
	<DD><DL>

	<DT><B>Throws:</B>
	<DD><CODE>javax.servlet.ServletException</CODE></DL>
	</DD>
	</DL>
	<HR>

	<A NAME="doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)"><!-- --></A><H3>
	doFilter</H3>
	<PRE>
	public void <B>doFilter</B>(javax.servlet.ServletRequest request,
	javax.servlet.ServletResponse response,
	javax.servlet.FilterChain chain)
	throws java.io.IOException,
	javax.servlet.ServletException</PRE>
	<DL>
	<DD>Retrieves the <code>DataContext</code> bound to the <code>HttpSession</code>
	via <code>BasicServletConfiguration.

	getDefaultContext()</code>, and binds it to
	the current thread.
	<P>
	<DD><DL>
	<DT><B>Specified by:</B><DD><CODE>doFilter</CODE> in interface <CODE>javax.servlet.Filter</CODE></DL>
	</DD>
	<DD><DL>

	<DT><B>Throws:</B>
	<DD><CODE>java.io.IOException</CODE>
	<DD><CODE>javax.servlet.ServletException</CODE></DL>
	</DD>
	</DL>
	<!-- ========= END OF CLASS DATA ========= -->
	<HR>


	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<A NAME="navbar_bottom"><!-- --></A>
	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
	<TR>
	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
	<A NAME="navbar_bottom_firstrow"><!-- --></A>
	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
	<TR ALIGN="center" VALIGN="top">
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
	</TR>
	</TABLE>
	</TD>
	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
	</EM>
	</TD>
	</TR>

	<TR>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../../../org/apache/cayenne/conf/ServletUtil.html" title="class in org.apache.cayenne.conf"><B>PREV CLASS</B></A>
	<A HREF="../../../../org/apache/cayenne/conf/WebApplicationContextProvider.html" title="class in org.apache.cayenne.conf"><B>NEXT CLASS</B></A></FONT></TD>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../../../index.html?org/apache/cayenne/conf/WebApplicationContextFilter.html" target="_top"><B>FRAMES</B></A>
	<A HREF="WebApplicationContextFilter.html" target="_top"><B>NO FRAMES</B></A>
	<SCRIPT type="text/javascript">
	<!--
	if(window==top) {
	document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
	}
	//-->
	</SCRIPT>
	<NOSCRIPT>
	<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
	</NOSCRIPT>


	</FONT></TD>
	</TR>
	<TR>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	SUMMARY: NESTED \| FIELD \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	DETAIL: FIELD \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
	</TR>
	</TABLE>
	<A NAME="skip-navbar_bottom"></A>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->

	<HR>

	<i>Copyright © 2001-2006 <a href=
	"http://apache.org" target="_top">Apache.org</a> All Rights Reserved.</i>

	</BODY>
	</HTML>