source: main/trunk/ibisph-view/src/main/webapp/WEB-INF/config/spring/SiteSpecific.xml @ 25615

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

<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"
>
        <!--
                This file has 3 functions:
                1) Specify/load the application's spring bean definition files.
                2) Provide the dispatcher servlet URL to controller mappings.
                3) Override any spring bean definitions as per adopter's specific needs.
                   Note that the properties file should be configured in this file IF
                   they are needed/used.
        -->

        <!--
                SPRING APPLICATION CONTENT DEFINITION FILES / SPRING BEAN IMPORTS 
                Specifies the Spring application context definition files which are
                responsible for creating the application's objects.  To keep these 
                definitions more maintainable the bean definitions are stored in their 
                own file (beans are grouped by functionality).  There are two available
                mechanisms to load these files:
                1) web.xml - can specify a list of bean files to load.  Note that this
                   mechanism is the same - the difference is that it only specifies 
                   this file.
                2) This file can be used with the spring bean "import" mechanism.  This 
                   mechanism works the same way the XSLT import works with the last 
                   import taking precedence (which for imports is typically not a problem
                   as they should be independent).  However, the 2nd part of this file
                   allows for an adopter to override any bean definition OR the adopter
                   can put all their overrides in a separate file and import that file
                   last etc.

                IMPORTANT IMPORT NOTES:
                Some beans have dependencies on other beans so inclusion of 1 file 
                may result in the need for additional file(s).  The request dispatcher 
                URL to controller mappings require that all controller objects be 
                defined.  In either case if a bean references another bean and that 
                bean/object is not defined the application will not start (you will
                see an error in the output log about bean definition missing/not found).
                
                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
                !!! IMPORTANT - SECURITY CONFIGURATION !!!
                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
                When making security config changes consult ALL the notes and comments 
                within the security files and the admin webapp's security_notes.txt 
                file.  At some point someone will document this but for now these 
                comments should provide enough help for a java web developer to be 
                able to connect the dots.

                If doing secure URLs at least two security definitions need to be 
                specified: the general (security.xml) and the specific security 
                configuration (security-xxx.xml) which supplements.
        -->
        <import resource="common.xml"/>
        <import resource="filter.xml"/>

        <import resource="security.xml"/>
        <import resource="security-pre_authenticated.xml"/>
        <import resource="security-db_authentication.xml"/>
        <import resource="security-xml_authentication.xml"/>
<!--
        <import resource="security-no_authentication.xml"/>
        <import resource="https.xml"/>
