source: main/branches/2.1/src/main/webapps/ibisph-view/WEB-INF/config/spring/dispatcher_servlet.xml @ 3677

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

<!-- 
        Spring MVC Dispatcher Servlet URL patterns to Controllers mappings.  This 
        is a special bean file that is specified for the Dispatcher Servlet via
        a web.xml init param.  The servlet processes the beans specified by the
        interface they implement.  So the beans can be named anything.
        
        Controller Naming Phiolsophy: Controllers are named generically in hopes of 
        limiting the changes that are needed to this file by an adopter.  For 
        example, to use a different publishing mechanism, an adopter would modify 
        the web.xml and load the approp publish*.xml spring application context 
        file.  The different publish app context spring bean config files would 
        have their publishing controllers named the same (what they are named in 
        this file) but would use different IBIS classes with different property 
        definitions.  So different bean configuration files need to have the assoc
        controller samed the same so that this file does not have to be edited
        when an adopter changes publishing mechanisms etc.  

        This file should be changed/needs to be changed when the URL patterns or
        controllers are different or when an adopter wishes to turn off certain
        features and/or turn on others.  In these cases then the mappings need
        to be changed and the adopter should place the file under their config
        management.
-->

<beans default-lazy-init="false" default-autowire="no"
        xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd"
>

        <!-- see 12.4 Handler mappings for some property options -->
        <bean id="RequestDispatcher.URLToBean.Mapping" class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">

                <!-- 
                        The "alwaysUseFullPath" controls how the servlet matches the URL 
                        mapping.  From the docs: if true use the full path within the current 
                        servlet context. Else, the path within the current servlet mapping.
                        Put another way if true use getRequestURI sans the servlet context
                        path prefix to match, else use getPathInfo.

                        For IBIS-PH the value is set to "true" so that the mapping is a more
                        complete explicit URL which can provide a 100% sure and safe mapping
                        to the approriate controller.  Also, using the full path is easier 
                        to maintain and understand as the web.xml servlet mappings do not 
                        impact the URL mapping key.  The property value has NO effect on the
                        HTTP Request's getPathInfo() or getRequestURI value.  However, the 
                        getPathInfo's value is impacted by the web.xml's SERVLET MAPPINGS.
                -->
                <property name="alwaysUseFullPath" value="true"/>
                <property name="pathMatcher"><bean class="org.springframework.util.AntPathMatcher"/></property>

                <!-- 
                        ORDERING: The best practice is to be order most specific to least.
                -->
                <property name="urlMap">
                        <map>
                                <!-- H O M E -->
                                <entry key="/home/**"     value-ref="Home.HTMLContent.Controller"/>


                                <!-- P U B L I C A T I O N S -->
                                <entry key="/publications/index/Chronological.html" value-ref="Publications.ChronologicalIndex.Controller"/>
                                <entry key="/publications/index/Topical.html"       value-ref="Publications.TopicalIndex.Controller"/>
                                <entry key="/publications/**"                       value-ref="Publications.HTMLContent.Controller"/>


                                <!-- I N D I C A T O R  -->
                                <entry key="/indicator/index/Alphabetical.html"     value-ref="Indicator.AlphabeticalIndex.Controller"/>
                                <entry key="/indicator/index/Categorized.html"      value-ref="Indicator.CategorizedIndex.Controller"/>

                                <entry key="/indicator/view/*.html"                 value-ref="Indicator.View.Controller"/>
                                <entry key="/indicator/important_facts/*.html"      value-ref="Indicator.ImportantFacts.Controller"/>
                                <entry key="/indicator/available_services/*.html"   value-ref="Indicator.AvailableServices.Controller"/>
                                <entry key="/indicator/related/*/*.html"            value-ref="Indicator.RelatedIndicators.Controller"/>
                                <entry key="/indicator/other_resources/*.html"      value-ref="Indicator.OtherResources.Controller"/>
                                <entry key="/indicator/complete_profile/*.html"     value-ref="Indicator.CompleteProfile.Controller"/>
                                <entry key="/indicator/view_numbers/*.html"         value-ref="Indicator.ViewNumbers.Controller"/>

                                <entry key="/indicator/graphic/**"                  value-ref="Indicator.ChartGraphic.Controller"/>

                                <entry key="/indicator/**/*.html"                   value-ref="Indicator.HTMLContent.Controller"/>
                                <entry key="/indicator"                             value-ref="Indicator.HTMLContent.Controller"/>


                                <!-- Q U E R Y  -->
                                <entry key="/query/selection/**"          value-ref="Query.Selection.Controller"/>
                                <entry key="/query/configuration/**"      value-ref="Query.Configuration.Controller"/>
                                <entry key="/query/builder/**"            value-ref="Query.Builder.Controller"/>
                                <entry key="/query/submit/**"             value-ref="Query.Submit.Controller"/>
                                <entry key="/query/result/graphic/Map/**" value-ref="Query.MapGraphic.Controller"/>
                                <entry key="/query/result/graphic/**"     value-ref="Query.ChartGraphic.Controller"/>
                                <entry key="/query/result/**/*.html"      value-ref="Query.Result.Controller"/>
                                <entry key="/query/result/**/*.xls"       value-ref="Query.Result.Controller"/> <!-- put here so can plug in Excel specifici controller in the future. -->
                                <entry key="/query/result/**/*.xml"       value-ref="Query.IBISQResult.Controller"/>    

                                <entry key="/query/proxy*"                value-ref="Query.QueryApplicationProxy.Controller"/>

                                <entry key="/query/**/*.html"             value-ref="Query.HTMLContent.Controller"/>
                                <entry key="/query"                       value-ref="Query.HTMLContent.Controller"/>


                                <!-- Q U E R Y   D E F I N I T I O N -->
                                <entry key="/query/criteria/List.html"  value-ref="QueryDefinition.CriteriaList.Controller"/>
                                <entry key="/query/definition/List.html"  value-ref="QueryDefinition.DefinitionList.Controller"/>
