Introduce api module with io.smallrye.config.api.Config interface

smallrye · Sep 19, 2023 · 2e940db · 2e940db
1 parent e06b7b7
commit 2e940db
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 3 deletions.
diff --git a/api/pom.xml b/api/pom.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>io.smallrye.config</groupId>
+        <artifactId>smallrye-config-parent</artifactId>
+        <version>3.3.4-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>smallrye-config-api</artifactId>
+    <name>SmallRye Config: API</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.eclipse.microprofile.config</groupId>
+            <artifactId>microprofile-config-api</artifactId>
+        </dependency>
+    </dependencies>
+</project>
diff --git a/api/src/main/java/io/smallrye/config/api/SmallRyeConfig.java b/api/src/main/java/io/smallrye/config/api/SmallRyeConfig.java
@@ -0,0 +1,8 @@
+package io.smallrye.config.api;
+
+import java.io.Serializable;
+
+import org.eclipse.microprofile.config.Config;
+
+public interface SmallRyeConfig extends Config, Serializable {
+}
diff --git a/implementation/pom.xml b/implementation/pom.xml
@@ -29,8 +29,8 @@
 
   <dependencies>
     <dependency>
-      <groupId>org.eclipse.microprofile.config</groupId>
-      <artifactId>microprofile-config-api</artifactId>
+      <groupId>io.smallrye.config</groupId>
+      <artifactId>smallrye-config-api</artifactId>
     </dependency>
     <dependency>
       <groupId>jakarta.annotation</groupId>

diff --git a/implementation/src/main/java/io/smallrye/config/SmallRyeConfig.java b/implementation/src/main/java/io/smallrye/config/SmallRyeConfig.java
@@ -49,7 +49,7 @@
 /**
  * @author <a href="http://jmesnil.net/">Jeff Mesnil</a> (c) 2017 Red Hat inc.
  */
-public class SmallRyeConfig implements Config, Serializable {
+public class SmallRyeConfig implements io.smallrye.config.api.SmallRyeConfig {
     public static final String SMALLRYE_CONFIG_PROFILE = "smallrye.config.profile";
     public static final String SMALLRYE_CONFIG_PROFILE_PARENT = "smallrye.config.profile.parent";
     public static final String SMALLRYE_CONFIG_LOCATIONS = "smallrye.config.locations";

diff --git a/pom.xml b/pom.xml
@@ -81,6 +81,7 @@
     <module>testsuite</module>
     <module>documentation</module>
     <module>examples</module>
+      <module>api</module>
   </modules>
 
   <dependencyManagement>
@@ -125,6 +126,11 @@
         <artifactId>smallrye-config-core</artifactId>
         <version>${project.version}</version>
       </dependency>
+      <dependency>
+        <groupId>io.smallrye.config</groupId>
+        <artifactId>smallrye-config-api</artifactId>
+        <version>${project.version}</version>
+      </dependency>
       <dependency>
         <groupId>io.smallrye.config</groupId>
         <artifactId>smallrye-config</artifactId>