Do not release OSGi HttpService

Fix openhab/openhab-core#4140

Signed-off-by: Laurent Garnier <[email protected]>

Author: lolodomo

bundles/org.jupnp/src/main/java/org/jupnp/OSGiUpnpServiceConfiguration.java

@@ -55,7 +55,6 @@
 import org.jupnp.transport.spi.StreamClientConfiguration;
 import org.jupnp.transport.spi.StreamServer;
 import org.osgi.framework.BundleContext;
-import org.osgi.framework.ServiceReference;
 import org.osgi.service.component.annotations.Activate;
 import org.osgi.service.component.annotations.Component;
 import org.osgi.service.component.annotations.ConfigurationPolicy;
@@ -87,6 +86,7 @@
  * @author Kai Kreuzer - introduced bounded thread pool and http service streaming server
  * @author Victor Toni - consolidated transport abstraction into one interface
  * @author Wouter Born - conditionally enable component based on autoEnable configuration value
+ * @author Laurent Garnier - do not release the OSGi HttpService
  */
 @Component(configurationPid = "org.jupnp", configurationPolicy = ConfigurationPolicy.REQUIRE, enabled = false)
 public class OSGiUpnpServiceConfiguration implements UpnpServiceConfiguration {
@@ -122,16 +122,15 @@ public class OSGiUpnpServiceConfiguration implements UpnpServiceConfiguration {
 
     protected BundleContext context;
 
-    @SuppressWarnings("rawtypes")
-    protected ServiceReference httpServiceReference;
-
     @SuppressWarnings("rawtypes")
     protected TransportConfiguration transportConfiguration;
 
     protected Integer timeoutSeconds = 10;
     protected Integer retryIterations = 5;
     protected Integer retryAfterSeconds = (int) TimeUnit.MINUTES.toSeconds(10);
 
+    protected HttpService httpService;
+
     /**
      * Defaults to port '0', ephemeral.
      */
@@ -185,15 +184,14 @@ protected void activate(BundleContext context, Map<String, Object> configProps)
 
     @Deactivate
     protected void deactivate() {
-        if (httpServiceReference != null) {
-            context.ungetService(httpServiceReference);
-        }
-
         shutdown();
-
         logger.debug("{} deactivated", this);
     }
 
+    protected void setHttpService(HttpService httpService) {
+        this.httpService = httpService;
+    }
+
     @Override
     public DatagramProcessor getDatagramProcessor() {
         return datagramProcessor;
@@ -237,25 +235,14 @@ public DatagramIO createDatagramIO(NetworkAddressFactory networkAddressFactory)
     @Override
     @SuppressWarnings({ "rawtypes", "unchecked" })
     public StreamServer createStreamServer(NetworkAddressFactory networkAddressFactory) {
-        ServiceReference serviceReference = context.getServiceReference(HttpService.class.getName());
-
-        if (serviceReference != null) {
-
-            if (httpServiceReference != null) {
-                context.ungetService(httpServiceReference);
-            }
-
-            httpServiceReference = serviceReference;
-
-            HttpService httpService = (HttpService) context.getService(serviceReference);
-
-            if (httpService != null) {
-                return new ServletStreamServerImpl(new ServletStreamServerConfigurationImpl(
-                        HttpServiceServletContainerAdapter.getInstance(httpService, context),
-                        httpProxyPort != -1 ? httpProxyPort : callbackURI.getBasePath().getPort()));
-            }
+        if (httpService != null) {
+            logger.debug("createStreamServer using OSGi HttpService");
+            return new ServletStreamServerImpl(new ServletStreamServerConfigurationImpl(
+                    HttpServiceServletContainerAdapter.getInstance(httpService, context),
+                    httpProxyPort != -1 ? httpProxyPort : callbackURI.getBasePath().getPort()));
         }
 
+        logger.debug("createStreamServer without OSGi HttpService");
         return transportConfiguration.createStreamServer(networkAddressFactory.getStreamListenPort());
     }
 

bundles/org.jupnp/src/main/java/org/jupnp/UpnpServiceImpl.java

@@ -52,9 +52,10 @@
  * <p>
  * Override the various <tt>create...()</tt> methods to customize instantiation of protocol factory, router, etc.
  * </p>
- * 
+ *
  * @author Christian Bauer
  * @author Kai Kreuzer - OSGiified the service
+ * @author Laurent Garnier - OSGi HttpService provided to OSGiUpnpServiceConfiguration
  */
 @Component(configurationPid = "org.jupnp.upnpservice")
 @Designate(ocd = UpnpServiceImpl.Config.class)
@@ -77,6 +78,7 @@ public class UpnpServiceImpl implements UpnpService {
     protected UpnpServiceConfiguration configuration;
     protected ProtocolFactory protocolFactory;
     protected Registry registry;
+    protected HttpService httpService;
 
     protected ControlPoint controlPoint;
     protected Router router;
@@ -124,6 +126,7 @@ private static ScheduledExecutorService createExecutor() {
     public void setUpnpServiceConfiguration(UpnpServiceConfiguration configuration) {
         this.configuration = configuration;
         if (isRunning) {
+            logger.debug("New OSGi UpnpServiceConfiguration is bound while UPnP service is running; restart needed");
             restart(true);
         }
     }
@@ -134,16 +137,20 @@ public void unsetUpnpServiceConfiguration(UpnpServiceConfiguration configuration
 
     @Reference
     public void setHttpService(HttpService httpService) {
+        this.httpService = httpService;
         // Only need to restart jupnp after/if HttpService appears
         if (isRunning) {
+            logger.debug("New OSGi HttpService is bound while UPnP service is running; restart needed");
             shutdown(false);
             delayedStartup(1500);
         }
     }
 
     public void unsetHttpService(HttpService httpService) {
+        this.httpService = null;
         // Only need to restart jupnp after/if HttpService disappears
         if (isRunning) {
+            logger.debug("OSGi HttpService is unbound while UPnP service is running; restart needed");
             shutdown(false);
             delayedStartup(1500);
         }
@@ -269,7 +276,12 @@ public void startup() {
 
                 // Instantiation order is important: Router needs to start its network services after registry is ready
 
-                logger.debug("Using configuration: {}", getConfiguration().getClass().getName());
+                logger.debug("{} OSGi HttpService; using configuration: {}",
+                        httpService != null ? "Using" : "Not using", getConfiguration().getClass().getName());
+
+                if (getConfiguration() instanceof OSGiUpnpServiceConfiguration) {
+                    ((OSGiUpnpServiceConfiguration) getConfiguration()).setHttpService(httpService);
+                }
 
                 this.protocolFactory = createProtocolFactory();
                 this.registry = createRegistry(protocolFactory);