Jump to: navigation, search

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

m
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Jetty Reference
 
{{Jetty Reference
| introduction = <tt>webdefault.xml</tt> is a file which is applied to a web application ''before'' the application's own <tt>WEB-INF/web.xml</tt>. 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 [[Jetty/Reference/web.xml syntax|web.xml syntax]]. For example, you can use it to set up mime-type mappings and JSP servlet-mappings. Generally, it is convenient for all webapps in a Jetty instance to share the same <tt>webdefault.xml</tt> file. However, it is certainly possible to provide differentiated <tt>webdefault.xml</tt> files for individual web applications.
+
| introduction = The <tt>webdefault.xml</tt> file saves web applications from having to define a lot of house-keeping and container-specific elements in their own <tt>web.xml</tt> files. For example, you can use it to set up mime-type mappings and JSP servlet-mappings. Jetty applies <tt>webdefault.xml</tt> to a web application ''before'' the application's own <tt>WEB-INF/web.xml</tt>, which means that it cannot override values inside the webapp's <tt>web.xml</tt>. It uses the [[Jetty/Reference/jetty.xml_syntax|<tt>jetty.xml</tt> syntax]]. Generally, it is convenient for all webapps in a Jetty instance to share the same <tt>webdefault.xml</tt> file. However, it is certainly possible to provide differentiated <tt>webdefault.xml</tt> files for individual web applications.
  
Your Jetty distribution's <tt>webdefault.xml</tt> file can be found in <tt>$(jetty.home)/etc/webdefault.xml</tt>.
+
The <tt>webdefault.xml</tt> file is located in <tt>$(jetty.home)/etc/webdefault.xml</tt>.
  
 
| body =  
 
| body =  
  
== Using <tt>webdefault.xml</tt> / Providing a Custom <tt>webdefault.xml</tt> ==
+
== Using <tt>webdefault.xml</tt> ==
  
=== Using <tt>webdefault.xml</tt> ===
+
You can specify a custom configuration file to use for specific webapps, or for all webapps. If you do not specify an alternate defaults descriptor,  Jetty automatically uses <tt>webdefault.xml</tt>.
  
The distribution's <tt>webdefault.xml</tt> can be found at <tt>$JETTY_HOME/etc/webdefault.xml</tt>. 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 <tt>webdefault.xml</tt> will automatically be used.
+
=== Creating a Custom <tt>webdefault.xml</tt> for One WebApp ===
 
+
You can specify a custom <tt>webdefault.xml</tt> for an individual web application in that webapp's [[Jetty/Reference/jetty-web.xml|jetty-web.xml]] as follows:
=== Jetty Standalone ===
+
 
+
==== Custom <tt>webdefault.xml</tt> for One Webapp ====
+
You can specify a custom <tt>webdefault.xml</tt> for an individual web application in that webapp's [[Jetty/Reference/jetty-web.xml|jetty-web.xml]].
+
  
 
<source lang="xml">
 
<source lang="xml">
Line 39: Line 35:
 
</source>
 
</source>
  
Alternatively, you can use a classloader to find the resource representing your custom <tt>webdefault.xml</tt>.
+
Alternatively, you can use a [[Jetty/Reference/Jetty_Classloading|classloader]] to find the resource representing your custom <tt>webdefault.xml</tt>.
  
==== Custom <tt>webdefault.xml</tt> for Multiple Webapps ====
+
=== Creating a Custom <tt>webdefault.xml</tt> 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 [[ContextDeployer|hot deployer]] or the [[WebAppDeployer|static deployer]] in your <tt>[[Jetty/Reference/jetty.xml|jetty.xml]]</tt>.
+
If you want to apply the same custom <tt>webdefault.xml</tt> to a number of webapps, provide the path to the file in <tt>[[Jetty/Reference/jetty.xml|jetty.xml]]</tt> either to the hot deployer ([[Jetty/Feature/ContextDeployer|Context Provider]]) or the static deployer ([[Jetty/Feature/WebAppDeployer|WebAppProvider]]). For example:
  
 
<source lang="xml">
 
<source lang="xml">
Line 55: Line 51:
 
</source>
 
</source>
  
=== Jetty Maven Plugin ===
+
=== Using the Jetty Maven Plugin ===
  
Similarly, for the [[Jetty Maven Plugin]], you provide a customized webdefault.xml file for your webapp by:
+
Similarly, for the [[Jetty/Feature/Jetty Maven Plugin|Jetty Maven Plugin]], you provide a customized <tt>webdefault.xml</tt> file for your webapp as follows:
 
<source lang="xml">
 
<source lang="xml">
 
<project>
 
<project>
Line 79: Line 75:
  
 
| more =  
 
| more =  
* [[Jetty/Reference/web.xml syntax|web.xml Syntax Reference]] reference for web.xml files
+
* [[Jetty/Reference/jetty-web.xml|web.xml Reference]]–reference information for <tt>web.xml</tt> files
* [[Jetty/Reference/override-web.xml|override-web.xml]] web.xml-formatted file, applied after the webapp's web.xml
+
* [[Jetty/Reference/override-web.xml|<tt>override-web.xml</tt>]]–a web.xml-formatted file, applied after the webapp's web.xml
 +
* [[Jetty/Reference/jetty.xml|jetty.xml Reference]]–more information about <tt>jetty.xml</tt>
 
}}
 
}}

Revision as of 15:32, 6 June 2011



Introduction

The webdefault.xml file saves web applications from having to define a lot of house-keeping and container-specific elements in their own web.xml files. For example, you can use it to set up mime-type mappings and JSP servlet-mappings. Jetty applies webdefault.xml to a web application before the application's own WEB-INF/web.xml, which means that it cannot override values inside the webapp's web.xml. It uses the jetty.xml syntax. Generally, it is convenient for all webapps in a Jetty instance to share the same webdefault.xml file. However, it is certainly possible to provide differentiated webdefault.xml files for individual web applications.

The webdefault.xml file is located in $(jetty.home)/etc/webdefault.xml.

Using webdefault.xml

You can specify a custom configuration file to use for specific webapps, or for all webapps. If you do not specify an alternate defaults descriptor, Jetty automatically uses webdefault.xml.

Creating a Custom webdefault.xml for One WebApp

You can specify a custom webdefault.xml for an individual web application in that webapp's jetty-web.xml as follows:

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

Creating a Custom webdefault.xml for Multiple WebApps

If you want to apply the same custom webdefault.xml to a number of webapps, provide the path to the file in jetty.xml either to the hot deployer (Context Provider) or the static deployer (WebAppProvider). For example:

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

Using the Jetty Maven Plugin

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

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

Additional Resources