| <html><head> |
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <title>Using JNDI with Jetty Embedded</title><link rel="stylesheet" type="text/css" href="css/docbook.css"><meta name="generator" content="DocBook XSL-NS Stylesheets V1.76.1"><meta name="keywords" content="jetty, servlet, servlet-api, cometd, http, websocket, eclipse, maven, java, server, software"><link rel="home" href="index.html" title="Jetty : The Definitive Reference"><link rel="up" href="jndi.html" title="Chapter 11. Configuring JNDI"><link rel="prev" href="jndi-configuration.html" title="Configuring JNDI"><link rel="next" href="jndi-datasource-examples.html" title="Datasource Examples"><link xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" rel="shortcut icon" href="images/favicon.ico"><script type="text/javascript" src="js/shCore.js"></script><script type="text/javascript" src="js/shBrushJava.js"></script><script type="text/javascript" src="js/shBrushXml.js"></script><script type="text/javascript" src="js/shBrushBash.js"></script><script type="text/javascript" src="js/shBrushJScript.js"></script><script type="text/javascript" src="js/shBrushSql.js"></script><script type="text/javascript" src="js/shBrushProperties.js"></script><script type="text/javascript" src="js/shBrushPlain.js"></script><link type="text/css" rel="stylesheet" href="css/shCore.css"><link type="text/css" rel="stylesheet" href="css/shThemeEclipse.css"><link type="text/css" rel="stylesheet" href="css/font-awesome.min.css"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times"><tr><td style="width: 25%"><a href="http://www.eclipse.org/jetty"><img src="images/jetty-header-logo.png" alt="Jetty Logo"></a><br><span style="font-size: small"> |
| Version: 9.3.0.v20150612</span></td><td style="width: 50%"><script type="text/javascript"> (function() { |
| var cx = '016459005284625897022:obd4lsai2ds'; |
| var gcse = document.createElement('script'); |
| gcse.type = 'text/javascript'; |
| gcse.async = true; |
| gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + |
| '//www.google.com/cse/cse.js?cx=' + cx; |
| var s = document.getElementsByTagName('script')[0]; |
| s.parentNode.insertBefore(gcse, s); |
| })(); |
| </script><gcse:search></gcse:search></td></tr></table><div xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Using JNDI with Jetty Embedded</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="jndi-configuration.html"><i class="icon-chevron-left"></i> Previous</a> </td><th width="60%" align="center">Chapter 11. Configuring JNDI<br><a accesskey="p" href="index.html"><i class="icon-home"></i> Home</a></th><td width="20%" align="right"> <a accesskey="n" href="jndi-datasource-examples.html">Next <i class="icon-chevron-right"></i></a></td></tr></table><hr></div><div xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" class="jetty-callout"><h5 class="callout"><a href="http://www.webtide.com/">Contact the core Jetty developers at |
| <span class="website">www.webtide.com</span></a></h5><p> |
| private support for your internal/customer projects ... custom extensions and distributions ... versioned snapshots for indefinite support ... |
| scalability guidance for your apps and Ajax/Comet projects ... development services from 1 day to full product delivery |
| </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="jndi-embedded"></a>Using JNDI with Jetty Embedded</h2></div></div></div><div class="toc"><dl><dt><span class="section"><a href="jndi-embedded.html#d0e10588">Setting up the Classpath</a></span></dt><dt><span class="section"><a href="jndi-embedded.html#d0e10617">Example Code</a></span></dt></dl></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d0e10588"></a>Setting up the Classpath</h3></div></div></div><p>In addition to the jars that you require for your application, and |
| the jars needed for core Jetty, you will need to place the following jars |
| onto your classpath:</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: plain;toolbar: false"> |
| <![CDATA[jetty-jndi.jar |
| jetty-plus.jar]]> |
| </script></div><p>If you are using transactions, you will also need the |
| javax.transaction api. You can <a class="link" href="http://download.eclipse.org/jetty/orbit/javax.transaction_1.1.1.v201004190952.jar/dist/" target="_top">obtain |
| this jar</a> from <a class="link" href="http://download.eclipse.org/jetty/orbit" target="_top">the Jetty dependencies |
| site.</a></p><p>If you wish to use mail, you will also need the javax.mail api and |
| implementation. You can <a class="link" href="http://download.eclipse.org/jetty/orbit/javax.mail.glassfish_1.4.1.v201005082020.jar/dist/" target="_top">obtain |
| this jar</a> from the<a class="link" href="http://download.eclipse.org/jetty/orbit/javax.mail.glassfish_1.4.1.v201005082020.jar/dist/" target="_top"> |
| Jetty dependencies site</a>. Note that this jar also requires the |
| javax.activation classes, which you can also <a class="link" href="http://download.eclipse.org/jetty/orbit/javax.activation_1.1.0.v201105071233.jar/dist/" target="_top">obtain</a> |
| from the <a class="link" href="http://download.eclipse.org/jetty/orbit/" target="_top">Jetty |
| dependencies site</a>.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d0e10617"></a>Example Code</h3></div></div></div><p>Here is an example class that sets up some JNDI entries and deploys |
| a webapp that references these JNDI entries in code. We'll use some mocked |
| up classes for the transaction manager and the DataSource in this example |
| for simplicity:</p><script type="syntaxhighlighter" class="brush: java;toolbar: false"> |
| <![CDATA[import java.util.Properties; |
| import org.eclipse.jetty.server.Server; |
| import org.eclipse.jetty.webapp.WebAppContext; |
| |
| /** |
| * ServerWithJNDI |
| * |
| * |
| */ |
| public class ServerWithJNDI |
| { |
| public static void main(String[] args) throws Exception |
| { |
| |
| //Create the server |
| Server server = new Server(8080); |
| |
| //Enable parsing of jndi-related parts of web.xml and jetty-env.xml |
| org.eclipse.jetty.webapp.Configuration.ClassList classlist = org.eclipse.jetty.webapp.Configuration.ClassList.setServerDefault(server); |
| classlist.addAfter("org.eclipse.jetty.webapp.FragmentConfiguration", "org.eclipse.jetty.plus.webapp.EnvConfiguration", "org.eclipse.jetty.plus.webapp.PlusConfiguration"); |
| |
| //Create a WebApp |
| WebAppContext webapp = new WebAppContext(); |
| webapp.setContextPath("/"); |
| webapp.setWar("./my-foo-webapp.war"); |
| server.setHandler(webapp); |
| |
| //Register new transaction manager in JNDI |
| //At runtime, the webapp accesses this as java:comp/UserTransaction |
| org.eclipse.jetty.plus.jndi.Transaction transactionMgr = new org.eclipse.jetty.plus.jndi.Transaction(new com.acme.MockUserTransaction()); |
| |
| //Define an env entry with Server scope. |
| //At runtime, the webapp accesses this as java:comp/env/woggle |
| //This is equivalent to putting an env-entry in web.xml: |
| //<env-entry> |
| // <env-entry-name>woggle</env-entry-name> |
| // <env-entry-type>java.lang.Integer</env-entry-type> |
| // <env-entry-value>4000</env-entry-value> |
| //</env-entry> |
| org.eclipse.jetty.plus.jndi.EnvEntry woggle = new org.eclipse.jetty.plus.jndi.EnvEntry(server, "woggle", new Integer(4000), false); |
| |
| |
| //Define an env entry with webapp scope. |
| //At runtime, the webapp accesses this as java:comp/env/wiggle |
| //This is equivalent to putting a web.xml entry in web.xml: |
| //<env-entry> |
| // <env-entry-name>wiggle</env-entry-name> |
| // <env-entry-value>100</env-entry-value> |
| // <env-entry-type>java.lang.Double</env-entry-type> |
| //</env-entry> |
| //Note that the last arg of "true" means that this definition for "wiggle" would override an entry of the |
| //same name in web.xml |
| org.eclipse.jetty.plus.jndi.EnvEntry wiggle = new org.eclipse.jetty.plus.jndi.EnvEntry(webapp, "wiggle", new Double(100), true); |
| |
| //Register a reference to a mail service scoped to the webapp. |
| //This must be linked to the webapp by an entry in web.xml: |
| // <resource-ref> |
| // <res-ref-name>mail/Session</res-ref-name> |
| // <res-type>javax.mail.Session</res-type> |
| // <res-auth>Container</res-auth> |
| // </resource-ref> |
| //At runtime the webapp accesses this as java:comp/env/mail/Session |
| org.eclipse.jetty.jndi.factories.MailSessionReference mailref = new org.eclipse.jetty.jndi.factories.MailSessionReference(); |
| mailref.setUser("CHANGE-ME"); |
| mailref.setPassword("CHANGE-ME"); |
| Properties props = new Properties(); |
| props.put("mail.smtp.auth", "false"); |
| props.put("mail.smtp.host","CHANGE-ME"); |
| props.put("mail.from","CHANGE-ME"); |
| props.put("mail.debug", "false"); |
| mailref.setProperties(props); |
| org.eclipse.jetty.plus.jndi.Resource xxxmail = new org.eclipse.jetty.plus.jndi.Resource(webapp, "mail/Session", mailref); |
| |
| |
| // Register a mock DataSource scoped to the webapp |
| //This must be linked to the webapp via an entry in web.xml: |
| //<resource-ref> |
| // <res-ref-name>jdbc/mydatasource</res-ref-name> |
| // <res-type>javax.sql.DataSource</res-type> |
| // <res-auth>Container</res-auth> |
| //</resource-ref> |
| //At runtime the webapp accesses this as java:comp/env/jdbc/mydatasource |
| org.eclipse.jetty.plus.jndi.Resource mydatasource = new org.eclipse.jetty.plus.jndi.Resource(webapp, "jdbc/mydatasource", |
| new com.acme.MockDataSource()); |
| |
| server.start(); |
| server.join(); |
| } |
| } |
| ]]> |
| </script></div></div><script type="text/javascript"> |
| SyntaxHighlighter.all() |
| </script><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="jndi-configuration.html"><i class="icon-chevron-left"></i> Previous</a> </td><td width="20%" align="center"><a accesskey="u" href="jndi.html"><i class="icon-chevron-up"></i> Top</a></td><td width="40%" align="right"> <a accesskey="n" href="jndi-datasource-examples.html">Next <i class="icon-chevron-right"></i></a></td></tr><tr><td width="40%" align="left" valign="top">Configuring JNDI </td><td width="20%" align="center"><a accesskey="h" href="index.html"><i class="icon-home"></i> Home</a></td><td width="40%" align="right" valign="top"> Datasource Examples</td></tr></table></div><p xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times"><div class="jetty-callout"> |
| See an error or something missing? |
| <span class="callout"><a href="http://github.com/jetty-project/jetty-documentation">Contribute to this documentation at |
| <span class="website"><i class="icon-github"></i> Github!</span></a></span><span style="float: right"><i>(Generated: 2015-06-15T13:18:21-05:00)</i></span></div></p><script xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-1149868-7']); |
| _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></body></html> |
