[karaf] branch main updated: [KARAF-7099] Add ConfigurationPID util class

[jb...@apache.org]

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

jbonofre pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/karaf.git


The following commit(s) were added to refs/heads/main by this push:
     new ca320a9  [KARAF-7099] Add ConfigurationPID util class
     new db34542  Merge pull request #1368 from jbonofre/KARAF-7099
ca320a9 is described below

commit ca320a9c2d1f0328edb9666e0fe7a276edb5ab32
Author: jbonofre <jb...@apache.org>
AuthorDate: Fri May 7 07:54:45 2021 +0200

    [KARAF-7099] Add ConfigurationPID util class
    
    Credit To: Oliver Lietz <ap...@oliverlietz.de>
---
 .../apache/karaf/util/config/ConfigurationPID.java |  96 ++++++++++++++++++
 .../karaf/util/config/ConfigurationPIDTest.java    | 108 +++++++++++++++++++++
 2 files changed, 204 insertions(+)

diff --git a/util/src/main/java/org/apache/karaf/util/config/ConfigurationPID.java b/util/src/main/java/org/apache/karaf/util/config/ConfigurationPID.java
new file mode 100644
index 0000000..b364dc3
--- /dev/null
+++ b/util/src/main/java/org/apache/karaf/util/config/ConfigurationPID.java
@@ -0,0 +1,96 @@
+/*
+ * 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.karaf.util.config;
+
+import java.util.Objects;
+
+public class ConfigurationPID {
+
+    private final String pid;
+    private final String factoryPid;
+    private final String name;
+
+    private static final String TILDE = "~";
+    private static final String DASH = "-";
+
+    public ConfigurationPID(final String pid) {
+        this.pid = pid;
+        this.factoryPid = null;
+        this.name = null;
+    }
+
+    public ConfigurationPID(final String pid, final String factoryPid, final String name) {
+        this.pid = pid;
+        this.factoryPid = factoryPid;
+        this.name = name;
+    }
+
+    public String getPid() {
+        return this.pid;
+    }
+
+    public String getFactoryPid() {
+        return this.factoryPid;
+    }
+
+    public String getName() {
+        return this.name;
+    }
+
+    public boolean isFactory() {
+        return Objects.nonNull(factoryPid);
+    }
+
+    public boolean isR7() {
+        return pid.contains(TILDE);
+    }
+
+    public static ConfigurationPID parsePid(final String pid) {
+        final int index = pid.contains(TILDE) ? pid.indexOf(TILDE) : pid.indexOf(DASH);
+        if (index > 0) {
+            final String factoryPid = pid.substring(0, index);
+            final String name = pid.substring(index + 1);
+            return new ConfigurationPID(pid, factoryPid, name);
+        } else {
+            return new ConfigurationPID(pid);
+        }
+    }
+
+    public static ConfigurationPID parseFilename(final String filename) {
+        final String pid = filename.substring(0, filename.lastIndexOf('.'));
+        return parsePid(pid);
+    }
+
+    public static ConfigurationPID parseFilename(final String filename, final String extension) {
+        final String pid;
+        if (extension.isEmpty()) {
+            pid = filename;
+        } else {
+            final String ending = String.format(".%s", extension);
+            if (filename.endsWith(ending)) {
+                pid = filename.substring(0, filename.length() - ending.length());
+            } else {
+                final String message = String.format("Parsing filename failed. Filename '%s' does not have given extension '%s'.", filename, extension);
+                throw new IllegalArgumentException(message);
+            }
+        }
+        return parsePid(pid);
+    }
+
+}
diff --git a/util/src/test/java/org/apache/karaf/util/config/ConfigurationPIDTest.java b/util/src/test/java/org/apache/karaf/util/config/ConfigurationPIDTest.java
new file mode 100644
index 0000000..5672e2e
--- /dev/null
+++ b/util/src/test/java/org/apache/karaf/util/config/ConfigurationPIDTest.java
@@ -0,0 +1,108 @@
+/*
+ * 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.karaf.util.config;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+public class ConfigurationPIDTest {
+
+    @Test
+    public void testR7FactoryPID() {
+        final String pid = "org.apache.karaf.test.my.factory~Foo";
+        final ConfigurationPID configurationPID = ConfigurationPID.parsePid(pid);
+        Assert.assertEquals(pid, configurationPID.getPid());
+        Assert.assertEquals("org.apache.karaf.test.my.factory", configurationPID.getFactoryPid());
+        Assert.assertEquals("Foo", configurationPID.getName());
+        Assert.assertTrue(configurationPID.isFactory());
+        Assert.assertTrue(configurationPID.isR7());
+    }
+
+    @Test
+    public void testNonR7FactoryPID() {
+        final String pid = "org.apache.karaf.test.my.factory-Foo";
+        final ConfigurationPID configurationPID = ConfigurationPID.parsePid(pid);
+        Assert.assertEquals(pid, configurationPID.getPid());
+        Assert.assertEquals("org.apache.karaf.test.my.factory", configurationPID.getFactoryPid());
+        Assert.assertEquals("Foo", configurationPID.getName());
+        Assert.assertTrue(configurationPID.isFactory());
+        Assert.assertFalse(configurationPID.isR7());
+    }
+
+    @Test
+    public void testR7FactoryPIDFromFilenameWithCfgExtension() {
+        final String filename = "org.apache.karaf.test.my.factory~Foo.cfg";
+        final ConfigurationPID configurationPID = ConfigurationPID.parseFilename(filename);
+        Assert.assertEquals("org.apache.karaf.test.my.factory", configurationPID.getFactoryPid());
+        Assert.assertEquals("Foo", configurationPID.getName());
+        Assert.assertTrue(configurationPID.isFactory());
+        Assert.assertTrue(configurationPID.isR7());
+    }
+
+    @Test
+    public void testR7FactoryPIDFromFilenameWithConfigExtension() {
+        final String filename = "org.apache.karaf.test.my.factory~Foo.config";
+        final ConfigurationPID configurationPID = ConfigurationPID.parseFilename(filename);
+        Assert.assertEquals("org.apache.karaf.test.my.factory", configurationPID.getFactoryPid());
+        Assert.assertEquals("Foo", configurationPID.getName());
+        Assert.assertTrue(configurationPID.isR7());
+        Assert.assertTrue(configurationPID.isFactory());
+    }
+
+    @Test
+    public void testR7FactoryPIDFromFilenameWithJsonExtension() {
+        final String filename = "org.apache.karaf.test.my.factory~Foo.json";
+        final ConfigurationPID configurationPID = ConfigurationPID.parseFilename(filename);
+        Assert.assertEquals("org.apache.karaf.test.my.factory", configurationPID.getFactoryPid());
+        Assert.assertEquals("Foo", configurationPID.getName());
+        Assert.assertTrue(configurationPID.isR7());
+        Assert.assertTrue(configurationPID.isFactory());
+    }
+
+    @Test
+    public void testR7FactoryPIDFromFilenameWithCfgJsonExtension() {
+        final String filename = "org.apache.karaf.test.my.factory~Foo.cfg.json";
+        final ConfigurationPID configurationPID = ConfigurationPID.parseFilename(filename, "cfg.json");
+        Assert.assertEquals("org.apache.karaf.test.my.factory", configurationPID.getFactoryPid());
+        Assert.assertEquals("Foo", configurationPID.getName());
+        Assert.assertTrue(configurationPID.isR7());
+        Assert.assertTrue(configurationPID.isFactory());
+    }
+
+    @Test
+    public void testR7FactoryPIDFromFilenameWithNoExtension() {
+        final String filename = "org.apache.karaf.test.my.factory~Foo";
+        final ConfigurationPID configurationPID = ConfigurationPID.parseFilename(filename, "");
+        Assert.assertEquals("org.apache.karaf.test.my.factory", configurationPID.getFactoryPid());
+        Assert.assertEquals("Foo", configurationPID.getName());
+        Assert.assertTrue(configurationPID.isR7());
+        Assert.assertTrue(configurationPID.isFactory());
+    }
+
+    @Test
+    public void testNonR7FactoryPIDFromFilenameWithCfg() {
+        final String filename = "org.apache.karaf.test.my.factory-Foo.cfg";
+        final ConfigurationPID configurationPID = ConfigurationPID.parseFilename(filename);
+        Assert.assertEquals("org.apache.karaf.test.my.factory", configurationPID.getFactoryPid());
+        Assert.assertEquals("Foo", configurationPID.getName());
+        Assert.assertFalse(configurationPID.isR7());
+        Assert.assertTrue(configurationPID.isFactory());
+    }
+
+}