XCOMMONS-3289: Allow overwritting xwiki.properties and xwiki.cfg properties via environment variable and Java system properties

Author: tmortagne

xwiki-platform-core/xwiki-platform-configuration/xwiki-platform-configuration-default/pom.xml

@@ -42,6 +42,11 @@
       <artifactId>xwiki-commons-configuration-api</artifactId>
       <version>${commons.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.xwiki.commons</groupId>
+      <artifactId>xwiki-commons-configuration-default</artifactId>
+      <version>${commons.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.xwiki.commons</groupId>
       <artifactId>xwiki-commons-environment-api</artifactId>
@@ -107,7 +112,6 @@
                 org/xwiki/configuration/internal/AbstractDocumentConfigurationSource.java,
                 org/xwiki/configuration/internal/AllConfigurationSource.java,
                 org/xwiki/configuration/internal/CommonsConfigurationSource.java,
-                org/xwiki/configuration/internal/CompositeConfigurationSource.java,
                 org/xwiki/configuration/internal/DefaultConfigurationSource.java
               </excludes>
             </configuration>

xwiki-platform-core/xwiki-platform-configuration/xwiki-platform-configuration-default/src/main/java/org/xwiki/configuration/internal/AbstractCompositeConfigurationSource.java

@@ -264,6 +264,12 @@ protected void setBaseProperty(String propertyName, Object propertyValue, BaseOb
 
     @Override
     public List<String> getKeys()
+    {
+        return getKeys("");
+    }
+
+    @Override
+    public List<String> getKeys(String prefix)
     {
         List<String> keys = Collections.emptyList();
 
@@ -280,7 +286,7 @@ public List<String> getKeys()
                     for (String key : properties) {
                         // We need to check if the key really have a value as otherwise it does not really make sense to
                         // return it
-                        if (containsKey(key)) {
+                        if (key.startsWith(prefix) && containsKey(key)) {
                             keys.add(key);
                         }
                     }
@@ -374,6 +380,12 @@ public boolean isEmpty()
         return getKeys().isEmpty();
     }
 
+    @Override
+    public boolean isEmpty(String prefix)
+    {
+        return getKeys(prefix).isEmpty();
+    }
+
     @Override
     public void setProperty(String key, Object value) throws ConfigurationSaveException
     {

xwiki-platform-core/xwiki-platform-configuration/xwiki-platform-configuration-default/src/main/java/org/xwiki/configuration/internal/AbstractDocumentConfigurationSource.java

@@ -163,6 +163,17 @@ public List<String> getKeys()
             }
         }
 
+        @Override
+        public List<String> getKeys(String prefix)
+        {
+            XWikiDocument currentDocument = setCurrentDocument(getDocument());
+            try {
+                return getSpaceConfigurationSource().getKeys(prefix);
+            } finally {
+                setCurrentDocument(currentDocument);
+            }
+        }
+        
         @Override
         public boolean containsKey(String key)
         {
@@ -184,6 +195,17 @@ public boolean isEmpty()
                 setCurrentDocument(currentDocument);
             }
         }
+
+        @Override
+        public boolean isEmpty(String prefix)
+        {
+            XWikiDocument currentDocument = setCurrentDocument(getDocument());
+            try {
+                return getSpaceConfigurationSource().isEmpty(prefix);
+            } finally {
+                setCurrentDocument(currentDocument);
+            }
+        }
     }
 
     @Override

xwiki-platform-core/xwiki-platform-configuration/xwiki-platform-configuration-default/src/main/java/org/xwiki/configuration/internal/AbstractSpacesConfigurationSource.java

@@ -70,6 +70,12 @@ public List<String> getKeys()
             return getFromWiki(() -> AbstractWikisConfigurationSource.super.getKeys());
         }
 
+        @Override
+        public List<String> getKeys(String prefix)
+        {
+            return getFromWiki(() -> AbstractWikisConfigurationSource.super.getKeys(prefix));
+        }
+        
         @Override
         public <T> T getProperty(String key)
         {
@@ -94,6 +100,12 @@ public boolean isEmpty()
             return getFromWiki(() -> AbstractWikisConfigurationSource.super.isEmpty());
         }
 
+        @Override
+        public boolean isEmpty(String prefix)
+        {
+            return getFromWiki(() -> AbstractWikisConfigurationSource.super.isEmpty(prefix));
+        }
+
         private <T> T getFromWiki(Supplier<T> supplier)
         {
             XWikiContext xcontext = xcontextProvider.get();
@@ -130,6 +142,12 @@ public List<String> getKeys()
         return getConfigurationSource().getKeys();
     }
 
+    @Override
+    public List<String> getKeys(String prefix)
+    {
+        return getConfigurationSource().getKeys(prefix);
+    }
+    
     @Override
     public <T> T getProperty(String key)
     {
@@ -154,6 +172,12 @@ public boolean isEmpty()
         return getConfigurationSource().isEmpty();
     }
 
+    @Override
+    public boolean isEmpty(String prefix)
+    {
+        return getConfigurationSource().isEmpty(prefix);
+    }
+    
     private ConfigurationSource getConfigurationSource()
     {
         CompositeConfigurationSource compositeConfigSource = new CompositeConfigurationSource();