Difference between revisions of "Jetty/Reference/jetty-web.xml"

Latest revision as of 15:42, 23 April 2013

Introduction

Jetty 7 and Jetty 8 are now EOL (End of Life)

THIS IS NOT THE DOCUMENTATION YOU ARE LOOKING FOR!!!!!

All development and stable releases are being performed with Jetty 9 and Jetty 10.

This wiki is now officially out of date and all content has been moved to the Jetty Documentation Hub

Direct Link to updated documentation: http://www.eclipse.org/jetty/documentation/current/jetty-web-xml-config.html

jetty-web.xml is a Jetty configuration file that you can bundle with a specific web application. The format of jetty-web.xml is the same as jetty.xml -- it is an XML mapping of the Jetty API.

This document offers an overview for using the jetty-web.xml configuration file. For a more in-depth look at the syntax, see jetty.xml Syntax Reference.

Root Element

jetty-web.xml applies on a per-webapp basis, and configures an instance of org.eclipse.jetty.webapp.WebAppContext.

<?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>

Make sure you are applying the configuration to an instance of the proper class
jetty-web.xml configures an instance of WebAppContext; jetty.xml configures an instance of Server.

Using `jetty-web.xml`

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

Examples

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

Additional Resources

jetty.xml Syntax Reference - in-depth reference for Jetty-specific configuration XML syntax
jetty.xml - configuration file for configuring the entire server

@@ Line 1: / Line 1: @@
 {{Jetty Reference
-| introduction = <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.
+| 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]].

Breadcrumbs