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

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

<!--
        IBIS-PH View System's common Spring properties. This Spring application 
        context file contains properties are commonly used by more than one modules/
        packages within the system.  These common properties include core base 
        XML/XSLT paths and other resources used by the apps controllers.

        PROPERTY USAGE NOTES:
        <property name="someName"><null/></property>
        <property name="someName" value="${some_system_property_name}"/>
        <value type="xyz.abc">  Beans can't have a type.
        
        If setting is something like setXMLPath then the property needs to be name="XMLPath"
        (the bean naming more than one first letters capped rule) otherwise it's lowercase
        then mixed case like normal properties.

        Use the "parent" attribute for child objects that are of the same type.  This basically
        does a clone on an object so that the existing parent object's objects are copied 
        to the child - thus providing a populated base class that all child objects can 
        be implicitly populated without explicitly setting the properties.
-->


<!-- Global/Common/Shared bean definitions used by some or all of the application contexts -->

<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"
>

        <!-- deployment based properties.  See Spring in Action 2.4.3 for a 
                discussion on this.  Note that many of these properties are wrapped 
                in a bean.  This is needed so that the servlet based bean defs can
                access these property file values without having to reopen the 
                property file for that context.
        -->
        <bean id="Common.SiteSpecific.Properties" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
                <property name="location" value="WEB-INF/config/site_specific.properties"/>
        </bean>
        <bean id="Common.XML.EncodingScheme"   class="java.lang.String"><constructor-arg value="${XML.EncodingScheme}"/></bean>
        <bean id="Common.QueryApplication.URL" class="java.lang.String"><constructor-arg value="${QueryApplication.URL}"/></bean>
        <bean id="Common.AdminApp.IPAddress"   class="java.lang.String"><constructor-arg value="${AdminApp.IPAddress}"/></bean>
        <bean id="Common.AdminApp.PublishRequest.MatchPartialIPAddress" class="java.lang.Boolean"><constructor-arg value="${AdminApp.PublishRequest.MatchPartialIPAddress}"/></bean>
        <bean id="Common.AdminApp.OrgUnitsXML.BaseURL"         class="java.lang.String"><constructor-arg value="${AdminApp.OrgUnitsXML.BaseURL}"/></bean>
        <bean id="Common.AdminApp.IndicatorViewXML.BaseURL"    class="java.lang.String"><constructor-arg value="${AdminApp.IndicatorViewXML.BaseURL}"/></bean>
        <bean id="Common.AdminApp.IndicatorXML.BaseURL"        class="java.lang.String"><constructor-arg value="${AdminApp.IndicatorXML.BaseURL}"/></bean>
        <bean id="Common.AdminApp.CategorizedIndexXML.BaseURL" class="java.lang.String"><constructor-arg value="${AdminApp.CategorizedIndexXML.BaseURL}"/></bean>


        <!--  C O N T E X T S  -->
        <!-- 
                These contexts are needed mainly for SystemID beans as they need a 
                concrete file path.  
        -->
        <bean id="Common.Contexts" class="org.ibisph.web.ContextsService"/>

        <bean id="Common.Context.WebApplication" class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
                <property name="targetObject" ref="Common.Contexts"/>
                <property name="targetMethod" value="getWebApplicationContext"/>
        </bean>
        <bean id="Common.Context.Application" class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
                <property name="targetObject" ref="Common.Contexts"/>
                <property name="targetMethod" value="getApplicationContext"/>
        </bean>
        <bean id="Common.Context.Servlet" class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
                <property name="targetObject" ref="Common.Contexts"/>
                <property name="targetMethod" value="getServletContext"/>
        </bean>
        <bean id="Common.Context.Servlet.RootPath" class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
                <property name="targetObject" ref="Common.Context.Servlet"/>
                <property name="targetMethod" value="getRealPath"/>
                <property name="arguments"><list><value></value></list></property>
        </bean>


        <!--  L O C A L S,  D A T E,  F O R M A T S  -->
        <bean id="Common.Locale" class="java.util.Locale">
                <constructor-arg value="en"/>
                <constructor-arg value="US"/>
        </bean>

        <!-- Date Format Patterns:
                To specify the time format use a time pattern string. In this pattern, all
                ASCII letters are reserved as pattern letters, which are defined as the following:
                
                 Symbol   Meaning                 Presentation        Example
                 ======   =====================   =================   ===================
                 G        era designator          (Text)              AD
                 y        year                    (Number)            1996
                 M        month in year           (Text & Number)     July & 07
                 d        day in month            (Number)            10
                 h        hour in am/pm (1~12)    (Number)            12
                 H        hour in day (0~23)      (Number)            0
                 m        minute in hour          (Number)            30
                 s        second in minute        (Number)            55
                 S        millisecond             (Number)            978
                 E        day in week             (Text)              Tuesday
                 D        day in year             (Number)            189
                 F        day of week in month    (Number)            2 (2nd Wed in July)
                 w        week in year            (Number)            27
                 W        week in month           (Number)            2
                 a        am/pm marker            (Text)              PM
                 k        hour in day (1~24)      (Number)            24
                 K        hour in am/pm (0~11)    (Number)            0
                 z        time zone               (Text)              Pacific Standard Time
                 '        escape for text         (Delimiter)
                 ''       single quote            (Literal)           '
                
                Examples Using the US Locale:
                
                Format Pattern                    Result
                ==============================    ======================================
                "yyyy.MM.dd G 'at' hh:mm:ss z"    1996.07.10 AD at 15:08:56 PDT
                "EEE, MMM d, ''yy"                Wed, July 10, '96
                "h:mm a"                          12:08 PM
                "hh 'o''clock' a, zzzz"           12 o'clock PM, Pacific Daylight Time
                "K:mm a, z"                       0:00 PM, PST
                "yyyyy.MMMMM.dd GGG hh:mm aaa"    1996.July.10 AD 12:08 PM
                
                "dd.MM.yy"                        09.04.98
                "H:mm"                            18:15
                "H:mm:ss:SSS"                     18:15:55:624
                "K:mm a,z"                        6:15 PM,PDT

                Serial Number: yyyy-MM-dd-HH-mm-ss-SS
        -->
        <bean id="Common.DateFormat" class="java.text.SimpleDateFormat">
                <constructor-arg value="EEE, d MMM yyyy HH:mm:ss z"/>
                <constructor-arg type="java.util.Locale" ref="Common.Locale"/>
        </bean>
        <bean id="Common.BackupFileDateSerialNumber.DateFormat" class="java.text.SimpleDateFormat">
                <constructor-arg value="yyyy-MM-dd-HH-mm-ss-SS"/>
                <constructor-arg type="java.util.Locale" ref="Common.Locale"/>
        </bean>


        <!--  M O D E L   M A P S -->
        <bean id="Common.XML.ModelMapKey" class="java.lang.String">
                <constructor-arg value="XML"/>
        </bean>
        <bean id="Common.ModifiedDateModelMapKey" class="java.lang.String">
                <constructor-arg value="XMLModifedDate"/>
        </bean>
        <bean id="Common.XMLModelMap.CommonProperties" abstract="true">
                <property name="modelMapKey" ref="Common.XML.ModelMapKey"/>
        </bean>

        <bean id="Common.WebAppURLContextPrefixFromHTTPRequest.ModelMap" class="org.ibisph.web.modelmap.WebAppURLContextPrefixFromHTTPRequest">
                <property name="modelMapKey" value="WebAppURLContextPrefix"/>
        </bean>
        <bean id="Common.HTTPRequestParameters.ModelMap" class="org.ibisph.web.modelmap.HTTPRequestParameters">
                <description>
                        Provides a simple mechanism to pass URL req params to the XSLT 
                        code.  Note that this does NOT differentiate between GET and 
                        POST so might have to remove this in some special cases - like
                        not needed for the query module builder post etc.
                </description>
                <property name="modelMapKey" value="HTTPRequestParameters"/>
        </bean>
        <bean id="Common.ModifiedDateFromFileSystemID.ModelMap" class="org.ibisph.modelmap.AddModelDateModelToModelMap">
                <property name="sourceModelModelMapKey"   ref="Common.XML.ModelMapKey"/>
                <property name="formattedDateModelMapKey" ref="Common.ModifiedDateModelMapKey"/>
                <property name="dateFormat"               ref="Common.DateFormat"/>
        </bean>


        <!--  X M L   R E S O U R C E S  -->
        <bean id="Common.XML.OutputFormat" class="org.dom4j.io.OutputFormat">
                <property name="encoding"   value="${XML.EncodingScheme}"/>
                <property name="indentSize" value="0"/> <!-- \t = &#09; = horizontal tab -->
                <property name="indent"     value=""/>
                <property name="newlines"   value="false"/> <!-- if true just adds extra blank line inbetween... -->
                <property name="padText"    value="false"/> <!-- if true just adds extra blank line inbetween... -->
                <property name="trimText"   value="false"/> <!-- do NOT set to true -->
        </bean>

        <bean id="Common.XML.DAO" class="org.ibisph.xml.dao.Document">
                <property name="outputFormat" ref="Common.XML.OutputFormat"/>
        </bean>


        <!--  X S L T   T R A N S F O R M A T I O N   R E S O U R C E S  -->
        <!-- The main function is to set the XSLT transformation factory to be used.
                This mechanism allows for a pluggable XSLT engine to be explicitly used. 
                This can be set as a system property but doing so can impact other apps 
                that are installed on the same app server which require/rely on other 
                versions of an XSLT processor (typically XALAN).  If the factory is not 
                explicitly set then the app server's/JVM's default XSLT engine will be 
                used (via JAXP - typically XALAN which will NOT work for IBIS as of 2008).  

                NOTES: 
                - This factory must be XSLT v2.0 (at this point Saxon is the best
                solution - XALAN 2.x will NOT work for IBIS as it is v1.x).  

                - Removed the IBIS transformer factory type classes in late 2008 as they 
                were not needed.  If XALAN ever goes to 2.0 and adopters want to use then
                those objects can be resurrected or new XALAN objects can be created as
                needed.

                PRODUCTION: It is highly recommended to use the caching Saxon XSLT engine:
                <bean id="Common.XSLT.TransformerFactory" class="org.ibisph.xslt.CachedSaxonTransformerFactory"/>

                XSLT DEVELOPMENT: Use the normal, thread safe non caching Saxon XSLT 
                Transformation Factory.  This avoids having to restart the app or touch 
                the core XSLT file.
                <bean id="Common.XSLT.TransformerFactory" class="net.sf.saxon.TransformerFactoryImpl"/>
        -->
        <bean id="Common.XSLT.TransformerFactory" class="net.sf.saxon.TransformerFactoryImpl"/>
        <bean id="Common.XSLT.Transformation" class="org.ibisph.xslt.Transformation">
                <constructor-arg ref="Common.XSLT.TransformerFactory"/>
        </bean>



        <!--  E X C E P T I O N   R E S O L V E R  -->

        <!-- Exception Resolvers are typically a list of exceptions with associated 
                views to be used to display an error for a given type of exception.  
                Note that the resolver is ONLY used for exceptions thrown/uncaught
                within controller objects e.g. objects controlled by the Request Dispatcher 
                servlet/container.  For "view" related errors a HandlerInterceptor 
                is needed see: 
                
                http://stackoverflow.com/questions/196495/how-to-configure-spring-handlerexceptionresolver-to-handle-nullpointerexception-t)
                
                Other types of errors that happen outside of the servlet (like filter 
                errors) are also not able to be handled.  Many of these errors that occur
                within the IBIS applications are view related and due to the fact that
                the web.xml error handling can be used to handle ALL types of errors, 
                there's not much value in an ErrorResolver.  As if 2010, all errors 
                simply go through to the container which will then use the web.xml 
                which uses a centralized error jsp to handle all errors.  The error 
                page logs the error and returns an error page to the user.  The two
                major downsides to this centralized JSP approach is that 1) the error
                JSP has to be bullet proof, and 2) the error handling is limited to 
                what can be done within a JSP.  The pro to this approach is that it
                is all centralized and handled consistently.
        -->

        <!-- Below is a basic ExceptionResolver that many Spring MVC apps implement.
                Specific exceptions are handled by the simple exception to view resolver 
                This resolver needs to be used first and MUST not be configured to do the
                general error handling as the next resolver will not be called.  Note that
                this can be setup to handle everything but it's was easier to understand 
                and control doing this way.

        <bean id="Common.Specific.ExceptionResolver" class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
                <property name="order" value="1"/>
                <property name="defaultStatusCode" value="700"/>
                <property name="defaultErrorView" value="/WEB-INF/jsp/error/detail.jsp"/>
                <property name="exceptionAttribute" value="Exception"/>
                <property name="mappedHandlers">
                        <set><value>java.lang.Throwable</value><ref local="Common.Default.ExceptionHandler"/></set>
                </property>
                <property name="exceptionMappings">
                        <props>
                                <prop key="org.ibisph.web.springmvc.controller.query.NullModuleException">Query.NullModuleDocument.View</prop>
                                <prop key="java.lang.Exception ">Query.NullModuleDocument.View</prop>
                        </props>
                </property>
        </bean>

        For many years a simple logging type ExceptionResolver was used.  The code 
        below is left in case the logging exception hanlder is wanted by an adopter.

        <bean id="Common.Default.ExceptionHandler" class="org.ibisph.web.springmvc.LoggingControllerExceptionHandler">
                <property name="order" value="1"/>
        </bean>
        -->




        <!--  R E S T R I C T E D   A C C E S S   M O D E L S   /   C O N T R O L L E R   R E S O R U C E S -->
        <!-- 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.  Remember that
                a corresponding mapping needs to exist in the dispatcher_servlet.xml 
                file as well as in the WEB.XML servlet mapping.  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)
                or via a similar filter where the return code is injected.
        -->
        <bean id="Common.XML.Path" class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
                <property name="targetObject" ref="Common.Context.Servlet"/>
                <property name="targetMethod" value="getRealPath"/>
                <property name="arguments"><list><value>xml</value></list></property>
        </bean>
        <bean id="Common.RestrictedXMLAccess.XML.SystemID" class="org.ibisph.systemid.FileSystemID">
                <constructor-arg ref="Common.XML.Path"/>
                <constructor-arg value="BlockedURLMessage_HTMLContent.xml"/>
        </bean>
        <bean id="Common.BannedXMLAccess.Controller" class="org.ibisph.web.springmvc.ModelMapListProcessingController">
                <property name="modelMapList">
                        <list>
                                <bean class="org.ibisph.modelmap.SimpleModelMap" parent="Common.XMLModelMap.CommonProperties">
                                        <property name="model" ref="Common.RestrictedXMLAccess.XML.SystemID"/>
                                </bean>
                                <ref bean="Common.ModifiedDateFromFileSystemID.ModelMap"/>
                                <ref bean="Common.WebAppURLContextPrefixFromHTTPRequest.ModelMap"/>
                        </list>
                </property>
                <property name="view" ref="Common.HTMLContent.View"/>
        </bean>

        <bean id="Common.HTMLContent.XSLT.SystemID" class="org.ibisph.systemid.FileSystemID">
                <constructor-arg ref="Common.Context.Servlet.RootPath"/>
                <constructor-arg value="xslt/html/HTMLContentPage.xslt"/>
        </bean>
        <bean id="Common.HTMLContent.View" class="org.ibisph.xml.springmvc.XSLTXMLTransformationView">
                <constructor-arg ref="Common.HTMLContent.XSLT.SystemID"/>
                <constructor-arg ref="Common.XSLT.Transformation"/>
                <property name="XMLModelMapKey" ref="Common.XML.ModelMapKey"/>
                <property name="contentType" value="text/html"/>
        </bean>

</beans>