Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Jetty/Reference/jetty-env.xml



Introduction

jetty-env.xml is an optional Jetty configuration file which configures webapp-specific JNDI resources. 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-env.xml configuration file. For a more in-depth look at the syntax, see jetty.xml Syntax Reference.

Root Element

jetty-env.xml is applied 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 "-//Mort Bay Consulting//DTD Configure//EN" "http://www.eclipse.org/jetty/configure.dtd">
 
<Configure class="org.eclipse.jetty.webapp.WebAppContext">
 ..
</Configure>
Warning

Make sure you are applying the configuration to an instance of the proper class. jetty-env.xml configures an instance of WebAppContext, and not an instance of Server


Using jetty-env.xml

Place the jetty-env.xml file into your web application's WEB-INF folder. When Jetty deploys a web application, it automatically looks for a file called WEB-INF/jetty-env.xml within the web application (or WAR), and sets up the webapp naming environment so that naming references in the WEB-INF/web.xml file can be resolved from the information provided in the WEB-INF/jetty-env.xml and Jetty/Reference/jetty.xml files.

jetty-env.xml files contain configuration specific to a webapp. Global naming resources should be defined on the server via jetty.xml.

Additional Resources

Back to the top