Remove global BindingToNormalizedNodeCodec instance

[controller.git] / opendaylight / md-sal / sal-binding-config / src / main / java / org / opendaylight / controller / config / yang / md / sal / binding / impl / RuntimeMappingModule.java

diff --git a/opendaylight/md-sal/sal-binding-config/src/main/java/org/opendaylight/controller/config/yang/md/sal/binding/impl/RuntimeMappingModule.java b/opendaylight/md-sal/sal-binding-config/src/main/java/org/opendaylight/controller/config/yang/md/sal/binding/impl/RuntimeMappingModule.java
index cc44cd84fb48c5c4f77deb85c3bf525a69882e07..89cdb06d19e998cf59c2b8431fba5d1b1bed35c8 100644 (file)
--- a/opendaylight/md-sal/sal-binding-config/src/main/java/org/opendaylight/controller/config/yang/md/sal/binding/impl/RuntimeMappingModule.java
+++ b/opendaylight/md-sal/sal-binding-config/src/main/java/org/opendaylight/controller/config/yang/md/sal/binding/impl/RuntimeMappingModule.java
@@ -8,11 +8,8 @@
 package org.opendaylight.controller.config.yang.md.sal.binding.impl;
 
 import com.google.common.base.Preconditions;
-import com.google.common.base.Stopwatch;
-import com.google.common.util.concurrent.Uninterruptibles;
-import java.util.concurrent.TimeUnit;
+import org.opendaylight.controller.config.api.osgi.WaitingServiceTracker;
 import org.opendaylight.controller.md.sal.binding.impl.BindingToNormalizedNodeCodec;
-import org.opendaylight.controller.md.sal.binding.impl.BindingToNormalizedNodeCodecFactory;
 import org.osgi.framework.BundleContext;
 
 /**
@@ -20,8 +17,6 @@ import org.osgi.framework.BundleContext;
  */
 @Deprecated
 public final class RuntimeMappingModule extends AbstractRuntimeMappingModule {
-    private static final long WAIT_IN_MINUTES = 5;
-
     private BundleContext bundleContext;
 
     public RuntimeMappingModule(final org.opendaylight.controller.config.api.ModuleIdentifier identifier,
@@ -48,32 +43,18 @@ public final class RuntimeMappingModule extends AbstractRuntimeMappingModule {
     }
 
     @Override
-    public java.lang.AutoCloseable createInstance() {
-        // This is kind of ugly - you might cringe (you've been warned). The BindingToNormalizedNodeCodec
-        // instance is advertised via blueprint so ideally we'd obtain it from the OSGi service registry.
-        // The config yang service identity declares the concrete BindingToNormalizedNodeCodec class
-        // and not an interface as the java-class so we must return a BindingToNormalizedNodeCodec instance.
-        // However we can't cast the instance obtained from the service registry to
-        // BindingToNormalizedNodeCodec b/c Aries may register a proxy if there are interceptors defined.
-        // By default karaf ships with the org.apache.aries.quiesce.api bundle which automatically adds
-        // an interceptor that adds stat tracking for service method calls. While this can be disabled, we
-        // shouldn't rely on it.
-        //
-        // Therefore we store a static instance in the BindingToNormalizedNodeCodecFactory which is created
-        // by blueprint via newInstance. We obtain the static instance here and busy wait if not yet available.
-
-        Stopwatch sw = Stopwatch.createStarted();
-        while(sw.elapsed(TimeUnit.MINUTES) <= WAIT_IN_MINUTES) {
-            BindingToNormalizedNodeCodec instance = BindingToNormalizedNodeCodecFactory.getInstance();
-            if(instance != null) {
-                return instance;
-            }
-
-            Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
-        }
-
-        throw new IllegalStateException("Could not obtain the BindingToNormalizedNodeCodec instance after " +
-                WAIT_IN_MINUTES + " minutes.");
+    public AutoCloseable createInstance() {
+        // We need to return the concrete BindingToNormalizedNodeCodec instance for backwards compatibility
+        // for CSS users that inject the binding-dom-mapping-service.
+        final WaitingServiceTracker<BindingToNormalizedNodeCodec> tracker =
+                WaitingServiceTracker.create(BindingToNormalizedNodeCodec.class, bundleContext);
+        final BindingToNormalizedNodeCodec service = tracker.waitForService(WaitingServiceTracker.FIVE_MINUTES);
+
+        // Ideally we would close the ServiceTracker via the returned AutoCloseable but then we'd have to
+        // proxy the BindingToNormalizedNodeCodec instance which is problematic. It's OK to close the
+        // ServiceTracker here.
+        tracker.close();
+        return service;
     }
 
     public void setBundleContext(final BundleContext bundleContext) {