You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by si...@apache.org on 2019/03/04 12:56:44 UTC

[sling-whiteboard] branch master updated: [cp2fm] added JSON OSGi configuration support

This is an automated email from the ASF dual-hosted git repository.

simonetripodi pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-whiteboard.git


The following commit(s) were added to refs/heads/master by this push:
     new a73d20d  [cp2fm] added JSON OSGi configuration support
a73d20d is described below

commit a73d20dbd47d30573faf80cf1e9a78a0d4be0022
Author: Simo Tripodi <st...@adobe.com>
AuthorDate: Mon Mar 4 13:56:34 2019 +0100

    [cp2fm] added JSON OSGi configuration support
---
 .../AbstractConfigurationEntryHandler.java         | 41 ++++++++--------
 .../AbstractSingleConfigurationEntryHandler.java   | 55 ++++++++++++++++++++++
 .../cp2fm/handlers/ConfigurationEntryHandler.java  |  4 +-
 ...ler.java => JsonConfigurationEntryHandler.java} | 18 +++----
 .../PropertiesConfigurationEntryHandler.java       |  4 +-
 .../handlers/XmlConfigurationEntryHandler.java     | 16 ++++---
 6 files changed, 97 insertions(+), 41 deletions(-)

diff --git a/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/AbstractConfigurationEntryHandler.java b/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/AbstractConfigurationEntryHandler.java
index f331fa2..4dd454c 100644
--- a/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/AbstractConfigurationEntryHandler.java
+++ b/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/AbstractConfigurationEntryHandler.java
@@ -17,13 +17,13 @@
 package org.apache.sling.cp2fm.handlers;
 
 import java.io.InputStream;
-import java.util.Dictionary;
 import java.util.Enumeration;
 
 import org.apache.jackrabbit.vault.fs.io.Archive;
 import org.apache.jackrabbit.vault.fs.io.Archive.Entry;
 import org.apache.sling.cp2fm.ContentPackage2FeatureModelConverter;
 import org.apache.sling.feature.Configuration;