-->

        <import resource="indicator.xml"/>
        <import resource="query.xml"/>
        <import resource="query-definition.xml"/>
        <import resource="publication.xml"/>
        <import resource="community.xml"/>
        <import resource="topic.xml"/>
        <import resource="secure.xml"/>
        <import resource="user.xml"/>

        <import resource="view.xml"/>


        <bean id="siteSpecificDispatcherServletURLMap" class="java.util.HashMap">
                <description>
                        Defines the mapping of URL patterns to the appropriate IBIS-PH 
                        Controller.  The definitions are defined here and referenced in the
                        dispacther_servlet.xml file because the ds.xml load occurs after 
                        this bean file is processed which would require an adopter to have
                        to maintain and track the d_s.xml file.  Keeping them in this file
                        also is the right place as this file contains the bean imports.
                        
                        IMPORTANT IMPORT NOTE: 
                        The request URLs to controller mapping MUST match the specified 
                        controller.  Otherwise the application will not start and the log 
                        will show an undefined bean error in the log.  Make sure that the 
                        imports match the needed controller.

                        For example if secure query is wanted then the secure.xml spring bean 
                        controller definition file would need to imported.  The "secure" type
                        requests would then need to be mapped to the respective controller.

                        Note the first part of the controller name corresponds with the 
                        Spring bean definition file that includes that controller's 
                        definition (this is the case with all IBIS-PH Spring bean defs - 
                        they all have a prefix that is associated with the bean XML file.

                        ORDERING: The best practice is to be order most specific to least.
                </description>
                <constructor-arg>
                        <map>
                                <!-- D E F A U L T   H T M L   C O N T E N T -->
                                <entry key="/**/*.html" value-ref="viewHTMLContentConventionController"/>

                                <!-- Note these will only get hit for defined web.xml blanket 
                                        mappings so requests like indicator/ or query/ 
                                        but NOT about/ or topic/ as these have no web.xml mapping.
                                -->
                                <entry key="/*/"                value-ref="viewHTMLContentConventionController"/>

                                <!-- T O P I C -->
                                <entry key="/topic/**"                                          value-ref="topicHTMLContentConventionController"/>

                                <!-- C O M M U N I T Y -->
                                <entry key="/community/indicators/**"                   value-ref="communityIndicatorsController"/>
<entry key="/community/oindicators/**"                  value-ref="communityIndicatorsOldController"/>
<entry key="/community/facts/**"                                value-ref="communityFactsController"/>
        
                                <!-- I N D I C A T O R  -->
                                <entry key="/indicator/index/Alphabetical.html" value-ref="indicatorAlphabeticalIndexController"/>
                                <entry key="/indicator/index/DataSource.html"   value-ref="indicatorDataSourceIndexController"/>
                                <entry key="/indicator/index/Organization.html" value-ref="indicatorOrgUnitIndexController"/>
                                <entry key="/indicator/index/Set.html"                  value-ref="indicatorIndicatorSetIndexController"/>
                                <entry key="/indicator/index/Table.html"                value-ref="indicatorTableIndexController"/>
                                <entry key="/indicator/index/Demographic.html"  value-ref="indicatorDemographicIndexController"/>

                                <entry key="/indicator/summary/*.html"                  value-ref="indicatorSummaryViewController"/>
                                <entry key="/indicator/view/*.html"                             value-ref="indicatorViewController"/>
                                <entry key="/indicator/complete/*.html"                 value-ref="indicatorCompleteViewController"/>
                                <entry key="/indicator/facts/*.html"                    value-ref="indicatorImportantFactsController"/>
                                <entry key="/indicator/services/*.html"                 value-ref="indicatorServicesController"/>
                                <entry key="/indicator/related/*/*.html"                value-ref="indicatorRelatedIndicatorsController"/>
                                <entry key="/indicator/resources/*.html"                value-ref="indicatorResourcesController"/>

                                <entry key="/indicator/contentblocks/*.html"    value-ref="indicatorContentBlocksController"/>
<entry key="/indicator/content/*.js"                    value-ref="indicatorContentJavaScriptController"/>

                                <entry key="/indicator/preview/*.html"                  value-ref="indicatorPreviewController"/>
                                <entry key="/indicator/view/preview/*.html"             value-ref="indicatorViewPreviewController"/>

                                <!-- Q U E R Y  -->
                                <entry key="/query/selection/**"                                value-ref="querySelectionController"/>
                                <entry key="/query/configuration/**"                    value-ref="queryConfigurationController"/>
                                <entry key="/query/builder/**"                                  value-ref="queryBuilderController"/>
                                <entry key="/query/submit/**/*.html"                    value-ref="querySubmitController"/>
                                <entry key="/query/result/**/*.html"                    value-ref="queryResultController"/>
                                <entry key="/query/result/**/*.xls"                             value-ref="queryResultController"/>     <!-- put here so can plug in Excel specifici controller in the future. -->
                                <entry key="/query/result/**/*.xml"                             value-ref="queryIBISQResultController"/>        

                                <entry key="/query/contentblocks/**"                    value-ref="queryResultContentBlocksController"/>


                                <!-- Q U E R Y   D E F I N I T I O N -->
                                <entry key="/query/definition/list/*"                   value-ref="queryDefinitionListController"/>
                                <entry key="/query/definition/index/*"                  value-ref="queryDefinitionIndexController"/>
                                <entry key="/query/definition/detail/*/*"               value-ref="queryDefinitionDetailController"/>

                                <entry key="/query/definition/result/*/*"               value-ref="queryDefinitionResultController"/>
                                <entry key="/query/definition/builder/*/*"              value-ref="queryDefinitionBuilderController"/>
                                <entry key="/query/definition/contentblocks/**" value-ref="queryDefinitionResultContentBlocksController"/>

                                <entry key="/query/definition/save"                             value-ref="queryDefinitionSaveController"/>
                                <entry key="/query/definition/delete/*"                 value-ref="queryDefinitionDeleteController"/>
                                <entry key="/query/definition/set_apply"                value-ref="queryModuleToApplyQueryDefinitionController"/>

                                <!-- IMPORTANT NOTICE: If there are sensitive datasets that are 
                                        exposed via a Query Module and the IBISPH-VIEW to IBIS-Q
                                        then this proxy should either a) be removed from this file
                                        or b) have the proxy's application URL point to an invalid 
                                        URL or c) protect the request via spring security.  Also 
                                        make sure that all of those sensitive dataset URL requests 
                                        are protected and that the backend IBIS-Q CGI application 
                                        is not made available except to the ibisph-view webapp.
                                -->
                                <entry key="/query/proxy*"                      value-ref="queryQueryApplicationProxyController"/>


                                <!-- S E C U R E  -->
                                <entry key="/secure"                                                    value-ref="secureSelectionController"/>
                                <entry key="/secure/test.jsp"                                   value-ref="secureTestController"/>
                                <entry key="/secure/selection/*.html"                   value-ref="secureSelectionController"/>
                                <entry key="/secure/query/selection/**"                 value-ref="secureQuerySelectionController"/>
                                <entry key="/secure/query/builder/**"                   value-ref="secureQueryBuilderController"/>
                                <entry key="/secure/query/submit/**/*.html"             value-ref="secureQuerySubmitController"/>
                                <entry key="/secure/query/result/**/*.html"             value-ref="secureQueryResultController"/>
                                <entry key="/secure/query/result/**/*.xls"              value-ref="secureQueryResultController"/>
                                <entry key="/secure/query/result/**/*.xml"              value-ref="secureQueryIBISQResultController"/>  
                                <entry key="/secure/query/configuration/**"             value-ref="queryConfigurationController"/>

                                <entry key="/secure/query/definition/result/*/*"        value-ref="secureQueryDefinitionResultController"/>
                                <entry key="/secure/query/definition/builder/*/*"       value-ref="secureQueryDefinitionBuilderController"/>

                                <!-- U S E R   P R O F I L E -->
                                <entry key="/user/Login.html"                                   value-ref="userLoginController"/>
                                <entry key="/user/Selections.html"                              value-ref="userSelectionsController"/>

                                <entry key="/user/Registration.html"                    value-ref="userEditRegistrationController"/>
                                <entry key="/user/registration/save"                    value-ref="userSaveRegistrationController"/>
                                <entry key="/user/registration/verify/**"               value-ref="userVerifyRegistrationController"/>

                                <entry key="/user/Access.html"                                  value-ref="userAccessController"/>
                                <entry key="/user/status"                                               value-ref="userStatusController"/>
                                <entry key="/user/access/email"                                 value-ref="userEmailAccessController"/>


                                <!-- G E N E R I C   T R A S F O R M A T I O N -->
                                <!-- 
                                        This controller is needed for adhoc system reports to work.  
                                        At one point it was thought to not enable this controller as 
                                        it could be a potential security risk because it would bypass 
                                        the spring security mechanism.  However, this is NOT the case 
                                        as the controller only can access xml files within its 
                                        configuration limitation or via the xmlURL request parameter.  
                                        In either case if there were sensitive data in these files 
                                        they should NEVER be placed in a non secured, public facing 
                                        webapp/directory.  

                                        To be safe, it is probably still best to remove this request
                                        from production deployements.  It should only be enabled for
                                        local query module development and testing environment where
                                        the QM developer wants to test their XML files.
                                -->
                                <entry key="/view.html"                 value-ref="viewHTTPXMLXSLTRequestParameterController"/>


                                <!-- F I L E   C O N T E N T   S T R E A M E R -->
                                <entry key="/contentfile/WEB-INF/**"    value-ref="viewAccessDeniedController"/>
                                <entry key="/contentfile/**"                    value-ref="viewGetFileController"/>

                        </map>
                </constructor-arg>
        </bean>


        <!--
                ADOPTER BEAN DEFINITION OVERRIDES AND PROPERTY OVERRIDES
                This section provides the adopter a mechanism to override bean definitions 
                and property values.  Theses bean definitions should be listed AFTER ALL
                imported bean files.  
        -->

