Complete web.xml file in XML format

[Gary Engebretson]

I have been looking for a COMPLETE example of a web.xml file. I have found snippets and narrative explantions but I would really like to have full blown example in XML format.

[Bear Bibeault]

This seems more appropriate for the Servlets forum than JSP, so moved there.

[Bear Bibeault]

Well, if by "complete" you mean "uses every conceivable setting" you are unlikely to achieve satisfaction.

If you want to see an example of a working web.xml from an actual deployed web application, I've included one below from one of my clients' application (with various names changed to protect confidentiality).

It employs a broad spectrum of settings: context params, listeners, filters and filter mappings, servlets and servlet mappings, error handling, resource referencing, and defines a JSP prelude.

<?xml version="1.0" encoding="ISO-8859-1"?>
 
<web-app xmlns="http://java.sun.com/xml/ns/j2ee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee <a href="http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"" target="_blank" rel="nofollow">http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"</a>
         version="2.4">
 
    <display-name>Some Client's Web Application 2.7.8</display-name>
 
    <context-param>
        <!-- Used by the ApplicationConfigurationLoader to locate the config properties file(s) -->
        <param-name>applicationConfigurationLoaderContextBundlePaths</param-name>
        <param-value>/WEB-INF/config/config.properties,/WEB-INF/config/@hostname@.properties</param-value>
    </context-param>
 
    <context-param>
        <!-- Used by the ApplicationConfigurationLoader as the application-scoped variable name for the config Map -->
        <param-name>applicationConfigurationLoaderMapName</param-name>
        <param-value>appConfig</param-value>
    </context-param>
 
    <listener>
        <listener-class>com.somecompanyname.kalypso.appconfig.ApplicationConfigurationLoader</listener-class>
    </listener>
 
    <listener>
        <listener-class>com.someclient.control.config.DataCacheLoader</listener-class>
    </listener>
 
    <filter>
        <filter-name>AdminAuthenticationFilter</filter-name>
        <filter-class>com.somecompanyname.kalypso.authentication.NamespaceAuthenticationFilter</filter-class>
        <init-param>
            <param-name>protect</param-name>
            <param-value>true</param-value>
        </init-param>
        <init-param>
            <param-name>namespaces</param-name>
            <param-value>admin</param-value>
        </init-param>
        <init-param>
            <param-name>authenticationActionKey</param-name>
            <param-value>login.viewLoginPageForAdmin</param-value>
        </init-param>
    </filter>
 
    <filter>
        <filter-name>SalesAuthenticationFilter</filter-name>
        <filter-class>com.somecompanyname.kalypso.authentication.NamespaceAuthenticationFilter</filter-class>
        <init-param>
            <param-name>protect</param-name>
            <param-value>true</param-value>
        </init-param>
        <init-param>
            <param-name>namespaces</param-name>
            <param-value>sales</param-value>
        </init-param>
        <init-param>
            <param-name>authenticationActionKey</param-name>
            <param-value>login.viewLoginPageForSales</param-value>
        </init-param>
    </filter>
 
    <filter-mapping>
        <filter-name>AdminAuthenticationFilter</filter-name>
        <servlet-name>ActionBroker</servlet-name>
    </filter-mapping>
 
    <filter-mapping>
        <filter-name>SalesAuthenticationFilter</filter-name>
        <servlet-name>ActionBroker</servlet-name>
    </filter-mapping>
 
    <servlet>
        <servlet-name>LoggingLoader</servlet-name>
        <servlet-class>com.somecompanyname.kalypso.logging.LoggingConfigurationLoadingServlet</servlet-class>
        <init-param>
            <param-name>loggingConfigurationPath</param-name>
            <param-value>/WEB-INF/config/logging.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
 
    <servlet>
        <servlet-name>ActionBroker</servlet-name>
        <servlet-class>com.somecompanyname.atlas.ActionBroker</servlet-class>
        <init-param>
            <param-name>agentKey</param-name>
            <param-value>brokerAgent</param-value>
        </init-param>
        <init-param>
            <param-name>config:core</param-name>
            <param-value>WEB-INF/config/core-config.xml</param-value>
        </init-param>
        <init-param>
            <param-name>config:login</param-name>
            <param-value>WEB-INF/config/login-config.xml</param-value>
        </init-param>
        <init-param>
            <param-name>config:admin</param-name>
            <param-value>WEB-INF/config/admin-config.xml</param-value>
        </init-param>
        <init-param>
            <param-name>config:sales</param-name>
            <param-value>WEB-INF/config/sales-config.xml</param-value>
        </init-param>
        <load-on-startup>2</load-on-startup>
    </servlet>
 
    <servlet>
        <servlet-name>ComponentServlet</servlet-name>
        <servlet-class>com.somecompanyname.kalypso.components.ComponentServlet</servlet-class>
        <load-on-startup>3</load-on-startup>
    </servlet>
 
    <servlet>
        <servlet-name>ThemeManager</servlet-name>
        <servlet-class>com.somecompanyname.kalypso.themes.ThemeManager</servlet-class>
        <init-param>
            <param-name>themesRoot</param-name>
            <param-value>/themes</param-value>
        </init-param>
        <load-on-startup>3</load-on-startup>
    </servlet>
 
    <servlet>
        <servlet-name>ErrorHandlerServlet</servlet-name>
        <servlet-class>com.somecompanyname.kalypso.errors.ErrorHandlerServlet</servlet-class>
        <init-param>
            <param-name>default</param-name>
            <param-value>/error.jsp</param-value>
        </init-param>
        <init-param>
            <param-name>errorInfoId</param-name>
            <param-value>errorInfo</param-value>
        </init-param>
        <load-on-startup>3</load-on-startup>
    </servlet>
 
    <servlet>
        <servlet-name>PictureServer</servlet-name>
        <servlet-class>com.someclient.control.news.PictureServer</servlet-class>
        <load-on-startup>3</load-on-startup>
    </servlet>
 
    <servlet-mapping>
        <servlet-name>ActionBroker</servlet-name>
        <url-pattern>/action/*</url-pattern>
    </servlet-mapping>
 
    <servlet-mapping>
        <servlet-name>ActionBroker</servlet-name>
        <url-pattern>/view/*</url-pattern>
    </servlet-mapping>
 
    <servlet-mapping>
        <servlet-name>ComponentServlet</servlet-name>
        <url-pattern>/kalypso/*</url-pattern>
    </servlet-mapping>
 
    <servlet-mapping>
        <servlet-name>ThemeManager</servlet-name>
        <url-pattern>/theme/*</url-pattern>
    </servlet-mapping>
 
    <servlet-mapping>
        <servlet-name>ErrorHandlerServlet</servlet-name>
        <url-pattern>/errorHandler</url-pattern>
    </servlet-mapping>
 
    <servlet-mapping>
        <servlet-name>PictureServer</servlet-name>
        <url-pattern>/picture/*</url-pattern>
    </servlet-mapping>
 
    <error-page>
      <error-code>403</error-code>
      <location>/errorHandler</location>
    </error-page>
 
    <error-page>
      <error-code>404</error-code>
      <location>/errorHandler</location>
    </error-page>
 
    <error-page>
      <error-code>500</error-code>
      <location>/errorHandler</location>
    </error-page>
 
    <resource-ref>
        <res-ref-name>jdbc/whatever</res-ref-name>
        <res-type>javax.sql.DataSource</res-type>
        <res-auth>Container</res-auth>
    </resource-ref>
 
    <jsp-config>
        <jsp-property-group>
            <url-pattern>*.jsp</url-pattern>
            <include-prelude>/WEB-INF/pages/prelude.jspf</include-prelude>
        </jsp-property-group>
    </jsp-config>
 
</web-app>
 

[Ben Souther]

The servlet spec goes through the entire thing as well.
Link in my signature.

[Rahul Bhattacharjee]

DTD of the web.xml can be of help in this case.