+import org.apache.sling.feature.Configurations;
 
 abstract class AbstractConfigurationEntryHandler extends AbstractRegexEntryHandler {
 
@@ -37,38 +37,35 @@ abstract class AbstractConfigurationEntryHandler extends AbstractRegexEntryHandl
 
         logger.info("Processing configuration '{}'.", name);
 
-        Dictionary<Object, Object> parsedConfiguration;
+        Configurations parsedConfigurations;
 
         try (InputStream input = archive.openInputStream(entry)) {
-            parsedConfiguration = parseConfiguration(input);
+            parsedConfigurations = parseConfigurations(name, input);
         }
 
-        if (!parsedConfiguration.isEmpty()) {
-            Configuration configuration = null;
+        if (!parsedConfigurations.isEmpty()) {
+            for (Configuration currentConfiguration : parsedConfigurations) {
 
-            dance : for (Configuration addedConfiguration : converter.getTargetFeature().getConfigurations()) {
-                if (name.equals(addedConfiguration.getPid())) {
-                    configuration = addedConfiguration;
-                    break dance;
-                }
-            }
+                Configuration configuration = converter.getTargetFeature()
+                                                       .getConfigurations()
+                                                       .getConfiguration(currentConfiguration.getPid());
 
-            if (configuration == null) {
-                configuration = new Configuration(name);
-                converter.getTargetFeature().getConfigurations().add(configuration);
-            }
-
-            Enumeration<Object> keys = parsedConfiguration.keys();
-            while (keys.hasMoreElements()) {
-                String key = keys.nextElement().toString();
-                Object value = parsedConfiguration.get(key);
-                configuration.getProperties().put(key, value);
+                if (configuration == null) {
+                    converter.getTargetFeature().getConfigurations().add(currentConfiguration);
+                } else {
+                    Enumeration<String> keys = currentConfiguration.getConfigurationProperties().keys();
+                    while (keys.hasMoreElements()) {
+                        String key = keys.nextElement();
+                        Object value = currentConfiguration.getConfigurationProperties().get(key);
+                        configuration.getProperties().put(key, value);
+                    }
+                }
             }
         } else {
             logger.warn("{} configuration is empty, omitting it from the Feature File", name);
         }
     }
 
-    protected abstract Dictionary<Object, Object> parseConfiguration(InputStream input) throws Exception;
+    protected abstract Configurations parseConfigurations(String name, InputStream input) throws Exception;
 
 }
diff --git a/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/AbstractSingleConfigurationEntryHandler.java b/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/AbstractSingleConfigurationEntryHandler.java
new file mode 100644
index 0000000..aff3a11
--- /dev/null
+++ b/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/AbstractSingleConfigurationEntryHandler.java
@@ -0,0 +1,55 @@
+/*
+ * 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.sling.cp2fm.handlers;
+
+import java.io.InputStream;
+import java.util.Dictionary;
+import java.util.Enumeration;
+
+import org.apache.sling.feature.Configuration;
+import org.apache.sling.feature.Configurations;
+
+abstract class AbstractSingleConfigurationEntryHandler extends AbstractConfigurationEntryHandler {
+
+    public AbstractSingleConfigurationEntryHandler(String regex) {
+        super(regex);
+    }
+
+    @Override
+    protected final Configurations parseConfigurations(String name, InputStream input) throws Exception {
+        Configurations configurations = new Configurations();
+
+        Dictionary<String, Object> configurationProperties = parseConfiguration(input);
+
+        if (!configurationProperties.isEmpty()) {
+            Configuration configuration = new Configuration(name);
+            Enumeration<String> keys = configurationProperties.keys();
+            while (keys.hasMoreElements()) {
+                String key = keys.nextElement();
+                Object value = configurationProperties.get(key);
+                configuration.getProperties().put(key, value);
+            }
+
+            configurations.add(configuration);
+        }
+
+        return configurations;
+    }
+
+    protected abstract Dictionary<String, Object> parseConfiguration(InputStream input) throws Exception;
+
+}
diff --git a/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/ConfigurationEntryHandler.java b/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/ConfigurationEntryHandler.java
index d4a90ef..2044cd3 100644
--- a/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/ConfigurationEntryHandler.java
+++ b/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/ConfigurationEntryHandler.java
@@ -21,7 +21,7 @@ import java.util.Dictionary;
 
 import org.apache.felix.cm.file.ConfigurationHandler;
 
-public final class ConfigurationEntryHandler extends AbstractConfigurationEntryHandler {
+public final class ConfigurationEntryHandler extends AbstractSingleConfigurationEntryHandler {
 
     public ConfigurationEntryHandler() {
         super(".+\\.config");
@@ -29,7 +29,7 @@ public final class ConfigurationEntryHandler extends AbstractConfigurationEntryH
 
     @Override
     @SuppressWarnings("unchecked")
-    protected Dictionary<Object, Object> parseConfiguration(InputStream input) throws Exception {
+    protected Dictionary<String, Object> parseConfiguration(InputStream input) throws Exception {
         return ConfigurationHandler.read(input);
     }
 
diff --git a/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/ConfigurationEntryHandler.java b/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/JsonConfigurationEntryHandler.java
similarity index 61%
copy from content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/ConfigurationEntryHandler.java
copy to content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/JsonConfigurationEntryHandler.java
index d4a90ef..8494b13 100644
--- a/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/ConfigurationEntryHandler.java
+++ b/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/JsonConfigurationEntryHandler.java
@@ -17,20 +17,22 @@
 package org.apache.sling.cp2fm.handlers;
 
 import java.io.InputStream;
-import java.util.Dictionary;
+import java.io.InputStreamReader;
 
-import org.apache.felix.cm.file.ConfigurationHandler;
+import org.apache.sling.feature.Configurations;
+import org.apache.sling.feature.io.json.ConfigurationJSONReader;
 
-public final class ConfigurationEntryHandler extends AbstractConfigurationEntryHandler {
+public final class JsonConfigurationEntryHandler extends AbstractConfigurationEntryHandler {
 
-    public ConfigurationEntryHandler() {
-        super(".+\\.config");
+    public JsonConfigurationEntryHandler() {
+        super("[^/]+\\.cfg\\.json");
     }
 
     @Override
-    @SuppressWarnings("unchecked")
-    protected Dictionary<Object, Object> parseConfiguration(InputStream input) throws Exception {
-        return ConfigurationHandler.read(input);
+    protected Configurations parseConfigurations(String name, InputStream input) throws Exception {
+        try (InputStreamReader reader = new InputStreamReader(input)) {
+            return ConfigurationJSONReader.read(reader, name);
+        }
     }
 
 }
diff --git a/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/PropertiesConfigurationEntryHandler.java b/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/PropertiesConfigurationEntryHandler.java
index d7f08e0..54f946f 100644
--- a/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/PropertiesConfigurationEntryHandler.java
+++ b/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/PropertiesConfigurationEntryHandler.java
@@ -21,7 +21,7 @@ import java.util.Dictionary;
 
 import org.apache.felix.utils.properties.ConfigurationHandler;
 
-public final class PropertiesConfigurationEntryHandler extends AbstractConfigurationEntryHandler {
+public final class PropertiesConfigurationEntryHandler extends AbstractSingleConfigurationEntryHandler {
 
     public PropertiesConfigurationEntryHandler() {
         super("[^/]+\\.(cfg|properties)");
@@ -29,7 +29,7 @@ public final class PropertiesConfigurationEntryHandler extends AbstractConfigura
 
     @Override
     @SuppressWarnings("unchecked")
-    protected Dictionary<Object, Object> parseConfiguration(InputStream input) throws Exception {
+    protected Dictionary<String, Object> parseConfiguration(InputStream input) throws Exception {
         return ConfigurationHandler.read(input);
     }
 
diff --git a/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/XmlConfigurationEntryHandler.java b/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/XmlConfigurationEntryHandler.java
index 1f75d03..7d7a4f2 100644
--- a/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/XmlConfigurationEntryHandler.java
+++ b/content-package-2-feature-model/src/main/java/org/apache/sling/cp2fm/handlers/XmlConfigurationEntryHandler.java
@@ -18,18 +18,20 @@ package org.apache.sling.cp2fm.handlers;
 
 import static org.apache.jackrabbit.JcrConstants.JCR_PRIMARYTYPE;
 
+import java.io.IOException;
 import java.io.InputStream;
 import java.util.Dictionary;
-import java.util.Properties;
+import java.util.Hashtable;
 
 import javax.xml.parsers.SAXParser;
 import javax.xml.parsers.SAXParserFactory;
 
+import org.apache.felix.utils.properties.ConfigurationHandler;
 import org.xml.sax.Attributes;
 import org.xml.sax.SAXException;
 import org.xml.sax.helpers.DefaultHandler;
 
-public final class XmlConfigurationEntryHandler extends AbstractConfigurationEntryHandler {
+public final class XmlConfigurationEntryHandler extends AbstractSingleConfigurationEntryHandler {
 
     private static final String JCR_ROOT = "jcr:root";
 
@@ -44,7 +46,7 @@ public final class XmlConfigurationEntryHandler extends AbstractConfigurationEnt
     }
 
     @Override
-    protected Dictionary<Object, Object> parseConfiguration(InputStream input) throws Exception {
+    protected Dictionary<String, Object> parseConfiguration(InputStream input) throws Exception {
         SAXParser saxParser = saxParserFactory.newSAXParser();
         JcrConfigurationHandler configurationHandler = new JcrConfigurationHandler();
         saxParser.parse(input, configurationHandler);
@@ -53,9 +55,9 @@ public final class XmlConfigurationEntryHandler extends AbstractConfigurationEnt
 
     private static final class JcrConfigurationHandler extends DefaultHandler {
 
-        private final Properties configuration = new Properties();
+        private final Dictionary<String, Object> configuration = new Hashtable<>();
 
-        public Properties getConfiguration() {
+        public Dictionary<String, Object> getConfiguration() {
             return configuration;
         }
 
@@ -69,9 +71,9 @@ public final class XmlConfigurationEntryHandler extends AbstractConfigurationEnt
                     String attributeQName = attributes.getQName(i);
 
                     if (!attributeQName.startsWith(JCR_PREFIX) && !attributeQName.startsWith(XMLNS_PREFIX)) {
-                        String attributeVale = attributes.getValue(i);
+                        String attributeValue = attributes.getValue(i);
 
-                        configuration.put(attributeQName, attributeVale);
+                        configuration.put(attributeQName, attributeValue);
                     }
                 }
             }