View source for Jetty/Reference/jetty-web.xml

{{Jetty Reference
| introduction = 

{{Jetty Redirect|http://www.eclipse.org/jetty/documentation/current/jetty-web-xml-config.html}}

<tt>jetty-web.xml</tt> is a Jetty configuration file that you can bundle with a specific web application. The format of <tt>jetty-web.xml</tt> is the same as <tt>[[Jetty/Reference/jetty.xml|jetty.xml]]</tt> -- it is an XML mapping of the Jetty API.

This document offers an overview for using the <tt>jetty-web.xml</tt> configuration file. For a more in-depth look at the syntax, see [[Jetty/Reference/jetty.xml Syntax|jetty.xml Syntax Reference]]. 

| body = 

== Root Element ==
<tt>jetty-web.xml</tt> applies on a per-webapp basis, and configures an instance of <tt>org.eclipse.jetty.webapp.WebAppContext</tt>.

<source lang="xml">
<?xml version="1.0"  encoding="ISO-8859-1"?>
<!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure.dtd">

<Configure class="org.eclipse.jetty.webapp.WebAppContext">
 ..
</Configure>
</source>

{{caution|Make sure you are applying the configuration to an instance of the proper class|<tt>jetty-web.xml</tt> configures an instance of WebAppContext; <tt>jetty.xml</tt> configures an instance of Server.}}

== Using <tt>jetty-web.xml</tt> ==

Place the <tt>jetty-web.xml</tt> into your web application's <tt>WEB-INF</tt> folder. When Jetty deploys a web application, it looks for a file called <tt>WEB-INF/jetty-web.xml</tt> or <tt>WEB-INF/web-jetty.xml</tt> within the web application (or WAR) and applies the configuration found there. Be aware that <tt>jetty-web.xml</tt> is called ''after'' all other configuration has been applied to the web application.

== Examples == 

The distribution contains an example of <tt>jetty-web.xml</tt> inside the WEB-INF folder of the test webapp war (<tt>$JETTY_HOME/webapps/test.war/WEB-INF/jetty-web.xml</tt>).


| more = 
* [[Jetty/Reference/jetty.xml syntax|jetty.xml Syntax Reference]] - in-depth reference for Jetty-specific configuration XML syntax
* [[Jetty/Reference/jetty.xml|jetty.xml]] - configuration file for configuring the entire server

}}