html/loading-deployments-from-the-classpath.html - openejb - Git at Google


 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <HTML>
   <HEAD>
     <!-- $PAGETITLE -->
     <TITLE>OpenEJB - Loading Deployments from the Classpath</TITLE>
     <LINK href="http://openejb.apache.org/all.css" rel="stylesheet" type="text/css">
     <!--[if IE]><link rel="stylesheet" type="text/css" media="screen, projection" href="openejb.apache.org/ie.css"><![endif]-->

     <LINK rel="SHORTCUT ICON" href="http://openejb.apache.org/images/favicon.ico">
     <META http-equiv="Content-Type" content="text/html;charset=UTF-8">
 <SCRIPT language="javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.1/jquery.min.js" type="text/javascript"></SCRIPT>
 <SCRIPT language="javascript" src="http://openejb.apache.org/tweet/jquery.tweet.js" type="text/javascript"></SCRIPT>
 <SCRIPT type="text/javascript">
     $(document).ready(function(){
         $(".tweet").tweet({
         avatar_size: 32,
         count: 4,
 	fetch:25,
         username: "openejb",
         list: "contributors",
 	template:"{avatar}{text}",
 	filter: function(t){ return /openejb/i.test(t["tweet_raw_text"]); },
         loading_text: "loading list..."
         });
     });
 </SCRIPT>

   </HEAD>
   <BODY>

     <!-- Delay the loading of the external javascript file needed for labels (as it takes too long to load and visibly holds loading of the page body) -->
     <!-- To do this without javascript errors over undefined functions, we need to declare stubs here (that are overrided later by the proper implementations) -->
     <SCRIPT language="JavaScript" type="text/javascript">
       function doAddLabel(hideTextfieldAfterAddParam)
       {
       // stub
       }

       function onAddLabel()
       {
       // stub
       }

       function showLabelsInput()
       {
       // stub
       }
     </SCRIPT>

     <A name="top"></A>
     <TABLE class="frameTable" cellpadding="0" cellspacing="0" border="0">
       <TR class="Row1">
         <TD class="Col1"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
         <TD class="Col2"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
         <TD class="Col3"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
         <TD class="Col4"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
         <TD class="Col5"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
       </TR>
       <TR class="Row2">
         <TD class="Col1"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
         <TD class="Col2">&nbsp;</TD>
         <TD class="Col3" id="breadcrumbs">
           <!-- $TOP_NAV_BAR -->
                     <A href="index.html" title="Index">Home</A> | <A href="news.html" title="News">News</A> | <A href="faq.html" title="FAQ">FAQ</A> | <A href="download.html" title="Download">Download</A> | <A href="mailing-lists.html" title="Mailing Lists">Lists</A> | <A href="http://issues.apache.org/jira/browse/OPENEJB" class="external-link" rel="nofollow">Issues</A>

         </TD>
         <TD class="Col4"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
         <TD class="Col5">&nbsp;</TD>
       </TR>
       <TR class="Row3">
         <TD class="Col1"><IMG alt="" class="Row3Img" id="thinLine" src="http://openejb.apache.org/images/line_sm.gif"></TD>
         <TD class="Col2"><IMG alt="" class="Row3Img" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
         <TD class="Col3"><IMG alt="" class="Row3Img" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
         <TD class="Col4"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
         <TD class="Col5"><IMG alt="" class="Row3Img" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
       </TR>
       <TR class="Row4">
         <TD class="Col1">
           <SPAN id="Navigation">

                         <H3><A name="Navigation-Overview"></A>Overview</H3>

 <UL class="alternate" type="square">
 	<LI><A href="index.html" title="Index">Home</A></LI>
 	<LI><A href="news.html" title="News">News</A></LI>
 	<LI><A href="faq.html" title="FAQ">FAQ</A></LI>
 	<LI><A href="download.html" title="Download">Download</A></LI>
 	<LI><A href="../OPENEJBx30/index.html" title="Index">Documentation</A></LI>
 	<LI><A href="examples.html" title="Examples">Examples</A></LI>
 	<LI><A href="http://cwiki.apache.org/confluence/display/OPENEJB/Lightening%20Demos" class="external-link" rel="nofollow">Lightning Demos</A></LI>
 	<LI><A href="mailing-lists.html" title="Mailing Lists">Mailing Lists</A></LI>
 	<LI><A href="source-code.html" title="Source Code">Source Code</A></LI>
 	<LI><A href="http://blogs.apache.org/openejb" class="external-link" rel="nofollow">Project Blog</A></LI>
 </UL>


 <H3><A name="Navigation-Servers"></A>Servers</H3>

 <UL class="alternate" type="square">
 	<LI><A href="local-server.html" title="Local Server">Local</A></LI>
 	<LI><A href="remote-server.html" title="Remote Server">Remote</A></LI>
 </UL>


 <H3><A name="Navigation-Integrations"></A>Integrations</H3>

 <UL class="alternate" type="square">
 	<LI><A href="../OPENEJBx30/tomcat.html" title="Tomcat">Tomcat</A></LI>
 	<LI><A href="geronimo.html" title="Geronimo">Geronimo</A></LI>
 	<LI><A href="webobjects.html" title="WebObjects">WebObjects</A></LI>
 </UL>


 <H3><A name="Navigation-Community"></A>Community</H3>

 <UL class="alternate" type="square">
 	<LI><A href="team.html" title="Team">Team</A></LI>
 	<LI><A href="articles.html" title="Articles">Articles</A></LI>
 	<LI><A href="http://webchat.freenode.net/?channels=openejb" class="external-link" rel="nofollow">IRC</A></LI>
 </UL>


 <H3><A name="Navigation-RelatedProjects"></A>Related Projects</H3>

 <UL class="alternate" type="square">
 	<LI><A href="http://activemq.apache.org/" class="external-link" rel="nofollow">ActiveMQ</A></LI>
 	<LI><A href="http://openjpa.apache.org/" class="external-link" rel="nofollow">OpenJPA</A></LI>
 	<LI><A href="http://cxf.apache.org/" class="external-link" rel="nofollow">CXF</A></LI>
 </UL>


 <H3><A name="Navigation-Index"></A>Index</H3>
 <UL class="alternate" type="square">
 	<LI><A href="space-index.html" title="Space Index">Site Index</A></LI>
 	<LI><A href="../OPENEJBx30/space-index.html" title="Space Index">Doc Index</A></LI>
 </UL>

             <H3>
               <A name="Navigation-Feeds"></A>
               Feeds
             </H3>

             <UL class="feeds">
             <LI>
               <A href="http://cwiki.apache.org/confluence/spaces/rss.action?key=OPENEJB&newPages=false">
               <IMG src="http://openejb.apache.org/images/rss.gif"></A>
               <A class="feedsText" href="http://cwiki.apache.org/confluence/spaces/rss.action?key=OPENEJB&newPages=false">Site</A>
             </LI>

             <LI><A href="http://cwiki.apache.org/confluence/spaces/blogrss.action?key=OPENEJB">
               <IMG src="http://openejb.apache.org/images/rss.gif"></A>
               <A class="feedsText" href="http://cwiki.apache.org/confluence/spaces/blogrss.action?key=OPENEJB">News</A>
             </LI>
             </UL>
           </SPAN>
         </TD>
         <TD class="Col2">&nbsp;</TD>
         <TD class="Col3">
           <TABLE id="PageHeader" border="0" width="100%">
             <TR>
               <TD>
                 <A href="http://openejb.org/">
                   <IMG hspace="0" src="http://openejb.apache.org/images/logo_openejb.gif" vspace="0">
                 </A>
               </TD>
               <TD align="right">
                 <A href="http://www.apache.org/">
                   <IMG src="http://www.apache.org/images/asf-logo.gif" width="258" height="66">
                 </A>
               </TD>
             </TR>
             <TR>
               <TD id="page_title">
                 <!-- $TITLE -->
                 Loading Deployments from the Classpath
               </TD>

               <TD align="right">
                 <BR><BR>
                 <!-- Google CSE Search Box Begins  -->
                 <FORM id="searchbox_010475492895890475512:_t4iqjrgx90" action="http://www.google.com/cse">
                   <INPUT type="hidden" name="cx" value="010475492895890475512:_t4iqjrgx90">
                   <INPUT type="hidden" name="cof" value="FORID:0">
                   <INPUT name="q" type="text" size="25">
                   <INPUT type="submit" name="sa" value="Search">
                 </FORM>
                 <SCRIPT type="text/javascript" src="http://www.google.com/coop/cse/brand?form=searchbox_010475492895890475512:_t4iqjrgx90"></SCRIPT>
                 <!-- Google CSE Search Box Ends -->

               </TD>
             </TR>
           </TABLE>
           <P>
             <!-- $BODY -->
             <DIV id="PageContent">
               <P>This document details the various ways to get OpenEJB to pickup applications you'd like deployed while in an embedded mode.</P>

 <H1><A name="LoadingDeploymentsfromtheClasspath-Emptyejbjar.xmlapproach%28recommended%29"></A>Empty ejb-jar.xml approach (recommended)</H1>

 <P>Simplify the issue of searching for annotated applications by adding an ejb-jar.xml like this to your app:</P>

 <DIV class="code panel" style="border-width: 1px;"><DIV class="codeHeader panelHeader" style="border-bottom-width: 1px;"><B>&quot;META-INF/ejb-jar.xml</B></DIV><DIV class="codeContent panelContent">
 <PRE class="code-xml">
 <SPAN class="code-tag">&lt;ejb-jar/&gt;</SPAN>
 </PRE>
 </DIV></DIV>

 <P>OpenEJB will find the app in the classpath and deploy it along with any annotated beans it may contain.</P>

 <P>The ejb-jar.xml can contain more than just &quot;&lt;ejb-jar/&gt;&quot; as usual.</P>

 <P>This is the recommended approach for people using OpenEJB for unit testing as it allows OpenEJB to find your application in the classpath without the need for you to specify any path information which tends to complicate builds.</P>

 <H1><A name="LoadingDeploymentsfromtheClasspath-Including%2FExcludingpaths%28advanced%29"></A>Including/Excluding paths (advanced)</H1>

 <P>If you do not like the idea of having the ejb-jar.xml in your app or an openejb.xml, we can search the classpath for annotated beans (@Stateless, @Stateful, @MessageDriven) and load them automatically just as if they contained an ejb-jar.xml.</P>

 <P>This form of searching, however, is very expensive as it involves iterating over every path in the classpath and reading in each class definition contained thereunder and checking it for annotations.</P>

 <P>This approach can only be made faster by helping us trim down or pinpoint the paths we should search via the <B>openejb.deployments.classpath.include</B> property which can be specified as a <EM>system property</EM> or a property passed into the <EM>InitialContext</EM>.  </P>

 <P>The value of this property is a regular expression and therefore can be absolute or relative.  For example the path &quot;/Users/dblevins/work/swizzle/swizzle-stream/target/classes&quot; which contains the class files of an application you wish to test could be included in any of the following values to the &quot;openejb.deployments.classpath.include&quot; property:</P>

 <UL class="alternate" type="square">
 	<LI>&quot;file:///Users/dblevins/work/swizzle/swizzle-stream/target/classes/&quot;  <EM>(an absolute path)</EM></LI>
 	<LI>&quot;file:///Users/dblevins/work/swizzle/.*&quot;                              <EM>(relative)</EM></LI>
 	<LI>&quot;.&#42;swizzle-stream.&#42;&quot;                                                  <EM>(very relative)</EM></LI>
 	<LI>&quot;.&#42;(swizzle-stream|swizzle-jira|acme-rocket-app).&#42;&quot;                   <EM>(including several paths)</EM></LI>
 </UL>


 <P>Note the filtering is done on URLs in the classpath, so forward slashes should always be used even on OSs using backslash (&quot;\&quot;).</P>

 <P>There is an <B>openejb.deployments.classpath.exclude</B> property if you wish to work in the opposite direction.  The default values for both properties are as follows:</P>

 <P>  openejb.deployments.classpath.include=&quot;&quot;  <EM>//include nothing</EM><BR>
   openejb.deployments.classpath.exclude=&quot;.*&quot;  <EM>//exclude everything</EM></P>

 <P>The exclude and the include is applied separately and the results of each are combined together to create the list of paths OpenEJB will scrape for annotations.</P>

 <P><B>Note</B> by default these settings will only affect which jars OpenEJB will scan for annotated components when no descriptor is found.  If you would like to use these settings to also filter out jars that do contain descriptors, set the <B>openejb.deployments.classpath.filter.descriptors</B> property to <EM>true</EM>.  The default is <EM>false</EM>.</P>

 <H1><A name="LoadingDeploymentsfromtheClasspath-Troubleshooting"></A>Troubleshooting</H1>

 <P>If you're having trouble determining if the META-INF/ejb-jar.xml file for your ejb module is in the classpath, a little debug code like this in your test setup will help you see what OpenEJB sees (which may be nothing):</P>

 <DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
 <PRE class="code-java">
 Enumeration&lt;URL&gt; ejbJars = <SPAN class="code-keyword">this</SPAN>.getClass().getClassLoader().getResources(<SPAN class="code-quote">&quot;META-INF/ejb-jar.xml&quot;</SPAN>);
 <SPAN class="code-keyword">while</SPAN> (ejbJars.hasMoreElements()) {
     URL url = ejbJars.nextElement();
     <SPAN class="code-object">System</SPAN>.out.println(<SPAN class="code-quote">&quot;app = &quot;</SPAN> + url);
 }
 </PRE>
 </DIV></DIV>
             </DIV>
           </P>
         </TD>
         <TD class="Col4"><IMG src="http://openejb.apache.org/images/dotTrans.gif"></TD>
         <TD class="Col5">

         </TD>
       </TR>
       <TR class="Row5">
         <TD class="Col1">&nbsp;</TD>
         <TD class="Col2">&nbsp;</TD>
         <TD class="Col3">
           <BR>
           <BR>
           <IMG width="100%" height="1" src="http://openejb.apache.org/images/line_light.gif">
           <TABLE width="100%">
             <TR>
               <TD>
                 <SPAN class="bodyGrey">
                   <SMALL>
                     <NOTICE><!-- $FOOTER -->
                       Apache OpenEJB is an project of The Apache Software Foundation (ASF)
                     </NOTICE>
                     <BR>
                     Site Powered by
                     <A href="http://atlassian.com/">Atlassian</A>
                     <A href="http://atlassian.com/confluence/">Confluence</A>
                     .
                   </SMALL>
                 </SPAN>
               </TD>
               <TD align="right">
                 <A style="color:#999;font-size:small;font-weight:normal;" href="https://cwiki.apache.org/confluence/pages/editpage.action?spaceKey=OPENEJB&title=Loading%20Deployments%20from%20the%20Classpath">[ edit ]</A>
               </TD>
             </TR>
           </TABLE>
           <BR>
         </TD>
         <TD class="Col4"><IMG src="http://openejb.apache.org/images/dotTrans.gif"></TD>
         <TD class="Col5">&nbsp;</TD>
       </TR>
     </TABLE>

     <!-- Needed for composition plugin -->
     <!-- delay the loading of large javascript files to the end so that they don't interfere with the loading of page content -->
     <SPAN style="display: none">
       <SCRIPT type="text/javascript" language="JavaScript" src="http://cwiki.apache.org/confluence/labels-javascript"></SCRIPT>

       <SCRIPT src="http://www.google-analytics.com/urchin.js" type="text/javascript">
       </SCRIPT>
       <SCRIPT type="text/javascript">
         _uacct = "UA-2717626-1";
         urchinTracker();
       </SCRIPT>
     </SPAN>

   </BODY>
 </HTML>

	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<HTML>
	<HEAD>
	<!-- $PAGETITLE -->
	<TITLE>OpenEJB - Loading Deployments from the Classpath</TITLE>
	<LINK href="http://openejb.apache.org/all.css" rel="stylesheet" type="text/css">
	<!--[if IE]><link rel="stylesheet" type="text/css" media="screen, projection" href="openejb.apache.org/ie.css"><![endif]-->

	<LINK rel="SHORTCUT ICON" href="http://openejb.apache.org/images/favicon.ico">
	<META http-equiv="Content-Type" content="text/html;charset=UTF-8">
	<SCRIPT language="javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.1/jquery.min.js" type="text/javascript"></SCRIPT>
	<SCRIPT language="javascript" src="http://openejb.apache.org/tweet/jquery.tweet.js" type="text/javascript"></SCRIPT>
	<SCRIPT type="text/javascript">
	$(document).ready(function(){
	$(".tweet").tweet({
	avatar_size: 32,
	count: 4,
	fetch:25,
	username: "openejb",
	list: "contributors",
	template:"{avatar}{text}",
	filter: function(t){ return /openejb/i.test(t["tweet_raw_text"]); },
	loading_text: "loading list..."
	});
	});
	</SCRIPT>

	</HEAD>
	<BODY>

	<!-- Delay the loading of the external javascript file needed for labels (as it takes too long to load and visibly holds loading of the page body) -->
	<!-- To do this without javascript errors over undefined functions, we need to declare stubs here (that are overrided later by the proper implementations) -->
	<SCRIPT language="JavaScript" type="text/javascript">
	function doAddLabel(hideTextfieldAfterAddParam)
	{
	// stub
	}

	function onAddLabel()
	{
	// stub
	}

	function showLabelsInput()
	{
	// stub
	}
	</SCRIPT>

	<A name="top"></A>
	<TABLE class="frameTable" cellpadding="0" cellspacing="0" border="0">
	<TR class="Row1">
	<TD class="Col1"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
	<TD class="Col2"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
	<TD class="Col3"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
	<TD class="Col4"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
	<TD class="Col5"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
	</TR>
	<TR class="Row2">
	<TD class="Col1"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
	<TD class="Col2"> </TD>
	<TD class="Col3" id="breadcrumbs">
	<!-- $TOP_NAV_BAR -->
	<A href="index.html" title="Index">Home</A> \| <A href="news.html" title="News">News</A> \| <A href="faq.html" title="FAQ">FAQ</A> \| <A href="download.html" title="Download">Download</A> \| <A href="mailing-lists.html" title="Mailing Lists">Lists</A> \| <A href="http://issues.apache.org/jira/browse/OPENEJB" class="external-link" rel="nofollow">Issues</A>

	</TD>
	<TD class="Col4"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
	<TD class="Col5"> </TD>
	</TR>
	<TR class="Row3">
	<TD class="Col1"><IMG alt="" class="Row3Img" id="thinLine" src="http://openejb.apache.org/images/line_sm.gif"></TD>
	<TD class="Col2"><IMG alt="" class="Row3Img" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
	<TD class="Col3"><IMG alt="" class="Row3Img" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
	<TD class="Col4"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
	<TD class="Col5"><IMG alt="" class="Row3Img" src="http://openejb.apache.org/images/dotTrans.gif"></TD>
	</TR>
	<TR class="Row4">
	<TD class="Col1">
	<SPAN id="Navigation">

	<H3><A name="Navigation-Overview"></A>Overview</H3>

	<UL class="alternate" type="square">
	<LI><A href="index.html" title="Index">Home</A></LI>
	<LI><A href="news.html" title="News">News</A></LI>
	<LI><A href="faq.html" title="FAQ">FAQ</A></LI>
	<LI><A href="download.html" title="Download">Download</A></LI>
	<LI><A href="../OPENEJBx30/index.html" title="Index">Documentation</A></LI>
	<LI><A href="examples.html" title="Examples">Examples</A></LI>
	<LI><A href="http://cwiki.apache.org/confluence/display/OPENEJB/Lightening%20Demos" class="external-link" rel="nofollow">Lightning Demos</A></LI>
	<LI><A href="mailing-lists.html" title="Mailing Lists">Mailing Lists</A></LI>
	<LI><A href="source-code.html" title="Source Code">Source Code</A></LI>
	<LI><A href="http://blogs.apache.org/openejb" class="external-link" rel="nofollow">Project Blog</A></LI>
	</UL>


	<H3><A name="Navigation-Servers"></A>Servers</H3>

	<UL class="alternate" type="square">
	<LI><A href="local-server.html" title="Local Server">Local</A></LI>
	<LI><A href="remote-server.html" title="Remote Server">Remote</A></LI>
	</UL>


	<H3><A name="Navigation-Integrations"></A>Integrations</H3>

	<UL class="alternate" type="square">
	<LI><A href="../OPENEJBx30/tomcat.html" title="Tomcat">Tomcat</A></LI>
	<LI><A href="geronimo.html" title="Geronimo">Geronimo</A></LI>
	<LI><A href="webobjects.html" title="WebObjects">WebObjects</A></LI>
	</UL>


	<H3><A name="Navigation-Community"></A>Community</H3>

	<UL class="alternate" type="square">
	<LI><A href="team.html" title="Team">Team</A></LI>
	<LI><A href="articles.html" title="Articles">Articles</A></LI>
	<LI><A href="http://webchat.freenode.net/?channels=openejb" class="external-link" rel="nofollow">IRC</A></LI>
	</UL>


	<H3><A name="Navigation-RelatedProjects"></A>Related Projects</H3>

	<UL class="alternate" type="square">
	<LI><A href="http://activemq.apache.org/" class="external-link" rel="nofollow">ActiveMQ</A></LI>
	<LI><A href="http://openjpa.apache.org/" class="external-link" rel="nofollow">OpenJPA</A></LI>
	<LI><A href="http://cxf.apache.org/" class="external-link" rel="nofollow">CXF</A></LI>
	</UL>


	<H3><A name="Navigation-Index"></A>Index</H3>
	<UL class="alternate" type="square">
	<LI><A href="space-index.html" title="Space Index">Site Index</A></LI>
	<LI><A href="../OPENEJBx30/space-index.html" title="Space Index">Doc Index</A></LI>
	</UL>

	<H3>
	<A name="Navigation-Feeds"></A>
	Feeds
	</H3>

	<UL class="feeds">
	<LI>
	<A href="http://cwiki.apache.org/confluence/spaces/rss.action?key=OPENEJB&newPages=false">
	<IMG src="http://openejb.apache.org/images/rss.gif"></A>
	<A class="feedsText" href="http://cwiki.apache.org/confluence/spaces/rss.action?key=OPENEJB&newPages=false">Site</A>
	</LI>

	<LI><A href="http://cwiki.apache.org/confluence/spaces/blogrss.action?key=OPENEJB">
	<IMG src="http://openejb.apache.org/images/rss.gif"></A>
	<A class="feedsText" href="http://cwiki.apache.org/confluence/spaces/blogrss.action?key=OPENEJB">News</A>
	</LI>
	</UL>
	</SPAN>
	</TD>
	<TD class="Col2"> </TD>
	<TD class="Col3">
	<TABLE id="PageHeader" border="0" width="100%">
	<TR>
	<TD>
	<A href="http://openejb.org/">
	<IMG hspace="0" src="http://openejb.apache.org/images/logo_openejb.gif" vspace="0">
	</A>
	</TD>
	<TD align="right">
	<A href="http://www.apache.org/">
	<IMG src="http://www.apache.org/images/asf-logo.gif" width="258" height="66">
	</A>
	</TD>
	</TR>
	<TR>
	<TD id="page_title">
	<!-- $TITLE -->
	Loading Deployments from the Classpath
	</TD>

	<TD align="right">
	<BR><BR>
	<!-- Google CSE Search Box Begins -->
	<FORM id="searchbox_010475492895890475512:_t4iqjrgx90" action="http://www.google.com/cse">
	<INPUT type="hidden" name="cx" value="010475492895890475512:_t4iqjrgx90">
	<INPUT type="hidden" name="cof" value="FORID:0">
	<INPUT name="q" type="text" size="25">
	<INPUT type="submit" name="sa" value="Search">
	</FORM>
	<SCRIPT type="text/javascript" src="http://www.google.com/coop/cse/brand?form=searchbox_010475492895890475512:_t4iqjrgx90"></SCRIPT>
	<!-- Google CSE Search Box Ends -->

	</TD>
	</TR>
	</TABLE>
	<P>
	<!-- $BODY -->
	<DIV id="PageContent">
	<P>This document details the various ways to get OpenEJB to pickup applications you'd like deployed while in an embedded mode.</P>

	<H1><A name="LoadingDeploymentsfromtheClasspath-Emptyejbjar.xmlapproach%28recommended%29"></A>Empty ejb-jar.xml approach (recommended)</H1>

	<P>Simplify the issue of searching for annotated applications by adding an ejb-jar.xml like this to your app:</P>

	<DIV class="code panel" style="border-width: 1px;"><DIV class="codeHeader panelHeader" style="border-bottom-width: 1px;"><B>"META-INF/ejb-jar.xml</B></DIV><DIV class="codeContent panelContent">
	<PRE class="code-xml">
	<SPAN class="code-tag"><ejb-jar/></SPAN>
	</PRE>
	</DIV></DIV>

	<P>OpenEJB will find the app in the classpath and deploy it along with any annotated beans it may contain.</P>

	<P>The ejb-jar.xml can contain more than just "<ejb-jar/>" as usual.</P>

	<P>This is the recommended approach for people using OpenEJB for unit testing as it allows OpenEJB to find your application in the classpath without the need for you to specify any path information which tends to complicate builds.</P>

	<H1><A name="LoadingDeploymentsfromtheClasspath-Including%2FExcludingpaths%28advanced%29"></A>Including/Excluding paths (advanced)</H1>

	<P>If you do not like the idea of having the ejb-jar.xml in your app or an openejb.xml, we can search the classpath for annotated beans (@Stateless, @Stateful, @MessageDriven) and load them automatically just as if they contained an ejb-jar.xml.</P>

	<P>This form of searching, however, is very expensive as it involves iterating over every path in the classpath and reading in each class definition contained thereunder and checking it for annotations.</P>

	<P>This approach can only be made faster by helping us trim down or pinpoint the paths we should search via the <B>openejb.deployments.classpath.include</B> property which can be specified as a <EM>system property</EM> or a property passed into the <EM>InitialContext</EM>. </P>

	<P>The value of this property is a regular expression and therefore can be absolute or relative. For example the path "/Users/dblevins/work/swizzle/swizzle-stream/target/classes" which contains the class files of an application you wish to test could be included in any of the following values to the "openejb.deployments.classpath.include" property:</P>

	<UL class="alternate" type="square">
	<LI>"file:///Users/dblevins/work/swizzle/swizzle-stream/target/classes/" <EM>(an absolute path)</EM></LI>
	<LI>"file:///Users/dblevins/work/swizzle/.*" <EM>(relative)</EM></LI>
	<LI>".swizzle-stream." <EM>(very relative)</EM></LI>
	<LI>".(swizzle-stream\|swizzle-jira\|acme-rocket-app)." <EM>(including several paths)</EM></LI>
	</UL>


	<P>Note the filtering is done on URLs in the classpath, so forward slashes should always be used even on OSs using backslash ("\").</P>

	<P>There is an <B>openejb.deployments.classpath.exclude</B> property if you wish to work in the opposite direction. The default values for both properties are as follows:</P>

	<P> openejb.deployments.classpath.include="" <EM>//include nothing</EM><BR>
	openejb.deployments.classpath.exclude=".*" <EM>//exclude everything</EM></P>

	<P>The exclude and the include is applied separately and the results of each are combined together to create the list of paths OpenEJB will scrape for annotations.</P>

	<P><B>Note</B> by default these settings will only affect which jars OpenEJB will scan for annotated components when no descriptor is found. If you would like to use these settings to also filter out jars that do contain descriptors, set the <B>openejb.deployments.classpath.filter.descriptors</B> property to <EM>true</EM>. The default is <EM>false</EM>.</P>

	<H1><A name="LoadingDeploymentsfromtheClasspath-Troubleshooting"></A>Troubleshooting</H1>

	<P>If you're having trouble determining if the META-INF/ejb-jar.xml file for your ejb module is in the classpath, a little debug code like this in your test setup will help you see what OpenEJB sees (which may be nothing):</P>

	<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
	<PRE class="code-java">
	Enumeration<URL> ejbJars = <SPAN class="code-keyword">this</SPAN>.getClass().getClassLoader().getResources(<SPAN class="code-quote">"META-INF/ejb-jar.xml"</SPAN>);
	<SPAN class="code-keyword">while</SPAN> (ejbJars.hasMoreElements()) {
	URL url = ejbJars.nextElement();
	<SPAN class="code-object">System</SPAN>.out.println(<SPAN class="code-quote">"app = "</SPAN> + url);
	}
	</PRE>
	</DIV></DIV>
	</DIV>
	</P>
	</TD>
	<TD class="Col4"><IMG src="http://openejb.apache.org/images/dotTrans.gif"></TD>
	<TD class="Col5">

	</TD>
	</TR>
	<TR class="Row5">
	<TD class="Col1"> </TD>
	<TD class="Col2"> </TD>
	<TD class="Col3">
	<BR>
	<BR>
	<IMG width="100%" height="1" src="http://openejb.apache.org/images/line_light.gif">
	<TABLE width="100%">
	<TR>
	<TD>
	<SPAN class="bodyGrey">
	<SMALL>
	<NOTICE><!-- $FOOTER -->
	Apache OpenEJB is an project of The Apache Software Foundation (ASF)
	</NOTICE>
	<BR>
	Site Powered by
	<A href="http://atlassian.com/">Atlassian</A>
	<A href="http://atlassian.com/confluence/">Confluence</A>
	.
	</SMALL>
	</SPAN>
	</TD>
	<TD align="right">
	<A style="color:#999;font-size:small;font-weight:normal;" href="https://cwiki.apache.org/confluence/pages/editpage.action?spaceKey=OPENEJB&title=Loading%20Deployments%20from%20the%20Classpath">[ edit ]</A>
	</TD>
	</TR>
	</TABLE>
	<BR>
	</TD>
	<TD class="Col4"><IMG src="http://openejb.apache.org/images/dotTrans.gif"></TD>
	<TD class="Col5"> </TD>
	</TR>
	</TABLE>

	<!-- Needed for composition plugin -->
	<!-- delay the loading of large javascript files to the end so that they don't interfere with the loading of page content -->
	<SPAN style="display: none">
	<SCRIPT type="text/javascript" language="JavaScript" src="http://cwiki.apache.org/confluence/labels-javascript"></SCRIPT>

	<SCRIPT src="http://www.google-analytics.com/urchin.js" type="text/javascript">
	</SCRIPT>
	<SCRIPT type="text/javascript">
	_uacct = "UA-2717626-1";
	urchinTracker();
	</SCRIPT>
	</SPAN>

	</BODY>
	</HTML>