<!-- uncomment if wanting ss props in the webapps dir.  Make sure to ref this bean below...
        <bean id="siteSpecificWebappsRootURL" class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
                <property name="targetObject" ref="commonContextAndPathService"/>
                <property name="targetMethod" value="getPathURL"/>
                <property name="arguments"><list><value>..</value></list></property>
        </bean>
-->

        <bean id="siteSpecificPropertyOverrides" class="org.springframework.beans.factory.config.PropertyOverrideConfigurer">
                <description>
                        Defines optional special property file(s) that contain property 
                        overrides.  These differ in that the beanID:propertyName is on the 
                        left side with the right containing the value to be injected into 
                        the bean.  Property files are only able to provide string and numeric 
                        type data values/value overrides.  These property files are optional 
                        and might not want to be/need to be used by an adopter to keep their
                        configuration files more concise and simpler - the property values 
                        can simply be placed in this file.  Where property files are of 
                        value is when being deployed to different servers where each server 
                        has it's own file path, IBISQ url, JNDI name, etc.

                        The locations define where these override files could be located.
                        If one exists in all directories then the last definition is the
                        value that eventually is used.  If the file does not exist the 
                        ignore setting specifies to move on.  If false and a file is not
                        found then the app will not start.  

                        For local development in MS-Windows put a ibisph-view.properties
                        property override file in your c:\users\your_username directory.
                        Only include those values needed to override/supplement your 
                        current settings already specified.

                        IMPORTANT NOTES: If you have the files located outside of the webapp
                        container you need to make sure that the file privs are setup 
                        correctly.  The ${user.home} is a special environment value that 
                        should work for Windows and Linux.  Relative file paths are only 
                        supported for relative paths within the webapp.  For property files
                        outside of the webapp you must use a fully qualified URL value with 
                        outside relative "../xyz" paths not being fully supported due to 
                        the spring using whatever concreate ResourceLoader object.

                        Property files can only set a bean's (object) string/numeric values.  
                </description>
                <property name="ignoreResourceNotFound" value="true"/>
                <property name="locations">
                        <list>
                                <value>WEB-INF/config/SiteSpecific.properties</value>

                                <!-- if wanting prop file in the webapps dir then 
                                        1) uncomment the below refed bean (above).
                                        2) uncomment the ref to the bean (below).
                                <value>#{siteSpecificWebappsRootURL}/nmepht-view.properties</value>

                                The direct relative to webapp path does NOT work - can't remember
                                why but debugging showed the path is relative to the app server 
                                - not the app context (can't remember why the sub dir WEB-INF
                                works?).  Must use the bean which knows about the app context.  
                                <value>../relative_context_path_that does_not_work.properties</value>
                                -->

                                <value>file:${user.home}/ibisph-view.properties</value>
                        </list>
                </property>
        </bean>


        <!-- This method invoke call verifies the existance of the published 
                indicators XML file.  If it does not exist then creates it based on the
                existing IP XML files.  This is useful for new deployments or if the XML 
                is corrupt etc.  Typically used when the adopter wants to rebuild the 
                XML (1. delete the published IPs XML file, 2. restart the app).  The 
                admin app is responsible to maintain the published IPs XML file via an 
                IP publish request so this call should not be needed.  It is provided as
                a safety feature that some direct content adopters may want to include.

                REMOTE CONTENT NOTE: this verify service is of no value as the content 
                is located on a different server and thus can NOT create, update, delete
                this file.  For remote content the IPs XML and published IPs XML file is 
                either managed by the admin app's publishing or by an adopter manually 
                maintaining their content.
        <bean id="siteSpecificVerifyPublishedIndicatorsXMLFileService" 
                class="org.springframework.beans.factory.config.MethodInvokingFactoryBean"
        >
                <property name="targetObject">
                        <bean class="org.ibisph.indicatorprofile.service.PublishedIndicatorsXML">
                                <property name="publishedIndicatorsFilePathAndName" value="#{indicatorPublishedIndicatorsFilePathAndName.string}"/>
                                <property name="indicatorProfileFilePath" value="#{indicatorProfileFilePath.string}"/>
                                <property name="documentDAOService"             ref="commonPublishedDocumentDAOService"/>
                        </bean>
                </property>
                <property name="targetMethod" value="verifyPublishedIndicatorsXMLFile"/>
        </bean>
        -->


        <bean id="securityAuthenticationProviderList" class="java.util.ArrayList">
                <description>
                        Defines the types of provides to be used for authenticating a user.
                        This list can be 1:n with the first being tried then the next etc
                        until successful/all providers have been tried.

                        Note that you MUST have the appropriate/associated spring bean xml
                        file included/imported to be able to use the selected provider.
                </description>
                <constructor-arg>
                        <list>
                                <ref bean="securityPreAuthenticatedAuthenticationProvider"/>
                                <ref bean="securityDBAuthenticationProvider"/>
                                <ref bean="securityXMLAuthenticationProvider"/>
                        </list>
                </constructor-arg>
        </bean>

        <!-- For development use the standard, non caching XSLT transformer.  Default 
                common is the caching version: org.ibisph.xslt.CachedSaxonTransformerFactory.
        -->
        <bean id="commonXSLTTransformerFactory" class="net.sf.saxon.TransformerFactoryImpl"/>

</beans>