Jump to: navigation, search

Difference between revisions of "Jetty/Reference/webdefault.xml"

Line 77: Line 77:
  
 
| more =  
 
| more =  
* [[Jetty/References/Syntax Reference|Syntax Reference]] - in-depth reference for Jetty-specific configuration XML syntax
+
* [[Jetty/References/override-web.xml|override-web.xml]] web.xml-formatted file, applied after the webapp's web.xml
* [[Jetty/References/jetty.xml|jetty.xml]] - configuration file for configuring the entire server
+
 
}}
 
}}

Revision as of 06:23, 26 June 2009



Introduction

webdefault.xml is a file which is applied to a web application before the application's own WEB-INF/web.xml. It is used to save a web application from having to define a lot of house-keeping and container-specific elements in their own web.xml files, and uses the same syntax as a web.xml file. It can be found in $(jetty.home)/etc/webdefault.xml for the Jetty distribution.

Using webdefault.xml / Customizing webdefault.xml

Using webdefault.xml

The distribution's webdefault.xml can be found at $JETTY_HOME/etc/webdefault.xml. You may specify another configuration file to be used for specific webapps, or for all webapps (see below). If you do not specify an alternate defaults descriptor, the distribution's webdefault.xml will automatically be used.

Jetty Standalone

Custom webdefault.xml for One Webapp

You can modify any of the settings inside the version of webdefault.xml shipped in the Jetty distribution, and apply this custom configuration to an individual web application, by configuring it through the webapp's jetty-web.xml.

<Configure class="org.eclipse.jetty.webapp.WebAppContext">
  ...
  <!-- Set up the absolute path to the custom webdefault.xml -->
  <Set name="defaultsDescriptor">/my/path/to/webdefault.xml</Set>
  ...
</Configure>

The equivalent in code is:

import org.eclipse.jetty.webapp.WebAppContext;
 
    ...
 
    WebAppContext wac = new WebAppContext();
    ...
    //Set up the absolute path to the custom webdefault.xml.
    wac.setDefaultsDescriptor("/my/path/to/webdefault.xml");
    ...

Alternatively, you can use a classloader to find the resource representing your custom webdefault.xml.

Custom webdefault.xml for Multiple Webapps

If you want to apply the same custom webdefault.xml to a number of webapps, then supply the path to the file to the hot deployer or the static deployer in your Jetty/References/jetty.xml.

<Configure class="org.eclipse.jetty.webapp.WebAppContext">
    ...
    <New class="org.eclipse.jetty.deploy.WebAppDeployer">
        ...
        <Set name="defaultsDescriptor">/my/path/to/webdefault.xml</Set>
    </New>
    ...
</Configure>

Jetty Maven Plugin

Similarly, for the Jetty Maven Plugin, you provide a customized webdefault.xml file for your webapp by:

<project>
    ...
    <plugins>
        <plugin>
            ...
            <artifactId>jetty-maven-plugin</artifactId>
            <configuration>
                <webAppConfig>
                  ...
                  <defaultsDescriptor>/my/path/to/webdefault.xml</defaultsDescriptor>
                </webAppConfig>
            </configuration>
        </plugin>
        ...
    </plugins>
    ...
</project>

Additional Resources