The web.xml File
The web.xml
file provides configuration and
deployment information for web components in a web application. It must
reside in the web application's WEB-INF directory.
The following listing shows the content of the web.xml
file for a standard Escenic publication.
<?xml version="1.0" encoding="utf-8"?> <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 http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd" version="2.4"> <filter> <filter-name>BootstrapFilter</filter-name> <filter-class>com.escenic.presentation.servlet.BootstrapFilter</filter-class> <init-param> <param-name>oncePerRequest</param-name> <param-value>true</param-value> </init-param> </filter> <filter> <filter-name>TimerFilter</filter-name> <filter-class>neo.servlet.TimerFilter</filter-class> <init-param> <param-name>collector</param-name> <param-value>/neo/io/reports/HitCollector</param-value> </init-param> </filter> <filter> <filter-name>EscenicStandardFilterChain</filter-name> <filter-class> com.escenic.presentation.servlet.CompositeFilter </filter-class> <init-param> <param-name>oncePerRequest</param-name> <param-value>true</param-value> </init-param> <init-param> <param-name>chain</param-name> <param-value> /com/escenic/servlet/StandardFilter </param-value> </init-param> </filter> <filter> <filter-name>imageVersionFilter</filter-name> <filter-class>com.escenic.presentation.servlet.ImageVersionFilter</filter-class> </filter> <filter> <filter-name>cache</filter-name> <filter-class> com.escenic.presentation.servlet.multimedia.CacheFilter </filter-class> <init-param> <param-name>oncePerRequest</param-name> <param-value>true</param-value> </init-param> </filter> <filter-mapping> <filter-name>BootstrapFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <filter-mapping> <filter-name>TimerFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <filter-mapping> <filter-name>EscenicStandardFilterChain</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <filter-mapping> <filter-name>cache</filter-name> <url-pattern>/multimedia/dynamic/*</url-pattern> </filter-mapping> <filter-mapping> <filter-name>cache</filter-name> <servlet-name>binaryFieldRetriever</servlet-name> <dispatcher>FORWARD</dispatcher> </filter-mapping> <filter-mapping> <filter-name>imageVersionFilter</filter-name> <servlet-name>binaryFieldRetriever</servlet-name> <dispatcher>FORWARD</dispatcher> </filter-mapping> <listener> <description>Escenic Presentation layer bootstrap listener</description> <listener-class>com.escenic.presentation.servlet.PresentationBootstrapper</listener-class> </listener> <servlet> <servlet-name>binaryFieldRetriever</servlet-name> <servlet-class>com.escenic.presentation.servlet.BinaryFieldRetrieverServlet</servlet-class> <init-param> <param-name>storage</param-name> <param-value>nursery://global/com/escenic/storage/Storage</param-value> </init-param> </servlet> <welcome-file-list> <welcome-file>index.html</welcome-file> <welcome-file>index.jsp</welcome-file> </welcome-file-list> </web-app>
Lines 1 through 5 make up the standard web.xml
header.
The filter
elements identify the servlet filters
used by the publication. You can add filter elements referencing your own
custom filters here. See Servlet Filters for more
information about servlet filters in general and descriptions of the
filters supplied by Escenic.
The filter-mapping
elements define the sequence
of the filters, which is significant. The Escenic-supplied
filters should always appear in the order shown. You can insert your own
filters anywhere in the sequence so long as you do not change the sequence
of the standard filters.
The welcome-file-list
element contains a list of
file names that will be assumed to represent "welcome" files.
This standard web.xml
file can be found in the
template/WEB-INF
folder of the Content Engine
distribution.