<!-- 
        IF STICKY then PUT THE CURRENT QUERY DEF INTO THE SESSION ANYTIME ONE IS SELECTED
        
        MAYBE BY DEFINITION YOU SAY SELECTIONS ARE STICKY GOING FORWARD - APPLY ALL GOING 
        FORWARD???   NO BECAUSE WHEN POST QM YOU'D HAVE TO CONVERT/UPDATE ETC.
-->

                                <entry key="/run/query/definition/**"    value-ref="QueryDefinition.RunDefinition.Controller"/>
                                <entry key="/edit/query/definition/**"   value-ref="QueryDefinition.EditDefinition.Controller"/>
<entry key="/apply/query/definition/**"  value-ref="QueryDefinition.ApplyDefinition.Controller"/>
<entry key="/delete/query/definition/**" value-ref="QueryDefinition.DeleteDefinition.Controller"/>

<entry key="/edit/query/builder/definition/**"          value-ref="QueryDefinition.EditBuilderDefinition.Controller"/>
<entry key="/edit/query/result/definition/**"          value-ref="QueryDefinition.EditResultDefinition.Controller"/>
<entry key="/save/query/definition/**"      value-ref="QueryDefinition.SaveDefinition.Controller"/>



<!-- run directly with name being specified as a get...
<entry key="/query/definition/result/**/*.html" value-ref="QueryDefinition.DefinitionResult.Controller"/>
<entry key="/query/definition/system/result/**/*.html" value-ref="QueryDefinition.SystemResult.Controller"/>
-->

                                <!-- S E C U R E  -->
                                <entry key="/secure/selection/*.html"       value-ref="Secure.Selection.Controller"/>
                                <entry key="/secure/query/selection/**"     value-ref="Secure.Query.Selection.Controller"/>
                                <entry key="/secure/query/builder/**"       value-ref="Secure.Query.Builder.Controller"/>
                                <entry key="/secure/query/submit/**"        value-ref="Secure.Query.Submit.Controller"/>
                                <entry key="/secure/query/result/**/*.html" value-ref="Secure.Query.Result.Controller"/>
                                <entry key="/secure/query/result/**/*.xls"  value-ref="Query.Result.Controller"/>       <!-- put here so can plug in Excel specifici controller in the future. -->
                                <entry key="/secure/query/result/**/*.xml"  value-ref="Query.IBISQResult.Controller"/>  
                                <entry key="/secure/query/configuration/**" value-ref="Query.Configuration.Controller"/>
                                <entry key="/secure/query/selections"       value-ref="User.QuerySelectionList.Controller"/>

                                <entry key="/secure"                        value-ref="Secure.Selection.Controller"/>


                                <!-- C O M M U N I T Y -->
                                <entry key="/community/snapshot/Builder.html" value-ref="Community.Snapshot.Builder.Controller"/>
<!--
                                <entry key="/community/snapshot/Report.html" value-ref="Community.Snapshot.Report.Controller"/>
