CAY-2469 Allow maxQueueWaitTime and validationQuery in XML project

Author: mmpestorich

RELEASE-NOTES.txt

@@ -15,6 +15,7 @@ Changes/New Features:
 
 CAY-2446 Run Disjoint By Id queries outside of synchronized block
 CAY-2447 Crypto support for LocalDateTime
+CAY-2469 Allow maxQueueWaitTime and validationQuery to be set in XML project
 CAY-2471 Support multiple XML project versions
 
 Bug Fixes:
@@ -549,4 +550,4 @@ CAY-1804 Serialisation of long[] type was not working correctly.
 CAY-1806 Error importing eomodel
 CAY-1817 NPE during Validate Project
 CAY-1827 EhCache region corresponding to a cache group loses its settings after 'removeGroup'
-CAY-1832 Exception when modifying objects in postLoad callback
+CAY-1832 Exception when modifying objects in postLoad callback

cayenne-project-compatibility/src/main/java/org/apache/cayenne/project/compatibility/ProjectCompatibilityModule.java

@@ -28,6 +28,7 @@
 import org.apache.cayenne.project.ProjectModule;
 import org.apache.cayenne.project.upgrade.UpgradeService;
 import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler_V10;
+import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler_V11;
 import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler_V7;
 import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler_V8;
 import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler_V9;
@@ -49,6 +50,7 @@ public void configure(Binder binder) {
                 .add(UpgradeHandler_V7.class)
                 .add(UpgradeHandler_V8.class)
                 .add(UpgradeHandler_V9.class)
-                .add(UpgradeHandler_V10.class);
+                .add(UpgradeHandler_V10.class)
+                .add(UpgradeHandler_V11.class);
     }
 }

cayenne-project-compatibility/src/test/java/org/apache/cayenne/project/compatibility/CompatibilityTestModule.java

@@ -34,6 +34,7 @@
 import org.apache.cayenne.project.upgrade.UpgradeService;
 import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler;
 import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler_V10;
+import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler_V11;
 import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler_V7;
 import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler_V8;
 import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler_V9;
