Version: 9.4.19.v20190610 |

jetty-env.xml
Previous | Chapter 32. Jetty XML Reference Home | Next

##### Contact the core Jetty developers at www.webtide.com

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 for sponsored feature development

## jetty-env.xml

`jetty-env.xml` is an optional Jetty file that configures JNDI resources for an individual webapp. The format of `jetty-env.xml` is the same as jetty.xml –it is an XML mapping of the Jetty API.

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.xml files. You define global naming resources on the server via `jetty.xml`.

### jetty-env.xml Root Element

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

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_3.dtd">

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

> ### Caution

> 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 in your web application’s WEB-INF folder.

     <?xml version="1.0"?>
     <!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_3.dtd">

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

       <!-- Add an EnvEntry only valid for this webapp               -->
       <New id="gargle"  class="org.eclipse.jetty.plus.jndi.EnvEntry">
         <Arg>gargle</Arg>
         <Arg type="java.lang.Double">100</Arg>
         <Arg type="boolean">true</Arg>
       </New>

      <!-- Add an override for a global EnvEntry                           -->
       <New id="wiggle"  class="org.eclipse.jetty.plus.jndi.EnvEntry">
         <Arg>wiggle</Arg>
         <Arg type="java.lang.Double">55.0</Arg>
         <Arg type="boolean">true</Arg>
       </New>

       <!-- an XADataSource                                                -->
       <New id="mydatasource99" class="org.eclipse.jetty.plus.jndi.Resource">
         <Arg>jdbc/mydatasource99</Arg>
         <Arg>
           <New class="com.atomikos.jdbc.SimpleDataSourceBean">
             <Set name="xaDataSourceClassName">org.apache.derby.jdbc.EmbeddedXADataSource</Set>
             <Set name="xaDataSourceProperties">databaseName=testdb99;createDatabase=create</Set>
             <Set name="UniqueResourceName">mydatasource99</Set>
           </New>
         </Arg>
       </New>

     </Configure>

### Additional jetty-env.xml Resources

- Jetty XML Syntax –In-depth reference for Jetty-specific configuration XML syntax.
- jetty.xml –Configuration file for configuring the entire server.

Previous | Top | Next
jetty-web.xml | Home | webdefault.xml

See an error or something missing? Contribute to this documentation at Github!(Generated: 2019-06-10)