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

Last change on this file since 19820 was 19820, checked in by GarthBraithwaite_STG, 2 years ago

view content - topic pages - standardized icon names and topic category titles and dir names. Created _Introduction.xml include for welcome and intro pages. Changed TopicSelection?.xml selection groups to the flow order. Added the approved logo.

File size: 19.7 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="report.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                                <entry key="/*"         value-ref="viewHTMLContentConventionController"/>
117
118                                <!-- P U B L I C A T I O N S -->
119                                <entry key="/publication/index/Chronological.html" value-ref="publicationChronologicalIndexController"/>
120                                <entry key="/publication/index/Topical.html"       value-ref="publicationTopicalIndexController"/>
121
122                                <!-- I N D I C A T O R  -->
123                                <entry key="/indicator/index/Alphabetical.html"  value-ref="indicatorAlphabeticalIndexController"/>
124                                <entry key="/indicator/index/DataSource.html"    value-ref="indicatorDataSourceIndexController"/>
125                                <entry key="/indicator/index/Organization.html"  value-ref="indicatorOrgUnitIndexController"/>
126                                <entry key="/indicator/index/Set.html"           value-ref="indicatorIndicatorSetIndexController"/>
127                                <entry key="/indicator/index/Table.html"         value-ref="indicatorTableIndexController"/>
128                                <entry key="/indicator/index/Categorized.html"   value-ref="indicatorCategorizedIndexController"/>
129<!--
130                                <entry key="/indicator/default/*.html"       value-ref="indicatorDefaultViewController"/>
131-->
132                                <entry key="/indicator/summary/*.html"       value-ref="indicatorSummaryViewController"/>
133                                <entry key="/indicator/view/*.html"          value-ref="indicatorViewController"/>
134                                <entry key="/indicator/facts/*.html"         value-ref="indicatorImportantFactsController"/>
135                                <entry key="/indicator/services/*.html"      value-ref="indicatorServicesController"/>
136                                <entry key="/indicator/related/*/*.html"     value-ref="indicatorRelatedIndicatorsController"/>
137                                <entry key="/indicator/resources/*.html"     value-ref="indicatorResourcesController"/>
138                                <entry key="/indicator/complete_profile/*.html" value-ref="indicatorCompleteViewController"/>
139
140                                <entry key="/indicator/view/*.json"          value-ref="indicatorViewJSONController"/>
141                                <entry key="/indicator/*.json"               value-ref="indicatorJSONController"/>
142
143                                <entry key="/indicator/contentblocks/*.html" value-ref="indicatorContentBlocksController"/>
144
145                                <entry key="/indicator/preview/*.html"       value-ref="indicatorPreviewController"/>
146                                <entry key="/indicator/view/preview/*.html"  value-ref="indicatorViewPreviewController"/>
147
148                                <!-- C O M M U N I T Y -->
149                                <entry key="/community/index/*.html"        value-ref="communityIndexController"/>
150                                <entry key="/community/indicators/**"       value-ref="communityIndicatorsReportController"/>
151                                <entry key="/community/indicator/**"        value-ref="communityIndicatorReportController"/>
152                                <entry key="/community/facts/**"            value-ref="communityFactsController"/>
153
154                                <!-- Q U E R Y  -->
155                                <entry key="/query/selection/**"             value-ref="querySelectionController"/>
156                                <entry key="/query/configuration/**"         value-ref="queryConfigurationController"/>
157                                <entry key="/query/builder/**"               value-ref="queryBuilderController"/>
158                                <entry key="/query/submit/**/*.html"         value-ref="querySubmitController"/>
159                                <entry key="/query/submit/**/*.xml"          value-ref="querySubmitAndRunToXMLController"/>
160                                <entry key="/query/result/**/*.html"         value-ref="queryResultController"/>
161                                <entry key="/query/result/**/*.xls"          value-ref="queryResultController"/>        <!-- put here so can plug in Excel specifici controller in the future. -->
162                                <entry key="/query/result/**/*.xml"          value-ref="queryIBISQResultController"/>   
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
168                                <entry key="/query/definition/detail/*/*"    value-ref="queryDefinitionDetailController"/>
169                                <entry key="/query/definition/result/*/*"    value-ref="queryDefinitionResultController"/>
170                                <entry key="/query/definition/builder/*/*"   value-ref="queryDefinitionBuilderController"/>
171                                <entry key="/query/definition/apply/*/*"     value-ref="queryDefinitionApplyController"/>
172                                <entry key="/query/definition/toggle/sticky" value-ref="queryDefinitionToggleStickySessionController"/>
173
174                                <entry key="/query/definition/from/builder"  value-ref="queryDefinitionFromBuilderController"/>
175                                <entry key="/query/definition/from/result"   value-ref="queryDefinitionFromResultController"/>
176                                <entry key="/query/definition/save"          value-ref="queryDefinitionSaveController"/>
177                                <entry key="/query/definition/delete/*"      value-ref="queryDefinitionDeleteController"/>
178
179
180                                <!-- S E C U R E  -->
181                                <entry key="/secure"                                value-ref="secureSelectionController"/>
182                                <entry key="/secure/test.jsp"                       value-ref="secureTestController"/>
183                                <entry key="/secure/selection/*.html"               value-ref="secureSelectionController"/>
184                                <entry key="/secure/query/selection/**"             value-ref="secureQuerySelectionController"/>
185                                <entry key="/secure/query/builder/**"               value-ref="secureQueryBuilderController"/>
186                                <entry key="/secure/query/submit/**/*.html"         value-ref="secureQuerySubmitController"/>
187                                <entry key="/secure/query/submit/**/*.xml"          value-ref="secureQuerySubmitAndRunToXMLController"/>
188                                <entry key="/secure/query/result/**/*.html"         value-ref="secureQueryResultController"/>
189                                <entry key="/secure/query/result/**/*.xls"          value-ref="secureQueryResultController"/>
190                                <entry key="/secure/query/result/**/*.xml"          value-ref="secureQueryIBISQResultController"/>     
191                                <entry key="/secure/query/configuration/**"         value-ref="queryConfigurationController"/>
192
193                                <entry key="/secure/query/definition/detail/*/*"    value-ref="secureQueryDefinitionDetailController"/>
194                                <entry key="/secure/query/definition/result/*/*"    value-ref="secureQueryDefinitionResultController"/>
195                                <entry key="/secure/query/definition/builder/*/*"   value-ref="secureQueryDefinitionBuilderController"/>
196                                <entry key="/secure/query/definition/apply/*/*"     value-ref="secureQueryDefinitionApplyController"/>
197                                <entry key="/secure/query/definition/from/builder"  value-ref="secureQueryDefinitionFromBuilderController"/>
198                                <entry key="/secure/query/definition/from/result"   value-ref="secureQueryDefinitionFromResultController"/>
199
200
201
202                                <!-- R E P O R T
203                                <entry key="/report/*/summary/*.html"       value-ref="reportIndicatorViewController"/>
204                                <entry key="/report/*/complete/*.html"      value-ref="reportIndicatorViewController"/>
205                                <entry key="/report/highligh/**/*.html"     value-ref="reportIndicatorViewController"/>
206-->
207                                <!-- R E P O R T -->
208                                <entry key="/report/*/*/*.html"                   value-ref="reportIndicatorViewController"/>
209                                <entry key="/report/*/*.html"                     value-ref="reportHTMLContentController"/>
210
211
212                                <!-- U S E R   P R O F I L E -->
213                                <entry key="/user/Login.html"               value-ref="userLoginController"/>
214                                <entry key="/user/Selections.html"          value-ref="userSelectionsController"/>
215
216                                <entry key="/user/Registration.html"        value-ref="userEditRegistrationController"/>
217                                <entry key="/user/registration/save"        value-ref="userSaveRegistrationController"/>
218                                <entry key="/user/registration/verify/**"   value-ref="userVerifyRegistrationController"/>
219
220                                <entry key="/user/Access.html"              value-ref="userAccessController"/>
221                                <entry key="/user/status"                   value-ref="userStatusController"/>
222                                <entry key="/user/access/email"             value-ref="userEmailAccessController"/>
223<!--
224                                <entry key="/user/Profile.html"             value-ref="userEditProfileController"/>
225                                <entry key="/user/profile/save"             value-ref="userSaveProfileController"/>
226                                <entry key="/user/profile/delete"           value-ref="userDeleteProfileController"/>
227-->
228
229                                <!-- M E T A D A T A   X M L   F I L E -->
230                                <entry key="/dataportal/metadata/*.html" value-ref="viewXMLAsHTMLController"/>
231
232
233                                <!-- S E A R C H
234                                <entry key="/search" value-ref="viewSearchController"/>
235-->
236
237                                <!-- G E N E R I C   T R A S F O R M A T I O N -->
238                                <!--
239                                        This controller is needed for adhoc system reports to work. 
240                                        At one point it was thought to not enable this controller as
241                                        it could be a potential security risk because it would bypass
242                                        the spring security mechanism.  However, this is NOT the case
243                                        as the controller only can access xml files within its
244                                        configuration limitation or via the xmlURL request parameter. 
245                                        In either case if there were sensitive data in these files
246                                        they should NEVER be placed in a non secured, public facing
247                                        webapp/directory. 
248
249                                        To be safe, it is probably still best to remove this request
250                                        from production deployements.  It should only be enabled for
251                                        local query module development and testing environment where
252                                        the QM developer wants to test their XML files.
253                                -->
254                                <entry key="/view.html" value-ref="viewHTTPXMLXSLTRequestParameterController"/>
255
256                                <!-- F I L E   C O N T E N T   S T R E A M E R -->
257                                <entry key="/view/WEB-INF/**" value-ref="viewAccessDeniedController"/>
258                                <entry key="/view/**"         value-ref="viewGetFileController"/>
259
260                        </map>
261                </constructor-arg>
262        </bean>
263
264
265        <!--
266                ADOPTER BEAN DEFINITION OVERRIDES AND PROPERTY OVERRIDES
267                This section provides the adopter a mechanism to override bean definitions
268                and property values.  Theses bean definitions should be listed AFTER ALL
269                imported bean files. 
270        -->
271
272        <bean id="siteSpecificPropertyOverrides" class="org.springframework.beans.factory.config.PropertyOverrideConfigurer">
273                <description>
274                        Defines optional special property file(s) that contain property
275                        overrides.  These differ in that the beanID:propertyName is on the
276                        left side with the right containing the value to be injected into
277                        the bean.  Property files are only able to provide string and numeric
278                        type data values/value overrides.  These property files are optional
279                        and might not want to be/need to be used by an adopter to keep their
280                        configuration files more concise and simpler - the property values
281                        can simply be placed in this file.  Where property files are of
282                        value is when being deployed to different servers where each server
283                        has it's own file path, IBISQ url, JNDI name, etc.
284
285                        The locations define where these override files could be located.
286                        If one exists in all directories then the last definition is the
287                        value that eventually is used.  If the file does not exist the
288                        ignore setting specifies to move on.  If false and a file is not
289                        found then the app will not start. 
290
291                        For local development in MS-Windows put a ibisph-view.properties
292                        property override file in your c:\users\your_username directory.
293                        Only include those values needed to override/supplement your
294                        current settings already specified.
295
296                        IMPORTANT NOTES: If you have the files located outside of the webapp
297                        container you need to make sure that the file privs are setup
298                        correctly.  The ${user.home} is a special environment value that
299                        should work for Windows and Linux - again make sure of file privs.
300
301                        Property files can inject string/numeric property values into an
302                        existing object/defined bean.  Beans files define objects and that
303                        object's properties/dependent objects.
304                </description>
305                <property name="ignoreResourceNotFound" value="true"/>
306                <property name="locations">
307                        <list>
308                                <value>WEB-INF/config/SiteSpecific.properties</value>
309                                <value>file:../ibisph-view_core.properties</value>
310                                <value>file:${user.home}/ibisph-view_core.properties</value>
311                        </list>
312                </property>
313        </bean>
314
315        <!-- IBISQ REQUEST URL EXAMPLE OF NOT USING THE ABOVE property override file:
316        <bean id="queryQueryApplicationRequestBasePath" class="org.ibisph.model.StringHolder">
317                <constructor-arg value="http://123.222.100.33:8080/cgi-bin/hi_iq_func.exe"/>
318        </bean>
319        -->
320
321
322        <!-- This method invoke call verifies the existance of the published
323                indicators XML file.  If it does not exist then creates it based on the
324                existing IP XML files.  This is useful for new deployments or if the XML
325                is corrupt etc.  Typically used when the adopter wants to rebuild the
326                XML (1. delete the published IPs XML file, 2. restart the app).  The
327                admin app is responsible to maintain the published IPs XML file via an
328                IP publish request so this call should not be needed.  It is provided as
329                a safety feature that some direct content adopters may want to include.
330
331                REMOTE CONTENT NOTE: this verify service is of no value as the content
332                is located on a different server and thus can NOT create, update, delete
333                this file.  For remote content the IPs XML and published IPs XML file is
334                either managed by the admin app's publishing or by an adopter manually
335                maintaining their content.
336        <bean id="siteSpecificVerifyPublishedIndicatorsXMLFileService"
337                class="org.springframework.beans.factory.config.MethodInvokingFactoryBean"
338        >
339                <property name="targetObject">
340                        <bean class="org.ibisph.indicatorprofile.service.PublishedIndicatorsXML">
341                                <property name="publishedIndicatorsFilePathAndName" value="#{indicatorPublishedIndicatorsFilePathAndName.string}"/>
342                                <property name="indicatorProfileFilePath" value="#{indicatorProfileFilePath.string}"/>
343                                <property name="documentDAOService"       ref="commonDocumentDAOService"/>
344                        </bean>
345                </property>
346                <property name="targetMethod" value="verifyPublishedIndicatorsXMLFile"/>
347        </bean>
348        -->
349
350
351        <bean id="securityAuthenticationProviderList" class="java.util.ArrayList">
352                <description>
353                        Defines the types of provides to be used for authenticating a user.
354                        This list can be 1:n with the first being tried then the next etc
355                        until successful/all providers have been tried.
356
357                        Note that you MUST have the appropriate/associated spring bean xml
358                        file included/imported to be able to use the selected provider.
359                </description>
360                <constructor-arg>
361                        <list>
362                                <ref bean="securityPreAuthenticatedAuthenticationProvider"/>
363                                <ref bean="securityDBAuthenticationProvider"/>
364                                <ref bean="securityXMLAuthenticationProvider"/>
365                        </list>
366                </constructor-arg>
367        </bean>
368
369        <!-- For development use the standard, non caching XSLT transformer.  Default
370                common is the caching version: org.ibisph.xslt.CachedSaxonTransformerFactory.
371        -->
372        <bean id="commonXSLTTransformerFactory" class="net.sf.saxon.TransformerFactoryImpl"/>
373
374</beans>
375
Note: See TracBrowser for help on using the repository browser.