@@ -59,7 +60,8 @@ public void configure(Binder binder) {
                 .add(UpgradeHandler_V7.class)
                 .add(UpgradeHandler_V8.class)
                 .add(UpgradeHandler_V9.class)
-                .add(UpgradeHandler_V10.class);
+                .add(UpgradeHandler_V10.class)
+                .add(UpgradeHandler_V11.class);
 
         binder.bind(ProjectSaver.class).toInstance(mock(ProjectSaver.class));
         binder.bind(DataChannelDescriptorLoader.class).toInstance(mock(DataChannelDescriptorLoader.class));

cayenne-project-compatibility/src/test/java/org/apache/cayenne/project/compatibility/CompatibilityUpgradeServiceIT.java

@@ -52,7 +52,7 @@ public void testUpgradeFullProjectDom() throws Exception {
         Document domainDocument = documentProvider.getDocument(resourceUrl);
 
         assertNotNull(domainDocument);
-        assertEquals("10", domainDocument.getDocumentElement().getAttribute("project-version"));
+        assertEquals("11", domainDocument.getDocumentElement().getAttribute("project-version"));
 
         URL dataMapUrl = getClass().getResource("test-map-v6.map.xml");
         Document dataMapDocument = documentProvider.getDocument(dataMapUrl);
@@ -87,4 +87,4 @@ public void testUpgradeStandAloneDataMapDom() throws Exception {
     private Injector getInjector() {
         return DIBootstrap.createInjector(new CompatibilityTestModule());
     }
-}
+}

cayenne-project/src/main/java/org/apache/cayenne/project/ProjectModule.java

@@ -26,6 +26,7 @@
 import org.apache.cayenne.project.upgrade.UpgradeService;
 import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler;
 import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler_V10;
+import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler_V11;
 import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler_V7;
 import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler_V8;
 import org.apache.cayenne.project.upgrade.handlers.UpgradeHandler_V9;
@@ -66,7 +67,8 @@ public void configure(Binder binder) {
                 .add(UpgradeHandler_V7.class)
                 .add(UpgradeHandler_V8.class)
                 .add(UpgradeHandler_V9.class)
-                .add(UpgradeHandler_V10.class);
+                .add(UpgradeHandler_V10.class)
+                .add(UpgradeHandler_V11.class);
 
         contributeExtensions(binder);
     }

cayenne-project/src/main/java/org/apache/cayenne/project/ProjectVersion.java

@@ -0,0 +1,34 @@
+package org.apache.cayenne.project;
+
+import org.apache.cayenne.CayenneRuntimeException;
+
+/**
+ * Encapsulates compatible schema versions.
+ */
+public enum ProjectVersion {
+
+    VERSION_9(null,"9"),
+    VERSION_10("10","10"),
+    VERSION_11("11","10");
+
+    public final String domainSchemaVersion;
+    public final String modelMapSchemaVersion;
+
+    ProjectVersion(String domainSchemaVersion, String modelMapSchemaVersion) {
+        this.domainSchemaVersion = domainSchemaVersion;
+        this.modelMapSchemaVersion = modelMapSchemaVersion;
+    }
+
+    public ProjectVersion getProjectVersion(String version) {
+        switch (version) {
+            case "9":
+                return VERSION_9;
+            case "10":
+                return VERSION_10;
+            case "11":
+                return VERSION_11;
+            default:
+                throw new CayenneRuntimeException("Invalid project version: " + version);
+        }
+    }
+}

cayenne-project/src/main/java/org/apache/cayenne/project/upgrade/DefaultUpgradeService.java

@@ -87,8 +87,10 @@ public class DefaultUpgradeService implements UpgradeService {
 
     private static final Logger logger = LoggerFactory.getLogger(DefaultUpgradeService.class);
 
-    public static final String UNKNOWN_VERSION = "0";
-    public static final String MIN_SUPPORTED_VERSION = "6";
+    private static final String UNKNOWN_VERSION = "0";
+    private static final String MIN_INTERMEDIATE_SUPPORTED_VERSION = "6";
+    private static final String MIN_SUPPORTED_VERSION = "10";
+    private static final String MAX_SUPPORTED_VERSION = "11";
 
     TreeMap<String, UpgradeHandler> handlers = new TreeMap<>(VersionComparator.INSTANCE);
 
@@ -110,28 +112,26 @@ public UpgradeMetaData getUpgradeType(Resource resource) {
 
         String version = loadProjectVersion(resource);
         metaData.setProjectVersion(version);
-        metaData.setSupportedVersion(String.valueOf(Project.VERSION));
 
-        int c1 = VersionComparator.INSTANCE.compare(version, MIN_SUPPORTED_VERSION);
+        int c1 = VersionComparator.INSTANCE.compare(version, MIN_INTERMEDIATE_SUPPORTED_VERSION);
         if (c1 < 0) {
-            metaData.setIntermediateUpgradeVersion(MIN_SUPPORTED_VERSION);
             metaData.setUpgradeType(UpgradeType.INTERMEDIATE_UPGRADE_NEEDED);
             return metaData;
         }
 
-        int c2 = VersionComparator.INSTANCE.compare(String.valueOf(Project.VERSION), version);
-        if (c2 < 0) {
+        if (VersionComparator.INSTANCE.compare(version, MIN_SUPPORTED_VERSION) < 0) {
+            metaData.setUpgradeType(UpgradeType.UPGRADE_NEEDED);
+        } else if (VersionComparator.INSTANCE.compare(version, MAX_SUPPORTED_VERSION) > 0) {
             metaData.setUpgradeType(UpgradeType.DOWNGRADE_NEEDED);
-        } else if (c2 == 0) {
-            metaData.setUpgradeType(UpgradeType.UPGRADE_NOT_NEEDED);
         } else {
-            metaData.setUpgradeType(UpgradeType.UPGRADE_NEEDED);
+            metaData.setUpgradeType(UpgradeType.UPGRADE_NOT_NEEDED);
         }
+
         return metaData;
     }
 
     protected List<UpgradeHandler> getHandlersForVersion(String version) {
-        boolean found = MIN_SUPPORTED_VERSION.equals(version);
+        boolean found = MIN_INTERMEDIATE_SUPPORTED_VERSION.equals(version);
         List<UpgradeHandler> handlerList = new ArrayList<>();
 
         for(Map.Entry<String, UpgradeHandler> entry : handlers.entrySet()) {

cayenne-project/src/main/java/org/apache/cayenne/project/upgrade/UpgradeMetaData.java

@@ -28,8 +28,6 @@ public class UpgradeMetaData {
 
     protected UpgradeType upgradeType;
     protected String projectVersion;
-    protected String supportedVersion;
-    protected String intermediateUpgradeVersion;
 
     public UpgradeType getUpgradeType() {
         return upgradeType;
@@ -47,20 +45,4 @@ public void setProjectVersion(String projectVersion) {
         this.projectVersion = projectVersion;
     }
 
-    public String getSupportedVersion() {
-        return supportedVersion;
-    }
-
-    public void setSupportedVersion(String supportedVersion) {
-        this.supportedVersion = supportedVersion;
-    }
-
-    public String getIntermediateUpgradeVersion() {
-        return intermediateUpgradeVersion;
-    }
-
-    public void setIntermediateUpgradeVersion(String intermediateUpgradeVersion) {
-        this.intermediateUpgradeVersion = intermediateUpgradeVersion;
-    }
-
 }

cayenne-project/src/main/java/org/apache/cayenne/project/upgrade/handlers/UpgradeHandler_V11.java

@@ -0,0 +1,62 @@
+/*****************************************************************
+ *   Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file except in compliance
+ *  with the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ ****************************************************************/
+
+package org.apache.cayenne.project.upgrade.handlers;
+
+import org.apache.cayenne.configuration.DataChannelDescriptor;
+import org.apache.cayenne.project.upgrade.UpgradeUnit;
+import org.w3c.dom.Element;
+
+/**
+ * Upgrade handler for the project version "10" introduced by 4.1.M1 release.
+ * Changes highlight:
+ *      - strict schema for domain (e.g. main project document)
+ *      - new schema for data map allowing usage of additional elements (e.g. XML extensions)
+ *
+ * @since 4.1
+ */
+public class UpgradeHandler_V11 implements UpgradeHandler {
+
+    @Override
+    public String getVersion() {
+        return "11";
+    }
+
+    @Override
+    public void processProjectDom(UpgradeUnit upgradeUnit) {
+        Element domain = upgradeUnit.getDocument().getDocumentElement();
+        // introduce xml namespace and schema for domain
+        domain.setAttribute("xmlns","http://cayenne.apache.org/schema/11/domain");
+        domain.setAttribute("xmlns:xsi","http://www.w3.org/2001/XMLSchema-instance");
+        domain.setAttribute("xsi:schemaLocation", "http://cayenne.apache.org/schema/11/domain " +
+                "https://cayenne.apache.org/schema/11/domain.xsd");
+        // update version
+        domain.setAttribute("project-version", getVersion());
+    }
+
+    @Override
+    public void processDataMapDom(UpgradeUnit upgradeUnit) {
+        // noop
+    }
+
+    @Override
+    public void processModel(DataChannelDescriptor dataChannelDescriptor) {
+        // noop
+    }
+}

cayenne-project/src/test/java/org/apache/cayenne/project/upgrade/DefaultUpgradeServiceTest.java

@@ -64,10 +64,16 @@ public void getUpgradeType() throws Exception {
         metaData = upgradeService.getUpgradeType(getResourceForVersion("6"));
         assertEquals(UpgradeType.UPGRADE_NEEDED, metaData.getUpgradeType());
 
+        metaData = upgradeService.getUpgradeType(getResourceForVersion("9"));
+        assertEquals(UpgradeType.UPGRADE_NEEDED, metaData.getUpgradeType());
+
         metaData = upgradeService.getUpgradeType(getResourceForVersion("10"));
         assertEquals(UpgradeType.UPGRADE_NOT_NEEDED, metaData.getUpgradeType());
 
         metaData = upgradeService.getUpgradeType(getResourceForVersion("11"));
+        assertEquals(UpgradeType.UPGRADE_NOT_NEEDED, metaData.getUpgradeType());
+
+        metaData = upgradeService.getUpgradeType(getResourceForVersion("12"));
         assertEquals(UpgradeType.DOWNGRADE_NEEDED, metaData.getUpgradeType());
     }
 
@@ -160,4 +166,4 @@ private Resource getResourceForVersion(String version) {
         return new URLResource(getClass().getResource("handlers/cayenne-project-v"+version+".xml"));
     }
 
-}
+}