refactor(osgi): migrated to OSGi Service Component annotations from A…

…pache Felix XC + Remove Apache Felix SCR annotations as they're unsupported. + Add OSGi Service Component annotations to ManagedKubernetesClient and ManagedOpenShiftClient Signed-off-by: Rohan Kumar <[email protected]>
fabric8io · Aug 28, 2024 · 24f1b8e · 24f1b8e
1 parent 150c111
commit 24f1b8e
Show file tree

Hide file tree

Showing 11 changed files with 54 additions and 125 deletions.
diff --git a/doc/MIGRATION-v7.md b/doc/MIGRATION-v7.md
@@ -2,6 +2,7 @@
 
 ## Contents
 - [Bouncy Castle is no longer needed](#bouncy-castle)
+- [Apache Felix SCR Annotations removed](#apache-felix-scr-annotations)
 - [Model Changes](#model-changes)
   - [kubernetes-model artifact removed](#kubernetes-model-artifact-removed)
 - [Deprecations and Removals](#deprecations-and-removals)
@@ -20,6 +21,12 @@ The Bouncy Castle library is no longer needed as a dependency.
 In previous versions, this was an optional dependency needed for Elliptic Curve (EC) Keys.
 The Kubernetes client now uses the default Java security provider which should be enough to handle all scenarios.
 
+## Apache Felix SCR annotations removed <a href="#apache-felix-scr-annotations" id="apache-felix-scr-annotations" />
+
+[Apache Felix SCR annotations](https://felix.apache.org/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html) are not supported anymore by community. Fabric8 Kubernetes Client no longer uses Apache Felix SCR annotations for OSGi
+Declarative Services. Fabric8 Kubernetes Client is now using official OSGi annotations instead. If you're using Apache Felix SCR
+annotations, you need to switch to [Official OSGi Component annotations](https://docs.osgi.org/javadoc/r6/cmpn/org/osgi/service/component/annotations/package-summary.html).
+
 ## Model Changes <a href="#model-changes" id="model-changes"/>
 
 ### kubernetes-model artifact removed <a href="#kubernetes-model-artifact-removed" id="kubernetes-model-artifact-removed"/>

diff --git a/kubernetes-client-api/pom.xml b/kubernetes-client-api/pom.xml
@@ -180,12 +180,11 @@
       <artifactId>lombok</artifactId>
     </dependency>
     <dependency>
-      <groupId>org.apache.felix</groupId>
-      <artifactId>org.apache.felix.scr.annotations</artifactId>
-      <version>${scr.annotations.version}</version>
-      <scope>compile</scope>
-      <optional>true</optional>
-    </dependency>
+     <groupId>org.osgi</groupId>
+     <artifactId>org.osgi.service.component.annotations</artifactId>
+     <scope>compile</scope>
+     <optional>true</optional>
+   </dependency>
 
     <!-- Testing Dependencies -->
     <dependency>
@@ -275,22 +274,6 @@
           </execution>
         </executions>
       </plugin>
-      <plugin>
-        <groupId>org.apache.felix</groupId>
-        <artifactId>maven-scr-plugin</artifactId>
-        <version>${maven.scr.plugin.version}</version>
-        <executions>
-          <execution>
-            <goals>
-              <goal>scr</goal>
-            </goals>
-            <configuration>
-              <specVersion>1.2</specVersion>
-              <strictMode>true</strictMode>
-            </configuration>
-          </execution>
-        </executions>
-      </plugin>
       <plugin>
         <groupId>org.apache.felix</groupId>
         <artifactId>maven-bundle-plugin</artifactId>

diff --git a/kubernetes-client/pom.xml b/kubernetes-client/pom.xml
@@ -97,9 +97,8 @@
       <artifactId>lombok</artifactId>
     </dependency>
     <dependency>
-      <groupId>org.apache.felix</groupId>
-      <artifactId>org.apache.felix.scr.annotations</artifactId>
-      <version>${scr.annotations.version}</version>
+      <groupId>org.osgi</groupId>
+      <artifactId>org.osgi.service.component.annotations</artifactId>
       <scope>compile</scope>
       <optional>true</optional>
     </dependency>
@@ -193,22 +192,6 @@
           </execution>
         </executions>
       </plugin>
-      <plugin>
-        <groupId>org.apache.felix</groupId>
-        <artifactId>maven-scr-plugin</artifactId>
-        <version>${maven.scr.plugin.version}</version>
-        <executions>
-          <execution>
-            <goals>
-              <goal>scr</goal>
-            </goals>
-            <configuration>
-              <specVersion>1.2</specVersion>
-              <strictMode>true</strictMode>
-            </configuration>
-          </execution>
-        </executions>
-      </plugin>
       <plugin>
         <groupId>org.apache.felix</groupId>
         <artifactId>maven-bundle-plugin</artifactId>

diff --git a/...netes-client/src/main/java/io/fabric8/kubernetes/client/osgi/ManagedKubernetesClient.java b/...netes-client/src/main/java/io/fabric8/kubernetes/client/osgi/ManagedKubernetesClient.java
@@ -23,16 +23,6 @@
 import io.fabric8.kubernetes.client.OAuthTokenProvider;
 import io.fabric8.kubernetes.client.impl.KubernetesClientImpl;
 import io.fabric8.kubernetes.client.impl.ResourceHandler;
-import org.apache.felix.scr.annotations.Activate;
-import org.apache.felix.scr.annotations.Component;
-import org.apache.felix.scr.annotations.ConfigurationPolicy;
-import org.apache.felix.scr.annotations.Deactivate;
-import org.apache.felix.scr.annotations.Reference;
-import org.apache.felix.scr.annotations.ReferenceCardinality;
-import org.apache.felix.scr.annotations.ReferencePolicy;
-import org.apache.felix.scr.annotations.ReferencePolicyOption;
-import org.apache.felix.scr.annotations.References;
-import org.apache.felix.scr.annotations.Service;
 
 import java.util.Map;
 
@@ -62,12 +52,11 @@
 import static io.fabric8.kubernetes.client.Config.KUBERNETES_WATCH_RECONNECT_LIMIT_SYSTEM_PROPERTY;
 import static io.fabric8.kubernetes.client.Config.KUBERNETES_WEBSOCKET_PING_INTERVAL_SYSTEM_PROPERTY;
 
-@Component(configurationPid = "io.fabric8.kubernetes.client", policy = ConfigurationPolicy.REQUIRE)
-@Service({ KubernetesClient.class, NamespacedKubernetesClient.class })
-@References({
-    @Reference(referenceInterface = ResourceHandler.class, cardinality = ReferenceCardinality.OPTIONAL_MULTIPLE, policy = ReferencePolicy.DYNAMIC, bind = "bindResourceHandler", unbind = "unbindResourceHandler"),
-    @Reference(referenceInterface = OAuthTokenProvider.class, cardinality = ReferenceCardinality.OPTIONAL_UNARY, policyOption = ReferencePolicyOption.GREEDY, bind = "bindOAuthTokenProvider", unbind = "unbindOAuthTokenProvider")
-})
+@org.osgi.service.component.annotations.Component(configurationPid = "io.fabric8.kubernetes.client", name = "io.fabric8.kubernetes.client.osgi.ManagedKubernetesClient", scope = org.osgi.service.component.annotations.ServiceScope.SINGLETON, service = {
+    KubernetesClient.class, NamespacedKubernetesClient.class }, reference = {
+        @org.osgi.service.component.annotations.Reference(name = "resourceHandler", service = io.fabric8.kubernetes.client.impl.ResourceHandler.class, cardinality = org.osgi.service.component.annotations.ReferenceCardinality.MULTIPLE, policy = org.osgi.service.component.annotations.ReferencePolicy.DYNAMIC, bind = "bindResourceHandler", unbind = "unbindResourceHandler"),
+        @org.osgi.service.component.annotations.Reference(name = "oAuthTokenProvider", service = OAuthTokenProvider.class, cardinality = org.osgi.service.component.annotations.ReferenceCardinality.OPTIONAL, policyOption = org.osgi.service.component.annotations.ReferencePolicyOption.GREEDY, bind = "bindOAuthTokenProvider", unbind = "unbindOAuthTokenProvider"),
+    }, configurationPolicy = org.osgi.service.component.annotations.ConfigurationPolicy.REQUIRE)
 public class ManagedKubernetesClient extends NamespacedKubernetesClientAdapter<KubernetesClientImpl> {
 
   public ManagedKubernetesClient() {
@@ -76,7 +65,7 @@ public ManagedKubernetesClient() {
 
   private OAuthTokenProvider provider;
 
-  @Activate
+  @org.osgi.service.component.annotations.Activate
   public void activate(Map<String, Object> properties) {
     final ConfigBuilder builder = new ConfigBuilder();
 
@@ -166,7 +155,7 @@ public void activate(Map<String, Object> properties) {
     this.init(new KubernetesClientBuilder().withConfig(builder.build()).build());
   }
 
-  @Deactivate
+  @org.osgi.service.component.annotations.Deactivate
   public void deactivate() {
     this.close();
   }

diff --git a/openshift-client-api/pom.xml b/openshift-client-api/pom.xml
@@ -128,13 +128,12 @@
      <artifactId>lombok</artifactId>
    </dependency>
 
-    <dependency>
-      <groupId>org.apache.felix</groupId>
-      <artifactId>org.apache.felix.scr.annotations</artifactId>
-      <version>${scr.annotations.version}</version>
-      <scope>compile</scope>
-      <optional>true</optional>
-    </dependency>
+   <dependency>
+     <groupId>org.osgi</groupId>
+     <artifactId>org.osgi.service.component.annotations</artifactId>
+     <scope>compile</scope>
+     <optional>true</optional>
+   </dependency>
 
     <!-- Testing Dependencies -->
     <dependency>
@@ -219,22 +218,6 @@
           </execution>
         </executions>
       </plugin>
-      <plugin>
-        <groupId>org.apache.felix</groupId>
-        <artifactId>maven-scr-plugin</artifactId>
-        <version>${maven.scr.plugin.version}</version>
-        <executions>
-          <execution>
-            <goals>
-              <goal>scr</goal>
-            </goals>
-            <configuration>
-              <specVersion>1.2</specVersion>
-              <strictMode>true</strictMode>
-            </configuration>
-          </execution>
-        </executions>
-      </plugin>
       <plugin>
         <groupId>org.apache.felix</groupId>
         <artifactId>maven-bundle-plugin</artifactId>

diff --git a/openshift-client/pom.xml b/openshift-client/pom.xml
@@ -78,13 +78,12 @@
       <artifactId>lombok</artifactId>
     </dependency>
 
-    <dependency>
-      <groupId>org.apache.felix</groupId>
-      <artifactId>org.apache.felix.scr.annotations</artifactId>
-      <version>${scr.annotations.version}</version>
-      <scope>compile</scope>
-      <optional>true</optional>
-    </dependency>
+   <dependency>
+     <groupId>org.osgi</groupId>
+     <artifactId>org.osgi.service.component.annotations</artifactId>
+     <scope>compile</scope>
+     <optional>true</optional>
+   </dependency>
 
     <!-- Testing Dependencies -->
     <dependency>
@@ -186,22 +185,6 @@
           </execution>
         </executions>
       </plugin>
-      <plugin>
-        <groupId>org.apache.felix</groupId>
-        <artifactId>maven-scr-plugin</artifactId>
-        <version>${maven.scr.plugin.version}</version>
-        <executions>
-          <execution>
-            <goals>
-              <goal>scr</goal>
-            </goals>
-            <configuration>
-              <specVersion>1.2</specVersion>
-              <strictMode>true</strictMode>
-            </configuration>
-          </execution>
-        </executions>
-      </plugin>
       <plugin>
         <groupId>org.apache.felix</groupId>
         <artifactId>maven-bundle-plugin</artifactId>

diff --git a/...t/src/main/java/io/fabric8/openshift/client/impl/NamespacedOpenShiftExtensionAdapter.java b/...t/src/main/java/io/fabric8/openshift/client/impl/NamespacedOpenShiftExtensionAdapter.java
@@ -18,15 +18,12 @@
 import io.fabric8.kubernetes.client.Client;
 import io.fabric8.kubernetes.client.extension.ExtensionAdapter;
 import io.fabric8.openshift.client.NamespacedOpenShiftClient;
-import org.apache.felix.scr.annotations.Component;
-import org.apache.felix.scr.annotations.Service;
 
 /**
  * This class is necessary because the extension logic checks for an exact class match,
  * even though an {@link OpenShiftClientImpl} is already known via the {@link OpenShiftExtensionAdapter}
  */
-@Component
-@Service
+@org.osgi.service.component.annotations.Component(name = "io.fabric8.openshift.client.impl.NamespacedOpenShiftExtensionAdapter", scope = org.osgi.service.component.annotations.ServiceScope.SINGLETON, service = ExtensionAdapter.class)
 public class NamespacedOpenShiftExtensionAdapter implements ExtensionAdapter<NamespacedOpenShiftClient> {
 
   @Override

diff --git a/...hift-client/src/main/java/io/fabric8/openshift/client/impl/OpenShiftExtensionAdapter.java b/...hift-client/src/main/java/io/fabric8/openshift/client/impl/OpenShiftExtensionAdapter.java
@@ -47,11 +47,9 @@
 import io.fabric8.openshift.client.dsl.internal.build.BuildOperationsImpl;
 import io.fabric8.openshift.client.dsl.internal.core.TemplateOperationsImpl;
 import io.fabric8.openshift.client.dsl.internal.project.ProjectOperationsImpl;
-import org.apache.felix.scr.annotations.Component;
-import org.apache.felix.scr.annotations.Service;
 
-@Component
-@Service
+@org.osgi.service.component.annotations.Component(name = "io.fabric8.openshift.client.impl.OpenShiftExtensionAdapter", scope = org.osgi.service.component.annotations.ServiceScope.SINGLETON, service = {
+    ExtensionAdapter.class, InternalExtensionAdapter.class })
 public class OpenShiftExtensionAdapter implements ExtensionAdapter<OpenShiftClient>, InternalExtensionAdapter {
 
   @Override

diff --git a/openshift-client/src/main/java/io/fabric8/openshift/client/osgi/ManagedOpenShiftClient.java b/openshift-client/src/main/java/io/fabric8/openshift/client/osgi/ManagedOpenShiftClient.java
@@ -21,11 +21,6 @@
 import io.fabric8.openshift.client.NamespacedOpenShiftClientAdapter;
 import io.fabric8.openshift.client.OpenShiftClient;
 import io.fabric8.openshift.client.OpenShiftConfigBuilder;
-import org.apache.felix.scr.annotations.Activate;
-import org.apache.felix.scr.annotations.Component;
-import org.apache.felix.scr.annotations.ConfigurationPolicy;
-import org.apache.felix.scr.annotations.Deactivate;
-import org.apache.felix.scr.annotations.Service;
 
 import java.util.Map;
 
@@ -54,11 +49,12 @@
 import static io.fabric8.openshift.client.OpenShiftConfig.OPENSHIFT_BUILD_TIMEOUT_SYSTEM_PROPERTY;
 import static io.fabric8.openshift.client.OpenShiftConfig.OPENSHIFT_URL_SYSTEM_PROPERTY;
 
-@Component(configurationPid = "io.fabric8.openshift.client", policy = ConfigurationPolicy.REQUIRE)
-@Service({ OpenShiftClient.class, NamespacedOpenShiftClient.class })
+@org.osgi.service.component.annotations.Component(configurationPid = "io.fabric8.openshift.client", name = "io.fabric8.openshift.client.osgi.ManagedOpenShiftClient", scope = org.osgi.service.component.annotations.ServiceScope.SINGLETON, service = {
+    OpenShiftClient.class,
+    NamespacedOpenShiftClient.class }, configurationPolicy = org.osgi.service.component.annotations.ConfigurationPolicy.REQUIRE)
 public class ManagedOpenShiftClient extends NamespacedOpenShiftClientAdapter {
 
-  @Activate
+  @org.osgi.service.component.annotations.Activate
   public void activate(Map<String, Object> properties) {
     final OpenShiftConfigBuilder builder = new OpenShiftConfigBuilder();
 
@@ -145,7 +141,7 @@ public void activate(Map<String, Object> properties) {
     this.init(delegate);
   }
 
-  @Deactivate
+  @org.osgi.service.component.annotations.Deactivate
   public void deactivate() {
     getClient().close();
   }

diff --git a/platforms/karaf/features/src/main/resources/feature.xml b/platforms/karaf/features/src/main/resources/feature.xml
@@ -16,8 +16,11 @@
 
 -->
 <features xmlns="http://karaf.apache.org/xmlns/features/v1.2.0" name="kuberntes-features-${project.version}">
-
+  <feature name="scr" description="Declarative Service support" version="${project.version}">
+    <bundle start-level="30">mvn:org.apache.felix/org.apache.felix.scr/${felix.scr.version}</bundle>
+  </feature>
   <feature name="kubernetes-client" description="Fabric8 Kubernetes Client" version="${project.version}">
+    <feature>scr</feature>
     <bundle dependency='true'>mvn:com.google.code.findbugs/jsr305/${jsr305.version}</bundle>
     <bundle dependency='true'>mvn:com.fasterxml.jackson.core/jackson-core/${jackson.bundle.version}</bundle>
     <bundle dependency='true'>mvn:com.fasterxml.jackson.core/jackson-annotations/${jackson.bundle.version}</bundle>

diff --git a/pom.xml b/pom.xml
@@ -133,7 +133,8 @@
     <commons-compress.version>1.27.1</commons-compress.version>
     <commons-io.version>2.16.1</commons-io.version> <!-- Required by Gradle Testing Toolkit -->
     <guava.version>33.3.0-jre</guava.version> <!-- Required by Gradle Testing Toolkit -->
-    <scr.annotations.version>1.12.0</scr.annotations.version>
+    <osgi.annotations.version>1.5.0</osgi.annotations.version>
+    <felix.scr.version>2.0.6</felix.scr.version>
     <jsonschema2pojo.version>1.2.1</jsonschema2pojo.version>
     <picocli.version>4.7.6</picocli.version>
     <properties.maven.plugin.version>1.0.0</properties.maven.plugin.version>
@@ -147,7 +148,6 @@
     <maven.buildhelper.plugin.version>3.6.0</maven.buildhelper.plugin.version>
     <maven.jar.plugin.version>3.4.2</maven.jar.plugin.version>
     <maven.surefire.plugin.version>3.4.0</maven.surefire.plugin.version>
-    <maven.scr.plugin.version>1.26.4</maven.scr.plugin.version>
     <maven.resources.plugin.version>3.3.1</maven.resources.plugin.version>
     <maven.release.plugin.version>3.1.1</maven.release.plugin.version>
     <maven.javadoc.plugin.version>3.8.0</maven.javadoc.plugin.version>
@@ -882,6 +882,13 @@
         <artifactId>okio</artifactId>
         <version>${okio.version}</version>
       </dependency>
+      <dependency>
+        <groupId>org.osgi</groupId>
+        <artifactId>org.osgi.service.component.annotations</artifactId>
+        <version>${osgi.annotations.version}</version>
+        <scope>compile</scope>
+        <optional>true</optional>
+      </dependency>
 
       <!-- Testing and Mocking -->
       <dependency>