| <html><head> |
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <title>Configuring a Specific Web Application Deployment</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, spdy, websocket, eclipse, maven, java, server, software"><link rel="home" href="index.html" title="Jetty : The Definitive Reference"><link rel="up" href="configuring-deployment.html" title="Chapter 4. Deploying to Jetty"><link rel="prev" href="automatic-webapp-deployment.html" title="Automatic Web Application Deployment"><link rel="next" href="configuring-webapps.html" title="Deployment Processing of WebAppContexts"><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.2.21.v20170120</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">Configuring a Specific Web Application Deployment</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="automatic-webapp-deployment.html"><i class="icon-chevron-left"></i> Previous</a> </td><th width="60%" align="center">Chapter 4. Deploying to Jetty<br><a accesskey="p" href="index.html"><i class="icon-home"></i> Home</a></th><td width="20%" align="right"> <a accesskey="n" href="configuring-webapps.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="configuring-specific-webapp-deployment"></a>Configuring a Specific Web Application Deployment</h2></div></div></div><div class="toc"><dl><dt><span class="section"><a href="configuring-specific-webapp-deployment.html#deployable-descriptor-file">Jetty Deployable Descriptor XML File</a></span></dt></dl></div><p>Using the Automatic Web Application Deployment model is quick and |
| easy, but sometimes you might need to tune certain deployment properties |
| (for example, you want to deploy with a context path that is not based on |
| the file name, or you want to define a special database connection pool just |
| for this web application). You can use a <a class="xref" href="configuring-specific-webapp-deployment.html#deployable-descriptor-file" title="Jetty Deployable Descriptor XML File">Jetty Deployable Descriptor XML File</a> to accomplish such tuning.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="deployable-descriptor-file"></a>Jetty Deployable Descriptor XML File</h3></div></div></div><p>Jetty supports deploying Web Applications via XML files which will |
| build an instance of a <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/server/handler/ContextHandler.html" target="_top">ContextHandler</a> |
| that Jetty can then deploy.</p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="using-basic-descriptor-files"></a>Using Basic Descriptor Files</h4></div></div></div><p>In a default Jetty installation, Jetty scans its |
| <code class="filename">$JETTY_HOME/webapps</code> directory for context |
| deployment descriptor files. To deploy a web application using such a |
| file, simply place the file in that directory.</p><p>The deployment descriptor file itself is an xml file that |
| configures a <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/webapp/WebAppContext.html" target="_top"><code class="code">WebAppContext</code></a> |
| class. For a basic installation you probably need to set only two |
| properties:</p><div class="variablelist"><dl><dt><span class="term">war</span></dt><dd><p>the filesystem path to the web application file (or |
| directory)</p></dd><dt><span class="term">contextPath</span></dt><dd><p>the context path to use for the web application</p></dd></dl></div><p>For example, here is a descriptor file that deploys the file |
| <code class="filename">/opt/myapp/myapp.war</code> to the context path |
| <code class="filename">/wiki</code>:</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[<?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_0.dtd"> |
| |
| <Configure class="org.eclipse.jetty.webapp.WebAppContext"> |
| <Set name="contextPath">/wiki</Set> |
| <Set name="war">/opt/myapp/myapp.war</Set> |
| </Configure> ]]> |
| </script></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="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><i class="icon-asterisk"></i> Note</h3><p>You can use the <code class="code">SystemProperty</code> and |
| <code class="code">Property</code> elements in your descriptor file. For example, |
| if you set the system property <code class="code">myapp.home=/opt/myapp</code>, you |
| can rewrite the previous example as:</p></div><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[<?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_0.dtd"> |
| |
| <Configure class="org.eclipse.jetty.webapp.WebAppContext"> |
| <Set name="contextPath">/wiki</Set> |
| <Set name="war"><SystemProperty name="myapp.home"/>/myapp.war</Set> |
| </Configure>]]> |
| </script></div><p>If you need to change the home path for your application, you can |
| simply change the system property. This is useful if you frequently |
| switch among multiple versions of an app.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="configuring-advanced-descriptor-files"></a>Configuring Advanced Descriptor Files</h4></div></div></div><p>If you look at the documentation for the <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/webapp/WebAppContext.html" target="_top"><code class="code">WebAppContext</code></a> |
| class, you notice that there are a lot more properties than just the two |
| mentioned above. Here are some examples that configure advanced options |
| with your descriptor file.</p><p>This first example tells Jetty not to expand the WAR file when |
| deploying it. This can help make it clear that people should not be |
| making changes to the temporary unpacked WAR because such changes do not |
| persist, and therefore do not apply the next time the web application |
| deploys.</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[<?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_0.dtd"> |
| |
| <Configure class="org.eclipse.jetty.webapp.WebAppContext"> |
| <Set name="contextPath">/wiki</Set> |
| <Set name="war"><SystemProperty name="myapp.home"/>/myapp.war</Set> |
| <Set name="extractWAR">false</Set> |
| </Configure> ]]> |
| </script></div><p>The next example retrieves the JavaEE Servlet context and sets an |
| initialization parameter on it. You can also use the |
| <code class="code">setAttribute</code> method to set a Servlet context attribute. |
| However, since the <code class="filename"> web.xml</code> for the web application |
| is processed after the deployment descriptor, the <code class="filename"> |
| web.xml</code> values overwrite identically named attributes from |
| the deployment descriptor.</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[<?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_0.dtd"> |
| |
| <Configure class="org.eclipse.jetty.webapp.WebAppContext"> |
| <Set name="contextPath">/wiki</Set> |
| <Set name="war"><SystemProperty name="myapp.home"/>/myapp.war</Set> |
| <Get name="ServletContext"> |
| <Call name="setInitParameter"> |
| <Arg>myapp.config</Arg> |
| <Arg><SystemProperty name="myapp.home">/config/app-config.xml</Arg> |
| </Call> |
| </Get> |
| </Configure> ]]> |
| </script></div><p>The following example sets a special <code class="filename">web.xml</code> |
| override descriptor. This descriptor is processed after the web |
| application's <code class="filename">web.xml</code>, so it may override |
| identically named attributes. This feature is useful if you want to add |
| parameters or additional Servlet mappings without breaking open a packed |
| WAR file.</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[<?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_0.dtd"> |
| |
| <Configure class="org.eclipse.jetty.webapp.WebAppContext"> |
| <Set name="contextPath">/wiki</Set> |
| <Set name="war"><SystemProperty name="myapp.home"/>/myapp.war</Set> |
| <Set name="overrideDescriptor">/opt/myapp/overlay-web.xml</Set> |
| </Configure> ]]> |
| </script></div><p>The next example configures not only the web application context, |
| but also a database connection pool (see <a class="xref" href="jndi-datasource-examples.html" title="Datasource Examples">Datasource Examples</a> that our application can then use. |
| If the <code class="filename"> web.xml</code> does not include a reference to |
| this data source, you can use the override descriptor mechanism (the |
| previous example), to include it.</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[<?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_0.dtd"> |
| |
| <Configure class="org.eclipse.jetty.webapp.WebAppContext"> |
| <Set name="contextPath">/wiki</Set> |
| <Set name="war"><SystemProperty name="myapp.home"/>/myapp.war</Set> |
| |
| <New id="DSTest" class="org.eclipse.jetty.plus.jndi.Resource"> |
| <Arg></Arg> |
| <Arg>jdbc/DSTest</Arg> |
| <Arg> |
| <New class="org.apache.commons.dbcp.BasicDataSource"> |
| <Set name="driverClassName">org.some.Driver</Set> |
| <Set name="url">jdbc.url</Set> |
| <Set name="username">jdbc.user</Set> |
| <Set name="password">jdbc.pass</Set> |
| </New> |
| </Arg> |
| </New> |
| </Configure>]]> |
| </script></div><p>There are many other settings that you can change on a <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/webapp/WebAppContext.html" target="_top"><code class="code">WebAppContext</code></a>. |
| The <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/webapp/WebAppContext.html" target="_top">javadoc</a> |
| for WebAppContext is a good source of information. Also see the |
| documentation on <a class="link" href="troubleshooting.html#troubleshooting-zip-exceptions" title="Troubleshooting Zip Exceptions">avoiding |
| zip file exceptions</a> for a description of WebAppContext settings |
| that determine such things as whether or not the war is automatically |
| unpacked during deployment, or whether certain sections of a webapp are |
| copied to a temporary location.</p></div></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="automatic-webapp-deployment.html"><i class="icon-chevron-left"></i> Previous</a> </td><td width="20%" align="center"><a accesskey="u" href="configuring-deployment.html"><i class="icon-chevron-up"></i> Top</a></td><td width="40%" align="right"> <a accesskey="n" href="configuring-webapps.html">Next <i class="icon-chevron-right"></i></a></td></tr><tr><td width="40%" align="left" valign="top">Automatic Web Application Deployment </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"> Deployment Processing of WebAppContexts</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-03-13T11:47:48-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> |
