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

Last change on this file since 22683 was 22683, checked in by GarthBraithwaite_STG, 2 months ago

view - Implemented normal content path and published path with updated comments. Removed report requests as not currently implemented in v3 with no signs of ever being. css tweaks.

File size: 18.5 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2
3<beans default-lazy-init="false" default-autowire="no"
4        xmlns="http://www.springframework.org/schema/beans"
5        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd"
7>
8        <!--
9                This file has 3 functions:
10                1) Specify/load the application's spring bean definition files.
11                2) Provide the dispatcher servlet URL to controller mappings.
12                3) Override any spring bean definitions as per adopter's specific needs.
13                   Note that the properties file should be configured in this file IF
14                   they are needed/used.
15        -->
16
17        <!--
18                SPRING APPLICATION CONTENT DEFINITION FILES / SPRING BEAN IMPORTS
19                Specifies the Spring application context definition files which are
20                responsible for creating the application's objects.  To keep these
21                definitions more maintainable the bean definitions are stored in their
22                own file (beans are grouped by functionality).  There are two available
23                mechanisms to load these files:
24                1) web.xml - can specify a list of bean files to load.  Note that this
25                   mechanism is the same - the difference is that it only specifies
26                   this file.
27                2) This file can be used with the spring bean "import" mechanism.  This
28                   mechanism works the same way the XSLT import works with the last
29                   import taking precedence (which for imports is typically not a problem
30                   as they should be independent).  However, the 2nd part of this file
31                   allows for an adopter to override any bean definition OR the adopter
32                   can put all their overrides in a separate file and import that file
33                   last etc.
34
35                IMPORTANT IMPORT NOTES:
36                Some beans have dependencies on other beans so inclusion of 1 file
37                may result in the need for additional file(s).  The request dispatcher
38                URL to controller mappings require that all controller objects be
39                defined.  In either case if a bean references another bean and that
40                bean/object is not defined the application will not start (you will
41                see an error in the output log about bean definition missing/not found).
42               
43                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
44                !!! IMPORTANT - SECURITY CONFIGURATION !!!
45                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46                When making security config changes consult ALL the notes and comments
47                within the security files and the admin webapp's security_notes.txt
48                file.  At some point someone will document this but for now these
49                comments should provide enough help for a java web developer to be
50                able to connect the dots.
51
52                If doing secure URLs at least two security definitions need to be
53                specified: the general (security.xml) and the specific security
54                configuration (security-xxx.xml) which supplements.
55        -->
56        <import resource="common.xml"/>
57        <import resource="filter.xml"/>
58
59        <import resource="security.xml"/>
60        <import resource="security-pre_authenticated.xml"/>
61        <import resource="security-db_authentication.xml"/>
62        <import resource="security-xml_authentication.xml"/>
63<!--
64        <import resource="security-no_authentication.xml"/>
65        <import resource="https.xml"/>
66-->
67
68        <import resource="indicator.xml"/>
69        <import resource="query.xml"/>
70        <import resource="query-definition.xml"/>
71        <import resource="publication.xml"/>
72        <import resource="community.xml"/>
73        <import resource="topic.xml"/>
74        <import resource="secure.xml"/>
75        <import resource="user.xml"/>
76
77        <import resource="view.xml"/>
78
79
80        <bean id="siteSpecificDispatcherServletURLMap" class="java.util.HashMap">
81                <description>
82                        Defines the mapping of URL patterns to the appropriate IBIS-PH
83                        Controller.  The definitions are defined here and referenced in the
84                        dispacther_servlet.xml file because the ds.xml load occurs after
85                        this bean file is processed which would require an adopter to have
86                        to maintain and track the d_s.xml file.  Keeping them in this file
87                        also is the right place as this file contains the bean imports.
88                       
89                        IMPORTANT IMPORT NOTE:
90                        The request URLs to controller mapping MUST match the specified
91                        controller.  Otherwise the application will not start and the log
92                        will show an undefined bean error in the log.  Make sure that the
93                        imports match the needed controller.
94
95                        For example if secure query is wanted then the secure.xml spring bean
96                        controller definition file would need to imported.  The "secure" type
97                        requests would then need to be mapped to the respective controller.
98
99                        Note the first part of the controller name corresponds with the
100                        Spring bean definition file that includes that controller's
101                        definition (this is the case with all IBIS-PH Spring bean defs -
102                        they all have a prefix that is associated with the bean XML file.
103
104                        ORDERING: The best practice is to be order most specific to least.
105                </description>
106                <constructor-arg>
107                        <map>
108                                <!-- D E F A U L T   H T M L   C O N T E N T -->
109                                <entry key="/**/*.html" value-ref="viewHTMLContentConventionController"/>
110
111                                <!-- Note these will only get hit for defined web.xml blanket
112                                        mappings so requests like indicator/ or query/
113                                        but NOT about/ or topic/ as these have no web.xml mapping.
114                                -->
115                                <entry key="/*/"                value-ref="viewHTMLContentConventionController"/>
116
117                                <!-- T O P I C -->
118                                <entry key="/topic/**"                                          value-ref="topicHTMLContentConventionController"/>
119
120                                <!-- C O M M U N I T Y -->
121                                <entry key="/community/indicators/**"                   value-ref="communityIndicatorsReportController"/>
122                                <entry key="/community/indicator/**"                    value-ref="communityIndicatorReportController"/>
123                                <entry key="/community/facts/**"                                value-ref="communityFactsController"/>
124
125                                <!-- I N D I C A T O R  -->
126                                <entry key="/indicator/index/Alphabetical.html" value-ref="indicatorAlphabeticalIndexController"/>
127                                <entry key="/indicator/index/DataSource.html"   value-ref="indicatorDataSourceIndexController"/>
128                                <entry key="/indicator/index/Organization.html" value-ref="indicatorOrgUnitIndexController"/>
129                                <entry key="/indicator/index/Set.html"                  value-ref="indicatorIndicatorSetIndexController"/>
130                                <entry key="/indicator/index/Table.html"                value-ref="indicatorTableIndexController"/>
131                                <entry key="/indicator/index/Categorized.html"  value-ref="indicatorCategorizedIndexController"/>
132                                <entry key="/indicator/index/Demographic.html"  value-ref="indicatorDemographicIndexController"/>
133<!--
134                                <entry key="/indicator/default/*.html"     value-ref="indicatorDefaultViewController"/>
135-->
136                                <entry key="/indicator/summary/*.html"                  value-ref="indicatorSummaryViewController"/>
137                                <entry key="/indicator/view/*.html"                             value-ref="indicatorViewController"/>
138                                <entry key="/indicator/complete/*.html"                 value-ref="indicatorCompleteViewController"/>
139                                <entry key="/indicator/facts/*.html"                    value-ref="indicatorImportantFactsController"/>
140                                <entry key="/indicator/services/*.html"                 value-ref="indicatorServicesController"/>
141                                <entry key="/indicator/related/*/*.html"                value-ref="indicatorRelatedIndicatorsController"/>
142                                <entry key="/indicator/resources/*.html"                value-ref="indicatorResourcesController"/>
143
144                                <entry key="/indicator/view/*.json"                             value-ref="indicatorViewJSONController"/>
145                                <entry key="/indicator/*.json"                                  value-ref="indicatorJSONController"/>
146
147                                <entry key="/indicator/contentblocks/*.html"    value-ref="indicatorContentBlocksController"/>
148
149                                <entry key="/indicator/preview/*.html"                  value-ref="indicatorPreviewController"/>
150                                <entry key="/indicator/view/preview/*.html"             value-ref="indicatorViewPreviewController"/>
151
152                                <!-- Q U E R Y  -->
153                                <entry key="/query/selection/**"                                value-ref="querySelectionController"/>
154                                <entry key="/query/configuration/**"                    value-ref="queryConfigurationController"/>
155                                <entry key="/query/builder/**"                                  value-ref="queryBuilderController"/>
156                                <entry key="/query/submit/**/*.html"                    value-ref="querySubmitController"/>
157                                <entry key="/query/result/**/*.html"                    value-ref="queryResultController"/>
158                                <entry key="/query/result/**/*.xls"                             value-ref="queryResultController"/>     <!-- put here so can plug in Excel specifici controller in the future. -->
159                                <entry key="/query/result/**/*.xml"                             value-ref="queryIBISQResultController"/>       
160
161                                <entry key="/query/contentblocks/**"                    value-ref="queryResultContentBlocksController"/>
162
163
164                                <!-- Q U E R Y   D E F I N I T I O N -->
165                                <entry key="/query/definition/list/*"                   value-ref="queryDefinitionListController"/>
166                                <entry key="/query/definition/index/*"                  value-ref="queryDefinitionIndexController"/>
167                                <entry key="/query/definition/detail/*/*"               value-ref="queryDefinitionDetailController"/>
168
169                                <entry key="/query/definition/result/*/*"               value-ref="queryDefinitionResultController"/>
170                                <entry key="/query/definition/builder/*/*"              value-ref="queryDefinitionBuilderController"/>
171                                <entry key="/query/definition/contentblocks/**" value-ref="queryDefinitionResultContentBlocksController"/>
172
173                                <entry key="/query/definition/save"                             value-ref="queryDefinitionSaveController"/>
174                                <entry key="/query/definition/delete/*"                 value-ref="queryDefinitionDeleteController"/>
175                                <entry key="/query/definition/set_apply"                value-ref="queryModuleToApplyQueryDefinitionController"/>
176
177                                <!-- IMPORTANT NOTICE: If there are sensitive datasets that are
178                                        exposed via a Query Module and the IBISPH-VIEW to IBIS-Q
179                                        then this proxy should either a) be removed from this file
180                                        or b) have the proxy's application URL point to an invalid
181                                        URL or c) protect the request via spring security.  Also
182                                        make sure that all of those sensitive dataset URL requests
183                                        are protected and that the backend IBIS-Q CGI application
184                                        is not made available except to the ibisph-view webapp.
185                                -->
186                                <entry key="/query/proxy*"                      value-ref="queryQueryApplicationProxyController"/>
187
188
189                                <!-- S E C U R E  -->
190                                <entry key="/secure"                                                    value-ref="secureSelectionController"/>
191                                <entry key="/secure/test.jsp"                                   value-ref="secureTestController"/>
192                                <entry key="/secure/selection/*.html"                   value-ref="secureSelectionController"/>
193                                <entry key="/secure/query/selection/**"                 value-ref="secureQuerySelectionController"/>
194                                <entry key="/secure/query/builder/**"                   value-ref="secureQueryBuilderController"/>
195                                <entry key="/secure/query/submit/**/*.html"             value-ref="secureQuerySubmitController"/>
196                                <entry key="/secure/query/result/**/*.html"             value-ref="secureQueryResultController"/>
197                                <entry key="/secure/query/result/**/*.xls"              value-ref="secureQueryResultController"/>
198                                <entry key="/secure/query/result/**/*.xml"              value-ref="secureQueryIBISQResultController"/> 
199                                <entry key="/secure/query/configuration/**"             value-ref="queryConfigurationController"/>
200
201                                <entry key="/secure/query/definition/result/*/*"        value-ref="secureQueryDefinitionResultController"/>
202                                <entry key="/secure/query/definition/builder/*/*"       value-ref="secureQueryDefinitionBuilderController"/>
203
204                                <!-- U S E R   P R O F I L E -->
205                                <entry key="/user/Login.html"                                   value-ref="userLoginController"/>
206                                <entry key="/user/Selections.html"                              value-ref="userSelectionsController"/>
207
208                                <entry key="/user/Registration.html"                    value-ref="userEditRegistrationController"/>
209                                <entry key="/user/registration/save"                    value-ref="userSaveRegistrationController"/>
210                                <entry key="/user/registration/verify/**"               value-ref="userVerifyRegistrationController"/>
211
212                                <entry key="/user/Access.html"                                  value-ref="userAccessController"/>
213                                <entry key="/user/status"                                               value-ref="userStatusController"/>
214                                <entry key="/user/access/email"                                 value-ref="userEmailAccessController"/>
215
216<!-- These should be implemented inplace of above requests.
217                                <entry key="/user/Profile.html"                                 value-ref="userEditProfileController"/>
218                                <entry key="/user/profile/save"                                 value-ref="userSaveProfileController"/>
219                                <entry key="/user/profile/delete"                               value-ref="userDeleteProfileController"/>
220
221doesn't work:
222<entry key="/user/Login.json"           value-ref="securityAjaxLoginController"/>
223-->
224
225                                <!-- S E A R C H
226                                <entry key="/search" value-ref="viewSearchController"/>
227-->
228
229                                <!-- G E N E R I C   T R A S F O R M A T I O N -->
230                                <!--
231                                        This controller is needed for adhoc system reports to work. 
232                                        At one point it was thought to not enable this controller as
233                                        it could be a potential security risk because it would bypass
234                                        the spring security mechanism.  However, this is NOT the case
235                                        as the controller only can access xml files within its
236                                        configuration limitation or via the xmlURL request parameter. 
237                                        In either case if there were sensitive data in these files
238                                        they should NEVER be placed in a non secured, public facing
239                                        webapp/directory. 
240
241                                        To be safe, it is probably still best to remove this request
242                                        from production deployements.  It should only be enabled for
243                                        local query module development and testing environment where
244                                        the QM developer wants to test their XML files.
245                                -->
246                                <entry key="/view.html"                 value-ref="viewHTTPXMLXSLTRequestParameterController"/>
247
248                                <!-- F I L E   C O N T E N T   S T R E A M E R -->
249                                <entry key="/view/WEB-INF/**"   value-ref="viewAccessDeniedController"/>
250                                <entry key="/view/**"                   value-ref="viewGetFileController"/>
251
252                        </map>
253                </constructor-arg>
254        </bean>
255
256
257        <!--
258                ADOPTER BEAN DEFINITION OVERRIDES AND PROPERTY OVERRIDES
259                This section provides the adopter a mechanism to override bean definitions
260                and property values.  Theses bean definitions should be listed AFTER ALL
261                imported bean files. 
262        -->
263
264        <bean id="siteSpecificPropertyOverrides" class="org.springframework.beans.factory.config.PropertyOverrideConfigurer">
265                <description>
266                        Defines optional special property file(s) that contain property
267                        overrides.  These differ in that the beanID:propertyName is on the
268                        left side with the right containing the value to be injected into
269                        the bean.  Property files are only able to provide string and numeric
270                        type data values/value overrides.  These property files are optional
271                        and might not want to be/need to be used by an adopter to keep their
272                        configuration files more concise and simpler - the property values
273                        can simply be placed in this file.  Where property files are of
274                        value is when being deployed to different servers where each server
275                        has it's own file path, IBISQ url, JNDI name, etc.
276
277                        The locations define where these override files could be located.
278                        If one exists in all directories then the last definition is the
279                        value that eventually is used.  If the file does not exist the
280                        ignore setting specifies to move on.  If false and a file is not
281                        found then the app will not start. 
282
283                        For local development in MS-Windows put a ibisph-view.properties
284                        property override file in your c:\users\your_username directory.
285                        Only include those values needed to override/supplement your
286                        current settings already specified.
287
288                        IMPORTANT NOTES: If you have the files located outside of the webapp
289                        container you need to make sure that the file privs are setup
290                        correctly.  The ${user.home} is a special environment value that
291                        should work for Windows and Linux - again make sure of file privs.
292
293                        Property files can inject string/numeric property values into an
294                        existing object/defined bean.  Beans files define objects and that
295                        object's properties/dependent objects.
296                </description>
297                <property name="ignoreResourceNotFound" value="true"/>
298                <property name="locations">
299                        <list>
300                                <value>WEB-INF/config/SiteSpecific.properties</value>
301                                <value>file:../ibisph-view_core.properties</value>
302                                <value>file:${user.home}/ibisph-view_core.properties</value>
303                        </list>
304                </property>
305        </bean>
306
307        <!-- IBISQ REQUEST URL EXAMPLE OF NOT USING THE ABOVE property override file:
308        <bean id="queryQueryApplicationRequestBasePath" class="org.ibisph.model.StringHolder">
309                <constructor-arg value="http://123.222.100.33:8080/cgi-bin/hi_iq_func.exe"/>
310        </bean>
311        -->
312
313
314        <!-- This method invoke call verifies the existance of the published
315                indicators XML file.  If it does not exist then creates it based on the
316                existing IP XML files.  This is useful for new deployments or if the XML
317                is corrupt etc.  Typically used when the adopter wants to rebuild the
318                XML (1. delete the published IPs XML file, 2. restart the app).  The
319                admin app is responsible to maintain the published IPs XML file via an
320                IP publish request so this call should not be needed.  It is provided as
321                a safety feature that some direct content adopters may want to include.
322
323                REMOTE CONTENT NOTE: this verify service is of no value as the content
324                is located on a different server and thus can NOT create, update, delete
325                this file.  For remote content the IPs XML and published IPs XML file is
326                either managed by the admin app's publishing or by an adopter manually
327                maintaining their content.
328        <bean id="siteSpecificVerifyPublishedIndicatorsXMLFileService"
329                class="org.springframework.beans.factory.config.MethodInvokingFactoryBean"
330        >
331                <property name="targetObject">
332                        <bean class="org.ibisph.indicatorprofile.service.PublishedIndicatorsXML">
333                                <property name="publishedIndicatorsFilePathAndName" value="#{indicatorPublishedIndicatorsFilePathAndName.string}"/>
334                                <property name="indicatorProfileFilePath" value="#{indicatorProfileFilePath.string}"/>
335                                <property name="documentDAOService"             ref="commonContentDocumentDAOService"/>
336                        </bean>
337                </property>
338                <property name="targetMethod" value="verifyPublishedIndicatorsXMLFile"/>
339        </bean>
340        -->
341
342
343        <bean id="securityAuthenticationProviderList" class="java.util.ArrayList">
344                <description>
345                        Defines the types of provides to be used for authenticating a user.
346                        This list can be 1:n with the first being tried then the next etc
347                        until successful/all providers have been tried.
348
349                        Note that you MUST have the appropriate/associated spring bean xml
350                        file included/imported to be able to use the selected provider.
351                </description>
352                <constructor-arg>
353                        <list>
354                                <ref bean="securityPreAuthenticatedAuthenticationProvider"/>
355                                <ref bean="securityDBAuthenticationProvider"/>
356                                <ref bean="securityXMLAuthenticationProvider"/>
357                        </list>
358                </constructor-arg>
359        </bean>
360
361        <!-- For development use the standard, non caching XSLT transformer.  Default
362                common is the caching version: org.ibisph.xslt.CachedSaxonTransformerFactory.
363        -->
364        <bean id="commonXSLTTransformerFactory" class="net.sf.saxon.TransformerFactoryImpl"/>
365
366</beans>
Note: See TracBrowser for help on using the repository browser.