-->
                                <!-- path: graphic/indicator view name/community name/community value.svg -->
                                <entry key="/community/highlight/graphic/*/*/*.*" value-ref="Community.Highlight.ChartGraphic.Controller"/>

                                <entry key="/community/highlight/index/*/*.html"  value-ref="Community.Highlight.Index.Controller"/>
                                <entry key="/community/highlight/introduction/*/*.html" value-ref="Community.Highlight.Introduction.Controller"/>
                                <entry key="/community/highlight/report/*/*.html" value-ref="Community.Highlight.Report.Controller"/>
                                <entry key="/community/highlight/*/*/*.html"      value-ref="Community.Highlight.Profile.Controller"/>
                                <entry key="/community/highlight/**"              value-ref="Community.Highlight.Selection.Controller"/>

                                <entry key="/community/**"                        value-ref="Community.HTMLContent.Controller"/>


                                <!-- P H O M   R E P O R T   P A G E S -->
                                <entry key="/phom/expanded_view/*.html" value-ref="PHOM.ExpandedView.Controller"/>
                                <entry key="/phom/view/*.html"          value-ref="PHOM.CondensedView.Controller"/>
                                <entry key="/phom/**"                   value-ref="PHOM.HTMLContent.Controller"/>


                                <!-- P U B L I S H -->
                                <!-- default publishing URL mapping that even if direct publishing is 
                                        configured in the admin app does no harm as these URLs are never hit.
                                -->
                                <entry key="/publish/categorized_index.xml" value-ref="Publish.CategorizedIndex.Controller"/>
                                <entry key="/publish/indicator/*.xml"       value-ref="Publish.Indicator.Controller"/>
                                <entry key="/publish/org_units.xml"         value-ref="Publish.OrgUnits.Controller"/>


                                <!-- U S E R   P R O F I L E -->
                                <entry key="/user/Login.html"          value-ref="User.HTMLContent.Controller"/>
<entry key="/user/AccountAccess.html"  value-ref="User.HTMLContent.Controller"/>
<entry key="/send/user/password"       value-ref="User.EmailPassword.Controller"/>
<entry key="/send/user/verification"   value-ref="User.EmailPassword.Controller"/>
<entry key="/user/Registration.html"   value-ref="User.HTMLContent.Controller"/>
<entry key="/save/user/registration"   value-ref="User.SaveRegistration.Controller"/>
<entry key="/verify/user/registration" value-ref="User.VerifyRegistration.Controller"/>
<entry key="/edit/user/profile"        value-ref="User.EditProfile.Controller"/>
<entry key="/save/user/profile"        value-ref="User.SaveProfile.Controller"/>

<entry key="/user/selection/List.html" value-ref="User.QuerySelectionList.Controller"/>


                                <!-- B L O C K E D   R E S O U R C E S -->
                                <!-- External URL blocker mapping 
                                        Blocked direct file access URLs.  Files that need to be 
                                        blocked from public access can have a general mapping that 
                                        goes to a simple controller that returns a missing resource 
                                        page.  This could also be mapped to a general controller 
                                        that simply returns a 404 or 403 error.  There are other 
                                        ways to impelment like putting the files within a WEB-INF/* 
                                        subdirectory.  Can also be done via a filter (like the 
                                        CheckAllowedRequesterIPAddressFilter) etc.
                                -->
                                <entry key="/xml/users/**" value-ref="Common.BannedXMLAccess.Controller"/>


                                <!-- O T H E R   -   G E N E R I C   T R A S F O R M A T I O N -->
                                <entry key="/view" value-ref="View.Controller"/>


                                <!-- W E L C O M E   /   I N D E X    H A N D L E R -->
                                <!-- This mechanism along with the servlet and welcome-file-list
                                        definitions in the web.xml and servlet spec 2.4 allow for
                                        a servlet to directly handle an application root request
                                        (what was a redirect within the index.html file).
                                -->
                                <entry key="/Welcome" value-ref="Home.HTMLContent.Controller"/>
                                <entry key="/"        value-ref="Home.HTMLContent.Controller"/>

                        </map>
                </property>
        </bean>


        <!--  V I E W   R E S O L V E R  -->
        <!-- 
                For XSLTs, view resolver is NOT needed since the views are beans that 
                are passed into the controller.  For JSPs, it is needed to properly 
                locate the jsp.  View resolver messes with the graph request so DO NOT
                implement unless graph views are handled differently.
        <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
                <property name="prefix" value="/WEB-INF/jsp/"/>
                <property name="suffix" value=".jsp"/>
        </bean>
        -->
        <bean id="RequestDispatcher.BeanName.ViewResolver" class="org.springframework.web.servlet.view.BeanNameViewResolver"/>

</beans>