From 2d4efdc374de3c08fa02c33d01a69fc5f2fe03d2 Mon Sep 17 00:00:00 2001
From: Andreas Kohlbecker <a.kohlbecker@bgbm.org>
Date: Thu, 21 Mar 2019 16:26:51 +0100
Subject: [PATCH] ref #7356 moving VaadinServletConfiguration from web.xml into
 CdmVaadinConfiguration

---
 .../addon/config/CdmVaadinConfiguration.java  | 28 +++++++---
 src/main/webapp/WEB-INF/web.xml               | 51 +------------------
 2 files changed, 22 insertions(+), 57 deletions(-)

diff --git a/src/main/java/eu/etaxonomy/cdm/addon/config/CdmVaadinConfiguration.java b/src/main/java/eu/etaxonomy/cdm/addon/config/CdmVaadinConfiguration.java
index 588d3fb0..67d470ab 100644
--- a/src/main/java/eu/etaxonomy/cdm/addon/config/CdmVaadinConfiguration.java
+++ b/src/main/java/eu/etaxonomy/cdm/addon/config/CdmVaadinConfiguration.java
@@ -34,6 +34,8 @@ import org.springframework.core.env.Environment;
 import org.springframework.security.authentication.AuthenticationProvider;
 import org.vaadin.spring.events.annotation.EnableEventBus;
 
+import com.vaadin.annotations.VaadinServletConfiguration;
+import com.vaadin.server.DeploymentConfiguration.LegacyProperyToStringMode;
 import com.vaadin.spring.annotation.EnableVaadin;
 import com.vaadin.spring.annotation.SpringUI;
 import com.vaadin.spring.annotation.UIScope;
@@ -56,6 +58,7 @@ import eu.etaxonomy.cdm.dataInserter.RegistrationRequiredDataInserter;
 import eu.etaxonomy.cdm.persistence.hibernate.GrantedAuthorityRevokingRegistrationUpdateLister;
 import eu.etaxonomy.cdm.persistence.hibernate.ITaxonGraphHibernateListener;
 import eu.etaxonomy.cdm.vaadin.permission.annotation.EnableAnnotationBasedAccessControl;
+import eu.etaxonomy.cdm.vaadin.ui.CdmBaseUI;
 import eu.etaxonomy.cdm.vaadin.ui.ConceptRelationshipUI;
 import eu.etaxonomy.cdm.vaadin.ui.DistributionStatusUI;
 import eu.etaxonomy.cdm.vaadin.ui.RegistrationUI;
@@ -127,22 +130,33 @@ public class CdmVaadinConfiguration implements ApplicationContextAware  {
      * (1) It is necessary to map the URLs starting with /VAADIN/* since none of the
      * @WebServlets is mapped to the root path. It is sufficient to configure one of the
      * servlets with this path see BookOfVaadin 5.9.5. Servlet Mapping with URL Patterns
-     *
-     * (2) @VaadinServletConfiguration is not used here, all DeploymentConfiguration is
-     * configured in the web.xml. This way it it easier to modify the parameters for different
-     * build environments like test and production
      */
-    @WebServlet(value = {"/app/*", "/VAADIN/*"}, asyncSupported = true)
-    public static class Servlet extends SpringVaadinServlet {
+    @VaadinServletConfiguration(
+            productionMode = false,    // FIXME get value from application.properties or
+                                       // use two different CdmVaadinServlets for
+                                       // different spring profiles?
+            ui = CdmBaseUI.class,      // TODO better default UI to use?
+            // If the closeIdleSessions parameter for the servlet is
+            // enabled (disabled by default), Vaadin closes the UIs and the session after the time specified
+            // in the session-timeout parameter expires after the last non-heartbeat request.
+            // For session-timeout see <session-config>
+            // Legacy mode to return the value of the property as a string from AbstractProperty.toString()
+            closeIdleSessions=true,
+            legacyPropertyToStringMode=LegacyProperyToStringMode.ENABLED
+            )
+    @WebServlet(name="CdmVaadinServlet", value = {"/app/*", "/VAADIN/*"}, asyncSupported = true)
+    public static class CdmVaadinServlet extends SpringVaadinServlet {
 
         private static final long serialVersionUID = -2615042297393028775L;
 
-
         /**
          *
         @SuppressWarnings("serial")
         @Override
         protected void servletInitialized() throws ServletException {
+            logger.debug("SpringVaadinServlet initialized");
+
+        }
             getService().addSessionInitListener(new SessionInitListener() {
 
                 @Override
diff --git a/src/main/webapp/WEB-INF/web.xml b/src/main/webapp/WEB-INF/web.xml
index 3a738021..7edef98f 100644
--- a/src/main/webapp/WEB-INF/web.xml
+++ b/src/main/webapp/WEB-INF/web.xml
@@ -33,35 +33,11 @@
         <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
         <load-on-startup>1</load-on-startup>
     </servlet>
-    <servlet>
-    	<servlet-name>Cdm_vaadin Application</servlet-name>
-    	<servlet-class>com.vaadin.server.VaadinServlet</servlet-class>
-    	<init-param>
-    		<description>Legacy mode to return the value of the property as a string from AbstractProperty.toString()</description>
-    		<param-name>legacyPropertyToString</param-name>
-    		<param-value>false</param-value>
-    	</init-param>
-        <init-param>
-          <!-- 
-            If the closeIdleSessions parameter for the servlet is
-            enabled (disabled by default), Vaadin closes the UIs and the session after the time specified
-            in the session-timeout parameter expires after the last non-heartbeat request.
-            For session-timeout see <session-config>
-           -->
-          <param-name>closeIdleSessions</param-name>
-          <param-value>true</param-value>
-        </init-param>
-    </servlet>
 
     <servlet-mapping>
         <servlet-name>cdm-vaadin</servlet-name>
         <url-pattern>/</url-pattern>
     </servlet-mapping>
-    <servlet-mapping>
-    	<servlet-name>Cdm_vaadin Application</servlet-name>
-    	<url-pattern>/*</url-pattern>
-    </servlet-mapping>
-
 
     <filter>
       <filter-name>charsetFilter</filter-name>
@@ -90,31 +66,6 @@
       <filter-name>springSecurityFilterChain</filter-name>
       <url-pattern>/*</url-pattern>
     </filter-mapping>
-  
-    <!-- 
-      The production mode is disabled per default.
-      
-      There are also productionMode=true settings in the eu.etaxonomy.cdm.vaadin.ui package
-      which don't seem to have an effect. 
-      
-      see also the notes at CdmVaadinConfiguration.Servlet
-    -->
-    <context-param>
-    	<description>Vaadin production mode</description>
-    	<param-name>productionMode</param-name>
-    	<param-value>false</param-value>
-    </context-param>
-    <!-- 
-    <context-param>
-      <param-name>heartbeatInterval</param-name>
-      <param-value>300</param-value><!- - default is 300 seconds - ->
-    </context-param> 
-    -->
-    
-    <!-- configuring the session-timeout seems not to have an effect
-    <session-config>
-        <session-timeout>20</session-timeout><!- - jetty session-timeout default is 30 minutes - ->
-    </session-config> 
-    -->
+ 
     
 </web-app>
-- 
2.34.1