[OSGi] - Cleanup BudleActivator and Service registration, Update bnd …

…and osgi deps (#9361) refactor: OSGi improvements * update bnd-version Signed-off-by: Stefan Bischof <[email protected]> * update osgi dependency and version Signed-off-by: Stefan Bischof <[email protected]> * fix mocking osgi-classes Signed-off-by: Stefan Bischof <[email protected]> * OSGiResourceProvider uses @component to declare the service Signed-off-by: Stefan Bischof <[email protected]> * VaadinBundleTracker uses @component to declare the service Signed-off-by: Stefan Bischof <[email protected]> * Remove `empty` BundleActivator Signed-off-by: Stefan Bischof <[email protected]> * use constants for osgi.http.whiteboard.servlet.pattern Signed-off-by: Stefan Bischof <[email protected]> * fix unregister Service PolymerPublishedEventRpcHandler Signed-off-by: Stefan Bischof <[email protected]> * registers PolymerPublishedEventRpcHandler as a declarative service Signed-off-by: Stefan Bischof <[email protected]>
vaadin · Nov 11, 2020 · 1df5b02 · 1df5b02
1 parent f28e07a
commit 1df5b02
Show file tree

Hide file tree

Showing 17 changed files with 77 additions and 125 deletions.
diff --git a/flow-client/pom.xml b/flow-client/pom.xml
@@ -68,7 +68,7 @@
 
         <dependency>
             <groupId>org.osgi</groupId>
-            <artifactId>org.osgi.core</artifactId>
+            <artifactId>osgi.core</artifactId>
             <version>${osgi.core.version}</version>
             <scope>provided</scope>
         </dependency>

diff --git a/flow-data/pom.xml b/flow-data/pom.xml
@@ -35,7 +35,7 @@
 
         <dependency>
             <groupId>org.osgi</groupId>
-            <artifactId>org.osgi.core</artifactId>
+            <artifactId>osgi.core</artifactId>
             <version>${osgi.core.version}</version>
             <scope>provided</scope>
         </dependency>

diff --git a/flow-dnd/pom.xml b/flow-dnd/pom.xml
@@ -33,7 +33,7 @@
         </dependency>
         <dependency>
             <groupId>org.osgi</groupId>
-            <artifactId>org.osgi.core</artifactId>
+            <artifactId>osgi.core</artifactId>
             <version>${osgi.core.version}</version>
             <scope>provided</scope>
         </dependency>

diff --git a/flow-lit-template/pom.xml b/flow-lit-template/pom.xml
@@ -71,7 +71,7 @@
 
         <dependency>
             <groupId>org.osgi</groupId>
-            <artifactId>org.osgi.core</artifactId>
+            <artifactId>osgi.core</artifactId>
             <version>${osgi.core.version}</version>
             <scope>provided</scope>
         </dependency>

diff --git a/flow-polymer-template/pom.xml b/flow-polymer-template/pom.xml
@@ -86,7 +86,7 @@
 
         <dependency>
             <groupId>org.osgi</groupId>
-            <artifactId>org.osgi.core</artifactId>
+            <artifactId>osgi.core</artifactId>
             <version>${osgi.core.version}</version>
             <scope>provided</scope>
         </dependency>

diff --git a/...adin/flow/component/polymertemplate/rpc/OSGiPolymerPublishedEventHandlerRegistration.java b/...adin/flow/component/polymertemplate/rpc/OSGiPolymerPublishedEventHandlerRegistration.java
diff --git a/...n/java/com/vaadin/flow/component/polymertemplate/rpc/PolymerPublishedEventRpcHandler.java b/...n/java/com/vaadin/flow/component/polymertemplate/rpc/PolymerPublishedEventRpcHandler.java
@@ -22,6 +22,7 @@
 import com.vaadin.flow.component.UI;
 import com.vaadin.flow.component.polymertemplate.PolymerTemplate;
 import com.vaadin.flow.component.template.internal.DeprecatedPolymerPublishedEventHandler;
+import com.vaadin.flow.di.Lookup;
 import com.vaadin.flow.internal.StateNode;
 import com.vaadin.flow.templatemodel.ModelType;
 
@@ -31,8 +32,11 @@
 /**
  * Polymer utilitiy class for handling polymer rpc events for @EventHandler.
  *
+ * Registers {@link PolymerPublishedEventRpcHandler} as a service to make it
+ * available in {@link Lookup} in an OSGi container. *
  * @since
  */
+@org.osgi.service.component.annotations.Component(immediate = true)
 public class PolymerPublishedEventRpcHandler
         implements DeprecatedPolymerPublishedEventHandler {
 

diff --git a/flow-push/pom.xml b/flow-push/pom.xml
@@ -21,7 +21,7 @@
         </dependency>
         <dependency>
             <groupId>org.osgi</groupId>
-            <artifactId>org.osgi.core</artifactId>
+            <artifactId>osgi.core</artifactId>
             <version>${osgi.core.version}</version>
             <scope>provided</scope>
         </dependency>

diff --git a/flow-server/bnd.bnd b/flow-server/bnd.bnd
@@ -10,4 +10,3 @@ Import-Package: org.atmosphere*;resolution:=optional;version='${atmosphere.runti
     *
 Export-Package: com.vaadin.flow.client,\
     !com.vaadin.flow.push*, com.vaadin.flow*;-noimport:=true
-Bundle-Activator: com.vaadin.flow.server.osgi.ServletContainerInitializerExtender
diff --git a/flow-server/pom.xml b/flow-server/pom.xml
@@ -166,11 +166,18 @@
 
         <dependency>
             <groupId>org.osgi</groupId>
-            <artifactId>org.osgi.core</artifactId>
+            <artifactId>osgi.core</artifactId>
             <version>${osgi.core.version}</version>
             <scope>provided</scope>
         </dependency>
 
+        <dependency>
+            <groupId>org.osgi</groupId>
+            <artifactId>osgi.cmpn</artifactId>
+            <version>${osgi.compendium.version}</version>
+            <scope>provided</scope>
+        </dependency>
+
         <!--  Connect Dependencies -->
         <dependency>
             <groupId>javax.validation</groupId>

diff --git a/flow-server/src/main/java/com/vaadin/flow/server/osgi/OSGiResourceProvider.java b/flow-server/src/main/java/com/vaadin/flow/server/osgi/OSGiResourceProvider.java
@@ -25,17 +25,19 @@
 
 import org.osgi.framework.Bundle;
 import org.osgi.framework.FrameworkUtil;
-
+import org.osgi.service.component.annotations.Component;
 import com.vaadin.flow.di.ResourceProvider;
 import com.vaadin.flow.server.VaadinServletService;
 
 /**
  * OSGi capable implementation of {@link ResourceProvider}.
+ * ServiceComponentRuntime activates this Service because of @Component
  * 
  * @author Vaadin Ltd
  * @since
  *
  */
+@Component
 public class OSGiResourceProvider implements ResourceProvider {
 
     @Override

diff --git a/...server/src/main/java/com/vaadin/flow/server/osgi/ServletContainerInitializerExtender.java b/...server/src/main/java/com/vaadin/flow/server/osgi/ServletContainerInitializerExtender.java
diff --git a/flow-server/src/main/java/com/vaadin/flow/server/osgi/VaadinBundleTracker.java b/flow-server/src/main/java/com/vaadin/flow/server/osgi/VaadinBundleTracker.java
@@ -45,6 +45,10 @@
 import org.osgi.framework.BundleEvent;
 import org.osgi.framework.ServiceRegistration;
 import org.osgi.framework.wiring.BundleWiring;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+import org.osgi.service.http.whiteboard.HttpWhiteboardConstants;
 import org.osgi.util.tracker.BundleTracker;
 import org.slf4j.LoggerFactory;
 
@@ -54,10 +58,12 @@
  * The tracker scans for all classes in active bundles which have
  * <b>Vaadin-OSGi-Extender</b> header and report them to the {@link OSGiAccess}
  * instance.
- *
+ * 
+ * OSGi ServiceComponentRuntime creates the Service immediate while activating the bundle.
  * @author Vaadin Ltd
  * @since 1.2
  */
+@Component(immediate = true)
 public class VaadinBundleTracker extends BundleTracker<Bundle> {
 
     private final Bundle flowServerBundle;
@@ -99,15 +105,26 @@ protected void doGet(HttpServletRequest req, HttpServletResponse resp)
 
     /**
      * Creates a new instance of a bundle tracker.
-     *
+     * OSGi ServiceComponentRuntime injects the BundleContext because of the @Activate
      * @param context
      *            the {@code BundleContext} against which the tracking is done
      */
+    @Activate
     public VaadinBundleTracker(BundleContext context) {
         super(context, Bundle.ACTIVE | Bundle.RESOLVED, null);
         flowServerBundle = context.getBundle();
+        open();
     }
+
 
+    /**
+     * OSGi ServiceComponentRuntime calls this method while unregister the Service(e.g when stop/uninstall the bundle)
+     */
+    @Deactivate
+    public void deactivate() {
+      close();
+      }
+
     @Override
     public Bundle addingBundle(Bundle bundle, BundleEvent event) {
         if ((bundle.getState() & Bundle.ACTIVE) != 0) {
@@ -145,7 +162,7 @@ public Bundle addingBundle(Bundle bundle, BundleEvent event) {
 
     private void registerPushResources(Bundle pushBundle) {
         Hashtable<String, Object> properties = new Hashtable<>();
-        properties.put("osgi.http.whiteboard.servlet.pattern",
+        properties.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_SERVLET_PATTERN,
                 "/VAADIN/static/push/*");
         servletPushRegistration.compareAndSet(null,
                 pushBundle.getBundleContext().registerService(Servlet.class,

diff --git a/flow-server/src/test/java/com/vaadin/flow/server/startup/EnableOSGiRunner.java b/flow-server/src/test/java/com/vaadin/flow/server/startup/EnableOSGiRunner.java
@@ -69,7 +69,7 @@ public synchronized Class<?> loadClass(String name)
                 Builder<Exception> builder = new ByteBuddy()
                         .subclass(Exception.class);
                 return builder.name("org.osgi.framework.InvalidSyntaxException")
-                        .make().load(this, ClassLoadingStrategy.Default.WRAPPER)
+                        .make().load(this, ClassLoadingStrategy.Default.CHILD_FIRST.allowExistingTypes())
                         .getLoaded();
             } else if (name.equals("org.osgi.framework.FrameworkUtil")) {
                 Builder<Object> builder = new ByteBuddy()
@@ -81,7 +81,7 @@ public synchronized Class<?> loadClass(String name)
                         .withParameter(Class.class)
                         .intercept(MethodDelegation.to(Interceptor.class))
                         .name(name).make()
-                        .load(this, ClassLoadingStrategy.Default.WRAPPER)
+                        .load(this, ClassLoadingStrategy.Default.CHILD_FIRST.allowExistingTypes())
                         .getLoaded();
                 return fwUtil;
             } else if (name.startsWith(vaadinPackagePrefix)) {
@@ -106,7 +106,7 @@ private Class<?> defineBundleClass() {
             Builder<?> builder = new ByteBuddy().makeInterface();
 
             Class<?> bundleClass = builder.name("org.osgi.framework.Bundle")
-                    .make().load(this, ClassLoadingStrategy.Default.WRAPPER)
+                    .make().load(this, ClassLoadingStrategy.Default.CHILD_FIRST.allowExistingTypes())
                     .getLoaded();
             return bundleClass;
         }

diff --git a/flow-tests/pom.xml b/flow-tests/pom.xml
@@ -63,6 +63,36 @@
     </dependencies>
     <build>
         <plugins>
+            <plugin>
+                <groupId>biz.aQute.bnd</groupId>
+                <artifactId>bnd-maven-plugin</artifactId>
+                <version>${bnd.version}</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>bnd-process</goal>
+                        </goals>
+                        <configuration>
+                            <bnd><![CDATA[-fixupmessages: "Classes found in the wrong directory";is:=warning]]>
+                            </bnd>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+                <version>3.1.2</version>
+                <configuration>
+                    <archive>
+                        <manifestFile>${project.build.outputDirectory}/META-INF/MANIFEST.MF</manifestFile>
+                        <index>false</index>
+                        <manifest>
+                            <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
+                        </manifest>
+                    </archive>
+                </configuration>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-failsafe-plugin</artifactId>

diff --git a/flow-tests/test-root-context/pom.xml b/flow-tests/test-root-context/pom.xml
@@ -51,7 +51,7 @@
 
         <dependency>
             <groupId>org.osgi</groupId>
-            <artifactId>org.osgi.core</artifactId>
+            <artifactId>osgi.core</artifactId>
             <version>${osgi.core.version}</version>
             <scope>provided</scope>
         </dependency>

diff --git a/pom.xml b/pom.xml
@@ -122,8 +122,8 @@
         <osgi.bundle.version>
             ${parsedVersion.majorVersion}.${parsedVersion.minorVersion}.${parsedVersion.incrementalVersion}
         </osgi.bundle.version>
-        <bnd.version>3.3.0</bnd.version>
-        <osgi.core.version>6.0.0</osgi.core.version>
+        <bnd.version>5.2.0</bnd.version>
+        <osgi.core.version>7.0.0</osgi.core.version>
         <osgi.compendium.version>7.0.0</osgi.compendium.version>
 
         <maven.test.skip>false</maven.test.skip>