configuring-datasources.html - tomee-site-pub - Git at Google

 <!DOCTYPE html>
 <html lang="en">
   <head>

     <meta charset="UTF-8">
       <title>Configuring DataSources in tomee.xml</title>
     <meta name="description" content="Apache TomEE">
     <meta name="author" content="Apache TomEE">
     <meta name="google-translate-customization" content="f36a520c08f4c9-0a04e86a9c075ce9-g265f3196f697cf8f-10">
     <meta http-equiv="Pragma" content="no-cache">
     <meta http-equiv="Expires" content="0">
     <meta http-equiv="Cache-Control" content="no-store, no-cache, must-revalidate, max-age=0">

     <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
     <!--[if lt IE 9]>
       <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
     <![endif]-->

     <!-- Le styles -->
     <link href="./resources/css/bootstrap.css" rel="stylesheet">
     <link href="./resources/css/prettify.css" rel="stylesheet">
     <!--link href="./resources/css/bootstrap-mods.css" rel="stylesheet"-->
     <link href="./resources/css/main.css" rel="stylesheet">
     <link href="./resources/font-awesome-4.6.3/css/font-awesome.min.css" rel="stylesheet">

     <script type="text/javascript">
         var t = encodeURIComponent(document.title.replace(/^\s+|\s+$/g,""));
         var u = encodeURIComponent(""+document.URL);

       function fbshare () {
           window.open(
                   "http://www.facebook.com/sharer/sharer.php?u="+u,
                   'Share on Facebook',
                   'width=640,height=426');
       };
       function gpshare () {
           window.open(
                   "https://plus.google.com/share?url="+u,
                   'Share on Google+',
                   'width=584,height=385');
       };
       function twshare () {
           window.open(
                   "https://twitter.com/intent/tweet?url="+u+"&text="+t,
                   'Share on Twitter',
                   'width=800,height=526');
       };
       function pinshare () {
           window.open("//www.pinterest.com/pin/create/button/?url="+u+"&media=http%3A%2F%2Ftomee.apache.org%2Fresources%2Fimages%2Ffeather-logo.png&description="+t,
                   'Share on Pinterest',
                   'width=800,height=526');
       };
     </script>

     <!-- Le fav and touch icons -->
     <link rel="shortcut icon" href="./favicon.ico">
     <link rel="apple-touch-icon" href="./resources/images/apple-touch-icon.png">
     <link rel="apple-touch-icon" sizes="72x72" href="./resources/images/apple-touch-icon-72x72.png">
     <link rel="apple-touch-icon" sizes="114x114" href="./resources/images/apple-touch-icon-114x114.png">

     <script src="./resources/js/prettify.js" type="text/javascript"></script>
     <script src="./resources/js/jquery-latest.js"></script>
     <script src="http://platform.twitter.com/widgets.js" type="text/javascript"></script>
     <script src="./resources/js/common.js"></script>
     <script src="./resources/js/prettyprint.js"></script>
     <!--script src="//assets.pinterest.com/js/pinit.js" type="text/javascript" async></script//-->

     <script type="text/javascript">

       var _gaq = _gaq || [];
       _gaq.push(['_setAccount', 'UA-2717626-1']);
       _gaq.push(['_setDomainName', 'apache.org']);
       _gaq.push(['_trackPageview']);

       (function() {
         var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
         ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
         var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
       })();

     </script>
   </head>

   <body>

     <div class="topbar" data-dropdown="dropdown">
       <div class="fill">
         <div class="container">
           <a class="brand" href="./index.html">Apache TomEE</a>
           <ul class="nav">
               <li class="dropdown">
                   <a class="dropdown-toggle" data-toggle="dropdown" href="#">
                   Apache
                       <b class="caret"></b>
                   </a>
                   <ul class="dropdown-menu">
                      <!-- <li><a href="./misc/whoweare.html">Who we are?</a></li> -->
                      <!-- <li><a href="./misc/heritage.html">Heritage</a></li> -->
                      <li><a href="http://www.apache.org">Apache Home</a></li>
                      <!-- <li><a href="./misc/resources.html">Resources</a></li> -->
                      <li><a href="./misc/contact.html">Contact</a></li>
                      <li><a href="./misc/legal.html">Legal</a></li>
                      <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
                      <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
                      <li class="divider"/>
                      <li><a href="http://www.apache.org/security">Security</a></li>
                   </ul>
               </li>
               <li><a href="./index.html">Home</a></li>
               <li><a href="./downloads.html">Downloads</a></li>
               <li><a href="./documentation.html">Documentation</a></li>
               <li><a href="./examples-trunk/index.html">Examples</a></li>
               <li><a href="./support.html">Support</a></li>
               <li><a href="./contribute.html">Contribute</a></li>
               <li><a href="./security/index.html">Security</a></li>
           </ul>

             <!-- Google CSE Search Box Begins  -->
             <FORM class="pull-right" 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 size="18" width="130" style="width:130px" name="q" type="text" placeholder="Search">
             </FORM>
             <!--<SCRIPT type="text/javascript" src="http://www.google.com/coop/cse/brand?form=searchbox_010475492895890475512:_t4iqjrgx90"></SCRIPT>-->
             <!-- Google CSE Search Box Ends -->
         </div>
       </div>
     </div>

     <div class="container">


 <div class="page-header">
     <small><a href="./index.html">Home</a></small><br>
     <h1>Configuring DataSources in tomee.xml

         <div style="float: right; position: relative; bottom: -10px; ">
             <a onclick="javascript:gpshare()" class="gp-share sprite" title="Share on Google+">share [gp]</a>
             <a onclick="javascript:fbshare()" class="fb-share sprite" title="Share on Facebook">share [fb]</a>
             <a onclick="javascript:twshare()" class="tw-share sprite" title="Share on Twitter">share [tw]</a>
             <a onclick="javascript:pinshare()" class="pin-share sprite" title="Share on Pinterest">share [pin]</a>
             <a data-toggle="modal" href="#edit" class="edit-page" title="Contribute to this Page">contribute</a>
         </div>
     </h1>
 </div>

 <p><a name="ConfiguringDataSources-ConfiguringDataSourcesinopenejb.xml"></a></p>

 <p>The <em><Resource></em> element is used to configure a <em>javax.sql.DataSource</em>. It
 is also used to configure other resources like Timers, Topics, Queues.  We
 will see some examples of using <Resource> to configure a DataSource.</p>

 <p>The <Resource> element is designed after @Resource annotation and has
 similar attributes.</p>

 <p>For example, this annotation in your bean:</p>

 <pre><code>@Resource(name = "myDerbyDatasource", type = javax.sql.DataSource.class)
 </code></pre>

 <p>Would map to a Resource declared in your openejb.xml as follows:</p>

 <pre><code>&lt;Resource id="myDerbyDatasource" type="javax.sql.DataSource"&gt;
  . . . .
 &lt;Resource&gt;
 </code></pre>

 <p>Note that in the xml element, the <em>type</em> value of <em>javax.sql.DataSource</em>
 can abbreviated to just <em>DataSource</em> as follows:</p>

 <pre><code>&lt;Resource id="myDerbyDatasource" type="DataSource"&gt;
  . . . .
 &lt;Resource&gt;
 </code></pre>

 <p>It is also possible to specify the path to the driver jar file using a classpath attribute like so: </p>

 <pre><code>&lt;Resource id="myDerbyDatasource" type="DataSource" classpath="/path/to/driver.jar"&gt;
  . . . .
 &lt;Resource&gt;
 </code></pre>

 <p>...Or in a <a href="http://maven.apache.org/">Maven</a> environment like so:</p>

 <pre><code>&lt;Resource id="myDerbyDatasource" type="DataSource" classpath="mvn:org.apache.derby:derby:10.10.1.1"&gt;
  . . . .
 &lt;Resource&gt;
 </code></pre>

 <p>See <a href="containers-and-resources.html">Containers and Resources</a>
  for a complete list of supported DataSource properties.</p>

 <p>See <a href="datasource-password-encryption.html">DataSource Password Encryption</a>
  for information on specifying non-plain-text database passwords in your openejb.xml file.</p>

 <p>See <a href="common-datasource-configurations.html">Common DataSource Configurations</a>
  for a list of the commonly used databases and their driver configurations.</p>

 <p>See <a href="datasource-configuration-by-creator.html">DataSource Configuration by Creator</a>
  for a list of the different properties supported for each data source creator.</p>

 <p>You may also need data partitioning per customer or depending on any other
 business criteria. That's also an available feature. See <a href="dynamic-datasource.html">Dynamic Datasource</a> for more details.</p>

 <p><a name="ConfiguringDataSources-JNDInamesforconfiguredDataSources"></a></p>

 <h2>JNDI names for configured DataSources</h2>

 <p><a name="ConfiguringDataSources-Example1"></a></p>

 <h3>Example 1</h3>

 <pre><code>&lt;Resource id="Default JDBC Database" type="DataSource"&gt;
    . . . . .
 &lt;/Resource&gt;
 </code></pre>

 <p>The global jndi name would be <em>java:openejb/Resource/Default JDBC Database</em></p>

 <p><a name="ConfiguringDataSources-Example2"></a></p>

 <h3>Example 2</h3>

 <pre><code>&lt;Resource id="Derby Database"  type="DataSource"&gt;
   . . . . .
 &lt;/Resource&gt;
 </code></pre>

 <p>The global jndi name would be <em>java:openejb/Resource/Derby Database</em></p>

 <p><a name="ConfiguringDataSources-ObtainingaDataSource"></a></p>

 <h2>Obtaining a DataSource</h2>

 <p>DataSource references in your ejb should get automatically mapped to the
 Resource you declare.  The shortest and easiest rule is that <em>if your
 reference name matches a Resource in your openejb.xml, that's the one you
 get</em>.&nbsp; Essentially, the rules for mapping are as follows.</p>

 <ol>
 <li>Name Attribute Match - @Resource with a name attribute matching the
 resource name gets that resource injected</li>
 <li>Injected Name Match - variable name matching the resource name gets that
 resource injected</li>
 <li>No Match - nothing matches a resource name, so the first resource
 available gets injected</li>
 </ol>

 <p>There are various ways one could obtain a DataSource now.  Lets take an
 example of Derby.</p>

 <p>With a Resource declaration in your openejb.xml like this:</p>

 <pre><code>&lt;Resource id="myDerbyDatabase"  type="DataSource"&gt;
   . . . . .
 &lt;/Resource&gt;
 </code></pre>

 <p>There are several possible ways to refer to it, as follows.</p>

 <p><em>BY matching variable name to resource name</em></p>

 <pre><code>@Stateless
 public class FooBean {
     @Resource DataSource myDerbyDatabase;
 }
 </code></pre>

 <p><em>OR BY matching name</em></p>

 <pre><code>@Stateless
 public class FooBean {
     @Resource(name="myDerbyDatabase")
     DataSource dataSource;
 }
 </code></pre>

 <p><em>OR BY JNDI lookup</em></p>

 <pre><code>@Resource(name="myDerbyDatabase", type=javax.sql.DataSource.class)
 @Stateless
 public class FooBean {

     public void setSessionContext(SessionContext sessionContext) {
         DataSource dataSource = (DataSource)
         sessionContext.lookup("myDerbyDatabase");
     }

     public void someOtherMethod() throws Exception {
         InitialContext initialContext = new InitialContext();
         DataSource dataSource = (DataSource)
         initialContext.lookup("java:comp/env/myDerbyDatabase");
     }
 }
 </code></pre>

 <p><em>OR</em></p>

 <pre><code>&lt;resource-ref&gt;
   &lt;res-ref-name&gt;myDerbyDatabase&lt;/res-ref-name&gt;
   &lt;res-type&gt;javax.sql.DataSource&lt;/res-type&gt;
 &lt;/resource-ref&gt;
 </code></pre>

 <p><em>OR</em></p>

 <pre><code>&lt;resource-ref&gt;
    &lt;res-ref-name&gt;jdbc/myDerbyDatabase&lt;/res-ref-name&gt;
    &lt;res-type&gt;javax.sql.DataSource&lt;/res-type&gt;
 &lt;/resource-ref&gt;
 </code></pre>

 <p><em>OR</em></p>

 <pre><code>&lt;resource-ref&gt;
    &lt;res-ref-name&gt;someOtherName&lt;/res-ref-name&gt;
    &lt;res-type&gt;javax.sql.DataSource&lt;/res-type&gt;
    &lt;mapped-name&gt;myDerbyDatabase&lt;/mapped-name&gt;
 &lt;/resource-ref&gt;
 </code></pre>


         <div id="edit" class="modal hide fade in" style="display: none; ">
             <div class="modal-header">
                 <a class="close" data-dismiss="modal">x</a>

                 <h3>Thank you for contributing to the documentation!</h3>
             </div>
             <div class="modal-body">
                 <h4>Any help with the documentation is greatly appreciated.</h4>
                 <p>All edits are reviewed before going live, so feel free to do much more than fix typos or links.  If you see a page that could benefit from an entire rewrite, we'd be thrilled to review it.  Don't be surprised if we like it so much we ask you for help with other pages :)</p>
                 <small>NOTICE: unless indicated otherwise on the pages in question, all editable content available from apache.org is presumed to be licensed under the Apache License (AL) version 2.0 and hence all submissions to apache.org treated as formal Contributions under the license terms.</small>
                 <!--[if gt IE 6]>
                 <h4>Internet Explorer Users</h4>
                 <p>If you are not an Apache committer, click the Yes link and enter a <i>anonymous</i> for the username and leave the password empty</p>
                 <![endif]-->

             </div>
             <div class="modal-footer">
                 Do you have an Apache ID?
                 <a href="javascript:void(location.href='https://cms.apache.org/redirect?uri='+escape(location.href))" class="btn">Yes</a>
                 <a href="javascript:void(location.href='https://anonymous:@cms.apache.org/redirect?uri='+escape(location.href))" class="btn">No</a>
             </div>
         </div>
         <script src="./resources/js/bootstrap-modal.js"></script>

         <footer>
             <p>Copyright &copy; 1999-2016 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
                 Apache TomEE, TomEE, Apache, the Apache feather logo, and the Apache TomEE project logo are trademarks of The Apache Software Foundation.
                 All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p>
         </footer>

     </div> <!-- /container -->

     <!-- Javascript
     ================================================== -->
     <!-- Placed at the end of the document so the pages load faster -->
     <script src="./resources/js/bootstrap-dropdown.js"></script>

   </body>
 </html>
	<!DOCTYPE html>
	<html lang="en">
	<head>

	<meta charset="UTF-8">
	<title>Configuring DataSources in tomee.xml</title>
	<meta name="description" content="Apache TomEE">
	<meta name="author" content="Apache TomEE">
	<meta name="google-translate-customization" content="f36a520c08f4c9-0a04e86a9c075ce9-g265f3196f697cf8f-10">
	<meta http-equiv="Pragma" content="no-cache">
	<meta http-equiv="Expires" content="0">
	<meta http-equiv="Cache-Control" content="no-store, no-cache, must-revalidate, max-age=0">

	<!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
	<!--[if lt IE 9]>
	<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->

	<!-- Le styles -->
	<link href="./resources/css/bootstrap.css" rel="stylesheet">
	<link href="./resources/css/prettify.css" rel="stylesheet">
	<!--link href="./resources/css/bootstrap-mods.css" rel="stylesheet"-->
	<link href="./resources/css/main.css" rel="stylesheet">
	<link href="./resources/font-awesome-4.6.3/css/font-awesome.min.css" rel="stylesheet">

	<script type="text/javascript">
	var t = encodeURIComponent(document.title.replace(/^\s+\|\s+$/g,""));
	var u = encodeURIComponent(""+document.URL);

	function fbshare () {
	window.open(
	"http://www.facebook.com/sharer/sharer.php?u="+u,
	'Share on Facebook',
	'width=640,height=426');
	};
	function gpshare () {
	window.open(
	"https://plus.google.com/share?url="+u,
	'Share on Google+',
	'width=584,height=385');
	};
	function twshare () {
	window.open(
	"https://twitter.com/intent/tweet?url="+u+"&text="+t,
	'Share on Twitter',
	'width=800,height=526');
	};
	function pinshare () {
	window.open("//www.pinterest.com/pin/create/button/?url="+u+"&media=http%3A%2F%2Ftomee.apache.org%2Fresources%2Fimages%2Ffeather-logo.png&description="+t,
	'Share on Pinterest',
	'width=800,height=526');
	};
	</script>

	<!-- Le fav and touch icons -->
	<link rel="shortcut icon" href="./favicon.ico">
	<link rel="apple-touch-icon" href="./resources/images/apple-touch-icon.png">
	<link rel="apple-touch-icon" sizes="72x72" href="./resources/images/apple-touch-icon-72x72.png">
	<link rel="apple-touch-icon" sizes="114x114" href="./resources/images/apple-touch-icon-114x114.png">

	<script src="./resources/js/prettify.js" type="text/javascript"></script>
	<script src="./resources/js/jquery-latest.js"></script>
	<script src="http://platform.twitter.com/widgets.js" type="text/javascript"></script>
	<script src="./resources/js/common.js"></script>
	<script src="./resources/js/prettyprint.js"></script>
	<!--script src="//assets.pinterest.com/js/pinit.js" type="text/javascript" async></script//-->

	<script type="text/javascript">

	var _gaq = _gaq \|\| [];
	_gaq.push(['_setAccount', 'UA-2717626-1']);
	_gaq.push(['_setDomainName', 'apache.org']);
	_gaq.push(['_trackPageview']);

	(function() {
	var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
	ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
	var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
	})();

	</script>
	</head>

	<body>

	<div class="topbar" data-dropdown="dropdown">
	<div class="fill">
	<div class="container">
	<a class="brand" href="./index.html">Apache TomEE</a>
	<ul class="nav">
	<li class="dropdown">
	<a class="dropdown-toggle" data-toggle="dropdown" href="#">
	Apache
	<b class="caret"></b>
	</a>
	<ul class="dropdown-menu">
	<!-- <li><a href="./misc/whoweare.html">Who we are?</a></li> -->
	<!-- <li><a href="./misc/heritage.html">Heritage</a></li> -->
	<li><a href="http://www.apache.org">Apache Home</a></li>
	<!-- <li><a href="./misc/resources.html">Resources</a></li> -->
	<li><a href="./misc/contact.html">Contact</a></li>
	<li><a href="./misc/legal.html">Legal</a></li>
	<li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
	<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
	<li class="divider"/>
	<li><a href="http://www.apache.org/security">Security</a></li>
	</ul>
	</li>
	<li><a href="./index.html">Home</a></li>
	<li><a href="./downloads.html">Downloads</a></li>
	<li><a href="./documentation.html">Documentation</a></li>
	<li><a href="./examples-trunk/index.html">Examples</a></li>
	<li><a href="./support.html">Support</a></li>
	<li><a href="./contribute.html">Contribute</a></li>
	<li><a href="./security/index.html">Security</a></li>
	</ul>

	<!-- Google CSE Search Box Begins -->
	<FORM class="pull-right" 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 size="18" width="130" style="width:130px" name="q" type="text" placeholder="Search">
	</FORM>
	<!--<SCRIPT type="text/javascript" src="http://www.google.com/coop/cse/brand?form=searchbox_010475492895890475512:_t4iqjrgx90"></SCRIPT>-->
	<!-- Google CSE Search Box Ends -->
	</div>
	</div>
	</div>

	<div class="container">


	<div class="page-header">
	<small><a href="./index.html">Home</a></small><br>
	<h1>Configuring DataSources in tomee.xml

	<div style="float: right; position: relative; bottom: -10px; ">
	<a onclick="javascript:gpshare()" class="gp-share sprite" title="Share on Google+">share [gp]</a>
	<a onclick="javascript:fbshare()" class="fb-share sprite" title="Share on Facebook">share [fb]</a>
	<a onclick="javascript:twshare()" class="tw-share sprite" title="Share on Twitter">share [tw]</a>
	<a onclick="javascript:pinshare()" class="pin-share sprite" title="Share on Pinterest">share [pin]</a>
	<a data-toggle="modal" href="#edit" class="edit-page" title="Contribute to this Page">contribute</a>
	</div>
	</h1>
	</div>

	<p><a name="ConfiguringDataSources-ConfiguringDataSourcesinopenejb.xml"></a></p>

	<p>The <em><Resource></em> element is used to configure a <em>javax.sql.DataSource</em>. It
	is also used to configure other resources like Timers, Topics, Queues. We
	will see some examples of using <Resource> to configure a DataSource.</p>

	<p>The <Resource> element is designed after @Resource annotation and has
	similar attributes.</p>

	<p>For example, this annotation in your bean:</p>

	<pre><code>@Resource(name = "myDerbyDatasource", type = javax.sql.DataSource.class)
	</code></pre>

	<p>Would map to a Resource declared in your openejb.xml as follows:</p>

	<pre><code><Resource id="myDerbyDatasource" type="javax.sql.DataSource">
	. . . .
	<Resource>
	</code></pre>

	<p>Note that in the xml element, the <em>type</em> value of <em>javax.sql.DataSource</em>
	can abbreviated to just <em>DataSource</em> as follows:</p>

	<pre><code><Resource id="myDerbyDatasource" type="DataSource">
	. . . .
	<Resource>
	</code></pre>

	<p>It is also possible to specify the path to the driver jar file using a classpath attribute like so: </p>

	<pre><code><Resource id="myDerbyDatasource" type="DataSource" classpath="/path/to/driver.jar">
	. . . .
	<Resource>
	</code></pre>

	<p>...Or in a <a href="http://maven.apache.org/">Maven</a> environment like so:</p>

	<pre><code><Resource id="myDerbyDatasource" type="DataSource" classpath="mvn:org.apache.derby:derby:10.10.1.1">
	. . . .
	<Resource>
	</code></pre>

	<p>See <a href="containers-and-resources.html">Containers and Resources</a>
	for a complete list of supported DataSource properties.</p>

	<p>See <a href="datasource-password-encryption.html">DataSource Password Encryption</a>
	for information on specifying non-plain-text database passwords in your openejb.xml file.</p>

	<p>See <a href="common-datasource-configurations.html">Common DataSource Configurations</a>
	for a list of the commonly used databases and their driver configurations.</p>

	<p>See <a href="datasource-configuration-by-creator.html">DataSource Configuration by Creator</a>
	for a list of the different properties supported for each data source creator.</p>

	<p>You may also need data partitioning per customer or depending on any other
	business criteria. That's also an available feature. See <a href="dynamic-datasource.html">Dynamic Datasource</a> for more details.</p>

	<p><a name="ConfiguringDataSources-JNDInamesforconfiguredDataSources"></a></p>

	<h2>JNDI names for configured DataSources</h2>

	<p><a name="ConfiguringDataSources-Example1"></a></p>

	<h3>Example 1</h3>

	<pre><code><Resource id="Default JDBC Database" type="DataSource">
	. . . . .
	</Resource>
	</code></pre>

	<p>The global jndi name would be <em>java:openejb/Resource/Default JDBC Database</em></p>

	<p><a name="ConfiguringDataSources-Example2"></a></p>

	<h3>Example 2</h3>

	<pre><code><Resource id="Derby Database" type="DataSource">
	. . . . .
	</Resource>
	</code></pre>

	<p>The global jndi name would be <em>java:openejb/Resource/Derby Database</em></p>

	<p><a name="ConfiguringDataSources-ObtainingaDataSource"></a></p>

	<h2>Obtaining a DataSource</h2>

	<p>DataSource references in your ejb should get automatically mapped to the
	Resource you declare. The shortest and easiest rule is that <em>if your
	reference name matches a Resource in your openejb.xml, that's the one you
	get</em>.  Essentially, the rules for mapping are as follows.</p>

	<ol>
	<li>Name Attribute Match - @Resource with a name attribute matching the
	resource name gets that resource injected</li>
	<li>Injected Name Match - variable name matching the resource name gets that
	resource injected</li>
	<li>No Match - nothing matches a resource name, so the first resource
	available gets injected</li>
	</ol>

	<p>There are various ways one could obtain a DataSource now. Lets take an
	example of Derby.</p>

	<p>With a Resource declaration in your openejb.xml like this:</p>

	<pre><code><Resource id="myDerbyDatabase" type="DataSource">
	. . . . .
	</Resource>
	</code></pre>

	<p>There are several possible ways to refer to it, as follows.</p>

	<p><em>BY matching variable name to resource name</em></p>

	<pre><code>@Stateless
	public class FooBean {
	@Resource DataSource myDerbyDatabase;
	}
	</code></pre>

	<p><em>OR BY matching name</em></p>

	<pre><code>@Stateless
	public class FooBean {
	@Resource(name="myDerbyDatabase")
	DataSource dataSource;
	}
	</code></pre>

	<p><em>OR BY JNDI lookup</em></p>

	<pre><code>@Resource(name="myDerbyDatabase", type=javax.sql.DataSource.class)
	@Stateless
	public class FooBean {

	public void setSessionContext(SessionContext sessionContext) {
	DataSource dataSource = (DataSource)
	sessionContext.lookup("myDerbyDatabase");
	}

	public void someOtherMethod() throws Exception {
	InitialContext initialContext = new InitialContext();
	DataSource dataSource = (DataSource)
	initialContext.lookup("java:comp/env/myDerbyDatabase");
	}
	}
	</code></pre>

	<p><em>OR</em></p>

	<pre><code><resource-ref>
	<res-ref-name>myDerbyDatabase</res-ref-name>
	<res-type>javax.sql.DataSource</res-type>
	</resource-ref>
	</code></pre>

	<p><em>OR</em></p>

	<pre><code><resource-ref>
	<res-ref-name>jdbc/myDerbyDatabase</res-ref-name>
	<res-type>javax.sql.DataSource</res-type>
	</resource-ref>
	</code></pre>

	<p><em>OR</em></p>

	<pre><code><resource-ref>
	<res-ref-name>someOtherName</res-ref-name>
	<res-type>javax.sql.DataSource</res-type>
	<mapped-name>myDerbyDatabase</mapped-name>
	</resource-ref>
	</code></pre>




	<div id="edit" class="modal hide fade in" style="display: none; ">
	<div class="modal-header">
	<a class="close" data-dismiss="modal">x</a>

	<h3>Thank you for contributing to the documentation!</h3>
	</div>
	<div class="modal-body">
	<h4>Any help with the documentation is greatly appreciated.</h4>
	<p>All edits are reviewed before going live, so feel free to do much more than fix typos or links. If you see a page that could benefit from an entire rewrite, we'd be thrilled to review it. Don't be surprised if we like it so much we ask you for help with other pages :)</p>
	<small>NOTICE: unless indicated otherwise on the pages in question, all editable content available from apache.org is presumed to be licensed under the Apache License (AL) version 2.0 and hence all submissions to apache.org treated as formal Contributions under the license terms.</small>
	<!--[if gt IE 6]>
	<h4>Internet Explorer Users</h4>
	<p>If you are not an Apache committer, click the Yes link and enter a <i>anonymous</i> for the username and leave the password empty</p>
	<![endif]-->

	</div>
	<div class="modal-footer">
	Do you have an Apache ID?
	<a href="javascript:void(location.href='https://cms.apache.org/redirect?uri='+escape(location.href))" class="btn">Yes</a>
	<a href="javascript:void(location.href='https://anonymous:@cms.apache.org/redirect?uri='+escape(location.href))" class="btn">No</a>
	</div>
	</div>
	<script src="./resources/js/bootstrap-modal.js"></script>

	<footer>
	<p>Copyright © 1999-2016 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
	Apache TomEE, TomEE, Apache, the Apache feather logo, and the Apache TomEE project logo are trademarks of The Apache Software Foundation.
	All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p>
	</footer>

	</div> <!-- /container -->

	<!-- Javascript
	================================================== -->
	<!-- Placed at the end of the document so the pages load faster -->
	<script src="./resources/js/bootstrap-dropdown.js"></script>

	</body>
	</html>