source: main/trunk/src/main/webapps/ibisph-view/WEB-INF/web.xml @ 3710

<?xml version="1.0" encoding="UTF-8"?>

<!-- 
        This file contains the standard Java Web Application Server application 
        definitions for the IBIS-PH View application.  See the admin app's 
        web.xml for detailed comments that describes how requests flow, spring
        configuration, JNDI resources - info about webapp configuration.

        The configuration implemented in this file contains a basic configuration 
        with remote publishing and NO user security (but publishing security).  

        NOTE: Direct file publishing can be configured for the admin app without 
        impacting (having to do any reconfiguration) this application's publishing 
        configuration.  Put another way, if the admin is configured to publish 
        directly to     this applications XML directory then this application never 
        receives a publish request so the view app's remote publishing is never 
        invoked - so it doesn't matter if it is setup or properly configured as it 
        will never be hit (so the site specific publish related configuration 
        properties could be ignored but only IF the admin app uses direct publishing).
-->

<web-app 
        version="2.5"
        xmlns="http://java.sun.com/xml/ns/javaee"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
>

        <icon>
                <small-icon>image/application.ico</small-icon>
                <large-icon>image/application.ico</large-icon>
        </icon>
        <display-name>IBIS-PH - Public View</display-name>
        <description>
                Indicator Based Information System for Public Health (IBIS-PH).  This 
                system provides internet access for the public to view health indicator 
                data and to create and execute custom data queries.  The data presented
                are stored in XML files with the HTML view being created by XSLTs and
                controlled via Java controllers built on the Spring framework.
        </description>
        <distributable/>


        <!-- =========================================== J N D I   R E S O U R C E S -->
        <!-- not all adopters will use a db.  this is provided for those who do:
        <resource-ref>
                <description>Resource reference to the app server container managed JNDI database connection factory</description>
                <res-ref-name>jdbc/doh_ibisph</res-ref-name>
                <res-ref-type>javax.sql.DataSource</res-ref-type>
                <res-auth>Container</res-auth>
        </resource-ref>
        -->
        <resource-ref>
                <description>Resource reference to the app server container managed JNDI JavaMail factory</description>
                <res-ref-name>mail/doh_ibisph</res-ref-name>
                <res-type>javax.mail.Session</res-type>
                <res-auth>Container</res-auth>
                <res-sharing-scope>Shareable</res-sharing-scope>
        </resource-ref>


        <!-- ========================================== C O N T E X T - P A R A M S -->
        <!-- Values used by the listeners -->
        <context-param>
                <param-name>logbackConfigLocation</param-name>
                <param-value>/WEB-INF/config/logback.xml</param-value>
        </context-param>

        <context-param>
                <description>
                        Defines the global, app context wide Spring application context 
                        definition files to be used for the application.  These files are 
                        Spring bean definitions which will be loaded by the Spring Bean 
                        Factory and are availaable to any object within the app.  

                        See the context listener defined below which uses this param (list).

                        Optional context files:
                        /WEB-INF/config/spring/security-db_authentication.xml
                        /WEB-INF/config/spring/https.xml
                </description>
                <param-name>contextConfigLocation</param-name>
                <param-value>
                        /WEB-INF/config/spring/common.xml
                        /WEB-INF/config/spring/filter.xml

                        /WEB-INF/config/spring/security.xml
                        /WEB-INF/config/spring/security-pre_authentication.xml
                        /WEB-INF/config/spring/security-xml_authentication.xml
                </param-value>
        </context-param>


        <!-- ===================================================== L I S T E N E R S -->
        <listener>
                <listener-class>org.ibisph.log.ConfigureLogbackListener</listener-class>
        </listener>

        <listener>
                <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
        </listener>

        <listener>
                <description>
                        Publishes events for session creation and destruction through the app
                        context.  Optional unless concurrent session control is being used.
                </description>
                <listener-class>org.springframework.security.web.session.HttpSessionEventPublisher</listener-class>
        </listener>


        <!-- ========================================================= F I L T E R S -->
        <filter>
                <filter-name>StandardFilters</filter-name>
                <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
                <init-param>
                        <param-name>targetBeanName</param-name>
                        <param-value>Filter.FilterChainProxy</param-value>
                </init-param> 
        </filter>
        <filter>
                <filter-name>SecurityFilters</filter-name>
                <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
                <init-param>
                        <param-name>targetBeanName</param-name>
                        <param-value>Security.FilterChainProxy</param-value>
                </init-param> 
        </filter>


        <!-- ========================================= F I L T E R   M A P P I N G S -->
        <!-- The standard filters provide response compression (gzip), header
                modifications for stuffing graphic types and cookie values, and to 
                handle other request/response manipulations.  The security filters
                provide authentication and authorization protection for the web URL/
                resource via Spring Security filters.  Both types of filtering are 
                handled at a high level with Spring's delegating filter.  Spring's 
                delegating proxy filter provides 2 important capabilities not found in
                standard web.xml filter mappings: 1) more flexible URL to filter 
                mappings, and 2) the ability to configure filters using spring 
                injection.  Each filter definition has the detailed filter mappings 
                which makes this web.xml simplier and allows the filters to all be 
                contained in one area and easier to maintain.
        -->
        <filter-mapping>
                <filter-name>StandardFilters</filter-name>
                <url-pattern>*</url-pattern>
        </filter-mapping>
        <filter-mapping>
                <filter-name>SecurityFilters</filter-name>
                <url-pattern>*</url-pattern>
        </filter-mapping>


        <!-- ======================================================= S E R V L E T S -->
        <servlet>
                <description>
                </description>
                <servlet-name>Dispatcher.Servlet</servlet-name>
                <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
                <init-param>
                        <param-name>contextConfigLocation</param-name>
                        <param-value>
                                /WEB-INF/config/spring/home.xml
                                /WEB-INF/config/spring/publications.xml
                                /WEB-INF/config/spring/indicator.xml
                                /WEB-INF/config/spring/community.xml
                                /WEB-INF/config/spring/query.xml
                                /WEB-INF/config/spring/secure.xml
                                /WEB-INF/config/spring/phom.xml
                                /WEB-INF/config/spring/view.xml

                                /WEB-INF/config/spring/query_definition.xml
                                /WEB-INF/config/spring/user.xml

                                /WEB-INF/config/spring/chart-agileblox.xml
                                /WEB-INF/config/spring/publish-remote.xml

                                /WEB-INF/config/spring/dispatcher_servlet.xml</param-value>
                </init-param>
                <load-on-startup>10</load-on-startup>
        </servlet>

        <servlet>
                <description>
                        AWT based captcha servler that generates a simple random AWT 
                        generated text graphic (streams back) and puts the associated 
                        random text into the user's sesssion for validation.
                </description>
                <servlet-name>Captcha.Servlet</servlet-name>
                <servlet-class>org.ibisph.web.servlet.AWTCaptchaServlet</servlet-class>
        </servlet>



        <!-- ======================================= S E R V L E T   M A P P I N G S -->
        <!-- Servlet and filter URL mappings have the same exact limitations as 
                such they are handled in a similar manner - all requests are routed
                to the Spring request dispaatcher servlet which uses more robust URL
                to controller mappings.  This is not very efficient for static content
                but static content has header values that encourage the browser to cache
                its content.  

                setup the dispatcher servlet to handle all requsets with the defaul explicitly 
                configed to handle all static content:
        <servlet-mapping>
                <servlet-name>default</servlet-name>
                <url-pattern>/css/*</url-pattern>
                <url-pattern>/image/*</url-pattern>
                <url-pattern>*.ico</url-pattern>
                <url-pattern>/js/*</url-pattern>
                <url-pattern>*.jsp</url-pattern>
                <url-pattern>*.log</url-pattern>
                <url-pattern>/xml/*</url-pattern>
        </servlet-mapping>   

                <url-pattern>/*</url-pattern>

                the above has an issue with the path prefix needing to be stripped for 
                the correct xml file path.  Doing this would however do away with the
                ds needing to check full path and the below mappings which are basically
                used to strip url path prefixes.
        -->
        <servlet-mapping>
                <servlet-name>Dispatcher.Servlet</servlet-name>

                <url-pattern>/home/*</url-pattern>
                <url-pattern>/publications/*</url-pattern>
                <url-pattern>/indicator/*</url-pattern>
                <url-pattern>/community/*</url-pattern>
                <url-pattern>/query/*</url-pattern>
                <url-pattern>/user/*</url-pattern>
                <url-pattern>/secure/*</url-pattern>
                <url-pattern>/phom/*</url-pattern>

                <url-pattern>/view/*</url-pattern>
                <url-pattern>/edit/*</url-pattern>
                <url-pattern>/save/*</url-pattern>
                <url-pattern>/delete/*</url-pattern>
                <url-pattern>/run/*</url-pattern>
                <url-pattern>/apply/*</url-pattern>
                <url-pattern>/send/*</url-pattern>
                <url-pattern>/verify/*</url-pattern>

                <!-- 
                        Default publishing URL mapping that even if direct publishing is 
                        configured in the admin app does no harm as these URLs are never hit.
                -->
                <url-pattern>/publish/*</url-pattern>
                <url-pattern>/unpublish/*</url-pattern>
        </servlet-mapping>

        <!-- 
                NOTE: These mappings are mainly used as a mechanism to remove a path prefix.
                For this to work, the request's getPathInfo() method is used, not the get 
                URL method.  Also, for Spring's dispatcher servlet to property resolve/
                handle full paths the "alwaysUseFullPath" property must be set to "true".
                Example of usage is for ip charts it strips off the /indicator/graphic/ from 
                the path so it's one less item to parse - exposing the chart name as the first 
                item.  This also makes it easier if at some point for the charting 
                functionality to be moved to a seperate servlet.
        -->
        <servlet-mapping>
                <servlet-name>Dispatcher.Servlet</servlet-name> 

                <url-pattern>/indicator/graphic/*</url-pattern> 
                <url-pattern>/query/selection/*</url-pattern> 
                <url-pattern>/query/configuration/*</url-pattern> 
                <url-pattern>/query/builder/*</url-pattern> 
                <url-pattern>/query/submit/*</url-pattern> 
                <url-pattern>/query/result/*</url-pattern> 
                <url-pattern>/query/result/graphic/*</url-pattern> 

                <url-pattern>/secure/query/selection/*</url-pattern> 
                <url-pattern>/secure/query/configuration/*</url-pattern> 
                <url-pattern>/secure/query/builder/*</url-pattern> 
                <url-pattern>/secure/query/submit/*</url-pattern> 
                <url-pattern>/secure/query/result/*</url-pattern> 
                <url-pattern>/secure/query/result/graphic/*</url-pattern> 
        </servlet-mapping>

        <servlet-mapping>
                <servlet-name>Captcha.Servlet</servlet-name>
                <url-pattern>/captcha/*</url-pattern>
        </servlet-mapping>



        <!-- =================================================== J S P   C O N F I G -->
        <jsp-config>
                <jsp-property-group>
                        <description>Property group for common configuration for all the JSP's</description>
                        <display-name>default</display-name>
                        <url-pattern>*.jsp</url-pattern>
                        <el-ignored>false</el-ignored>
                        <page-encoding>ISO-8859-1</page-encoding>
                        <scripting-invalid>false</scripting-invalid>
                        <trim-directive-whitespaces>true</trim-directive-whitespaces>
                </jsp-property-group>
        </jsp-config>


        <!-- =========================================== S E S S I O N   C O N F I G -->
        <session-config>
                <!-- Inactive timeout value for a user's session.  Value is in minutes. -->
                <session-timeout>30</session-timeout>

                <!-- Servlet 3.0 value (Tomcat7) that makes it more difficult for browser scripting
                to steal the user's session id
                <cookie-config>
                        <http-only>true</http-only>
                </cookie-config>
                -->
        </session-config>


        <!-- ============================================= M I M E   M A P P I N G S -->
        <mime-mapping>
                <extension>htm</extension>
                <mime-type>text/html</mime-type>
        </mime-mapping>
        <mime-mapping>
                <extension>html</extension>
                <mime-type>text/html</mime-type>
        </mime-mapping>
        <mime-mapping>
                <extension>xml</extension>
                <mime-type>text/xml</mime-type>
        </mime-mapping>
        <mime-mapping>
                <extension>css</extension>
                <mime-type>text/css</mime-type>
        </mime-mapping>
        <mime-mapping>
                <extension>ico</extension>
                <mime-type>image/vnd.microsoft.icon</mime-type>
        </mime-mapping>
        <mime-mapping>
                <extension>js</extension>
                <mime-type>text/javascript</mime-type>
        </mime-mapping>
        <mime-mapping>
                <extension>jsp</extension>
                <mime-type>text/html</mime-type>
        </mime-mapping>
        <mime-mapping>
                <extension>log</extension>
                <mime-type>text/plain</mime-type>
        </mime-mapping>
        <mime-mapping>
                <extension>gif</extension>
                <mime-type>image/gif</mime-type>
        </mime-mapping>
        <mime-mapping>
                <extension>jpg</extension>
                <mime-type>image/jpeg</mime-type>
        </mime-mapping>
        <mime-mapping>
                <extension>jpeg</extension>
                <mime-type>image/jpeg</mime-type>
        </mime-mapping>
        <mime-mapping>
                <extension>png</extension>
                <mime-type>image/png</mime-type>
        </mime-mapping>
        <mime-mapping>
                <extension>tiff</extension>
                <mime-type>image/tiff</mime-type>
        </mime-mapping>
        <mime-mapping>
                <extension>tif</extension>
                <mime-type>image/tiff</mime-type>
        </mime-mapping>
        <mime-mapping>
                <extension>svg</extension>
                <mime-type>image/svg+xml</mime-type>
        </mime-mapping>
        <mime-mapping>
                <extension>svgz</extension>
                <mime-type>image/svg+xml</mime-type>
        </mime-mapping>

        <mime-mapping>
                <extension>pdf</extension>
                <mime-type>image/pdf</mime-type>
        </mime-mapping>

        <mime-mapping>
                <extension>xls</extension>
                <mime-type>application/vnd.ms-excel</mime-type>
        </mime-mapping>

                
        <!-- =============================== D E F A U L T / W E L C O M E   P A G E -->
        <welcome-file-list>
                <welcome-file>home/Welcome.html</welcome-file>
        </welcome-file-list>


        <!-- ======================================= H T T P   E R R O R   P A G E S -->
        <error-page><error-code>401</error-code><location>/WEB-INF/jsp/error/detail.jsp?message=You are not authorized to view the requested resource.</location></error-page>
        <error-page><error-code>403</error-code><location>/WEB-INF/jsp/error/detail.jsp?message=You are trying to view a restricted resource.  The request was understood by the server but a response was refused.</location></error-page>
        <error-page><error-code>404</error-code><location>/WEB-INF/jsp/error/detail.jsp?message=Requested resource was not found.  It has either moved or is unavailable.</location></error-page>
        <error-page><error-code>405</error-code><location>/WEB-INF/jsp/error/detail.jsp?message=The page tried to use a method which is not supported for this URL.</location></error-page>
        <error-page><error-code>406</error-code><location>/WEB-INF/jsp/error/detail.jsp?message=The requested resource exists, but not in a format/type that your browser will accept.</location></error-page>
        <error-page><error-code>407</error-code><location>/WEB-INF/jsp/error/detail.jsp?message=The proxy server needs authorization before it can proceed.</location></error-page>
        <error-page><error-code>408</error-code><location>/WEB-INF/jsp/error/detail.jsp?message=Request timed out.  The resource is in use or is temporarily unavailable or there is a network problem.</location></error-page>
        <error-page><error-code>414</error-code><location>/WEB-INF/jsp/error/detail.jsp?message=The requested URI (URL) is too long for the server to handle.</location></error-page>
        <error-page><error-code>415</error-code><location>/WEB-INF/jsp/error/detail.jsp?message=The server can not process the request because the request body is in an unsupported media format.</location></error-page>

        <error-page><error-code>500</error-code><location>/WEB-INF/jsp/error/detail.jsp?message=An unexpected error occurred inside the server that prevented it from fulfilling the request.</location></error-page>
        <error-page><error-code>501</error-code><location>/WEB-INF/jsp/error/detail.jsp?message=Requested function is not implemented by this application on this server.</location></error-page>
        <error-page><error-code>502</error-code><location>/WEB-INF/jsp/error/detail.jsp?message=Bad internet gateway.  A server acting as a gateway or proxy did not receive a valid response from an upstream server.</location></error-page>
        <error-page><error-code>503</error-code><location>/WEB-INF/jsp/error/detail.jsp?message=The service (server) is temporarily unavailable but should be restored in the future.</location></error-page>
        <error-page><error-code>504</error-code><location>/WEB-INF/jsp/error/detail.jsp?message=A gateway timout error has occured.  A server acting as a gateway or proxy did not receive a valid response in time.</location></error-page>
        <error-page><error-code>505</error-code><location>/WEB-INF/jsp/error/detail.jsp?message=The server does not support the version of the HTTP protocol used in the request.</location></error-page>

        <error-page><exception-type>java.lang.Throwable</exception-type><location>/WEB-INF/jsp/error/detail.jsp?message=Uncaught System Run Time Exception</location></error-page>
</web-app>