Split out PCEPTopologyProviderSingleton

We are using a rather weird indirection to hide the singleton service.
Split it out into its own class to make this much easier to see, so that
we can perform a proper cleanup.

JIRA: BGPCEP-893
Change-Id: If12ba8f0ae8cf26c29f06fbc809e9da626cf4337
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/pcep/topology/topology-provider/src/main/java/org/opendaylight/bgpcep/pcep/topology/provider/config/PCEPTopologyProviderBean.java b/pcep/topology/topology-provider/src/main/java/org/opendaylight/bgpcep/pcep/topology/provider/config/PCEPTopologyProviderBean.java
index 5c1e85f4c08fd137520fb5581d3d3029c4386f48..83cbfe361eec9cdf6c8bcf447072e7382a0174ad 100644 (file)
--- a/pcep/topology/topology-provider/src/main/java/org/opendaylight/bgpcep/pcep/topology/provider/config/PCEPTopologyProviderBean.java
+++ b/pcep/topology/topology-provider/src/main/java/org/opendaylight/bgpcep/pcep/topology/provider/config/PCEPTopologyProviderBean.java
@@ -11,28 +11,19 @@ import static com.google.common.base.Preconditions.checkState;
 import static java.util.Objects.requireNonNull;
 
 import com.google.common.util.concurrent.FluentFuture;
-import java.util.Dictionary;
-import java.util.Hashtable;
 import java.util.List;
 import org.checkerframework.checker.lock.qual.GuardedBy;
-import org.gaul.modernizer_maven_annotations.SuppressModernizer;
 import org.opendaylight.bgpcep.pcep.server.PceServerProvider;
-import org.opendaylight.bgpcep.pcep.topology.provider.PCEPTopologyProvider;
 import org.opendaylight.bgpcep.pcep.topology.provider.TopologySessionListenerFactory;
 import org.opendaylight.bgpcep.pcep.topology.spi.stats.TopologySessionStatsRegistry;
 import org.opendaylight.bgpcep.programming.spi.InstructionScheduler;
-import org.opendaylight.bgpcep.topology.DefaultTopologyReference;
 import org.opendaylight.mdsal.binding.api.DataBroker;
 import org.opendaylight.mdsal.binding.api.RpcProviderService;
 import org.opendaylight.mdsal.common.api.CommitInfo;
-import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService;
 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
-import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
-import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
 import org.opendaylight.protocol.pcep.PCEPCapability;
 import org.opendaylight.protocol.pcep.PCEPDispatcher;
 import org.osgi.framework.BundleContext;
-import org.osgi.framework.ServiceRegistration;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -46,7 +37,7 @@ final class PCEPTopologyProviderBean implements PCEPTopologyProviderDependencies
     private final TopologySessionStatsRegistry stateRegistry;
     private final PceServerProvider pceServerProvider;
     @GuardedBy("this")
-    private PCEPTopologyProviderBeanCSS pcepTopoProviderCSS;
+    private PCEPTopologyProviderSingleton pcepTopoProviderCSS;
 
     PCEPTopologyProviderBean(
             final DataBroker dataBroker,
@@ -92,8 +83,8 @@ final class PCEPTopologyProviderBean implements PCEPTopologyProviderDependencies
             final BundleContext bundleContext) {
         checkState(pcepTopoProviderCSS == null, "Previous instance %s was not closed.", this);
         try {
-            pcepTopoProviderCSS = new PCEPTopologyProviderBeanCSS(configDependencies, this, instructionScheduler, cssp,
-                bundleContext);
+            pcepTopoProviderCSS = new PCEPTopologyProviderSingleton(configDependencies, this, instructionScheduler,
+                cssp, bundleContext);
         } catch (final Exception e) {
             LOG.debug("Failed to create PCEPTopologyProvider {}", configDependencies.getTopologyId().getValue(), e);
         }
@@ -128,76 +119,4 @@ final class PCEPTopologyProviderBean implements PCEPTopologyProviderDependencies
     public PceServerProvider getPceServerProvider() {
         return pceServerProvider;
     }
-
-    private static class PCEPTopologyProviderBeanCSS implements ClusterSingletonService, AutoCloseable {
-        private final ServiceGroupIdentifier sgi;
-        private final PCEPTopologyProvider pcepTopoProvider;
-        private final InstructionScheduler scheduler;
-        private ServiceRegistration<?> serviceRegistration;
-        private ClusterSingletonServiceRegistration cssRegistration;
-        @GuardedBy("this")
-        private boolean serviceInstantiated;
-
-        PCEPTopologyProviderBeanCSS(final PCEPTopologyConfiguration configDependencies,
-                final PCEPTopologyProviderDependencies dependenciesProvider,
-                final InstructionScheduler instructionScheduler, final ClusterSingletonServiceProvider cssp,
-                // FIXME: this should not be needed
-                final BundleContext bundleContext) {
-            scheduler = instructionScheduler;
-            sgi = scheduler.getIdentifier();
-            pcepTopoProvider = PCEPTopologyProvider.create(dependenciesProvider, scheduler, configDependencies);
-
-            serviceRegistration = bundleContext.registerService(DefaultTopologyReference.class.getName(),
-                pcepTopoProvider, props(configDependencies));
-            LOG.info("PCEP Topology Provider service {} registered", getIdentifier().getName());
-            cssRegistration = cssp.registerClusterSingletonService(this);
-        }
-
-        @SuppressModernizer
-        private static Dictionary<String, String> props(final PCEPTopologyConfiguration configDependencies) {
-            final Dictionary<String, String> properties = new Hashtable<>();
-            properties.put(PCEPTopologyProvider.class.getName(), configDependencies.getTopologyId().getValue());
-            return properties;
-        }
-
-        @Override
-        @SuppressWarnings("checkstyle:IllegalCatch")
-        public synchronized void instantiateServiceInstance() {
-            LOG.info("PCEP Topology Provider Singleton Service {} instantiated", getIdentifier().getName());
-            try {
-                pcepTopoProvider.instantiateServiceInstance();
-            } catch (final Exception e) {
-                LOG.error("Failed to instantiate PCEP Topology provider", e);
-            }
-            serviceInstantiated = true;
-        }
-
-        @Override
-        public synchronized FluentFuture<? extends CommitInfo> closeServiceInstance() {
-            LOG.info("Close PCEP Topology Provider Singleton Service {}", getIdentifier().getName());
-            if (serviceInstantiated) {
-                serviceInstantiated = false;
-                return pcepTopoProvider.closeServiceInstance();
-            }
-            return CommitInfo.emptyFluentFuture();
-        }
-
-        @Override
-        public ServiceGroupIdentifier getIdentifier() {
-            return sgi;
-        }
-
-        @Override
-        public synchronized void close() throws Exception {
-            if (cssRegistration != null) {
-                cssRegistration.close();
-                cssRegistration = null;
-            }
-            if (serviceRegistration != null) {
-                serviceRegistration.unregister();
-                serviceRegistration = null;
-            }
-            scheduler.close();
-        }
-    }
 }

diff --git a/pcep/topology/topology-provider/src/main/java/org/opendaylight/bgpcep/pcep/topology/provider/config/PCEPTopologyProviderSingleton.java b/pcep/topology/topology-provider/src/main/java/org/opendaylight/bgpcep/pcep/topology/provider/config/PCEPTopologyProviderSingleton.java
new file mode 100644 (file)
index 0000000..31846f5
--- /dev/null
+++ b/pcep/topology/topology-provider/src/main/java/org/opendaylight/bgpcep/pcep/topology/provider/config/PCEPTopologyProviderSingleton.java
@@ -0,0 +1,102 @@
+/*
+ * Copyright (c) 2017 Pantheon Technologies s.r.o. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.bgpcep.pcep.topology.provider.config;
+
+import com.google.common.util.concurrent.FluentFuture;
+import java.util.Dictionary;
+import java.util.Hashtable;
+import org.checkerframework.checker.lock.qual.GuardedBy;
+import org.gaul.modernizer_maven_annotations.SuppressModernizer;
+import org.opendaylight.bgpcep.pcep.topology.provider.PCEPTopologyProvider;
+import org.opendaylight.bgpcep.programming.spi.InstructionScheduler;
+import org.opendaylight.bgpcep.topology.DefaultTopologyReference;
+import org.opendaylight.mdsal.common.api.CommitInfo;
+import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService;
+import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
+import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
+import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
+import org.osgi.framework.BundleContext;
+import org.osgi.framework.ServiceRegistration;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+final class PCEPTopologyProviderSingleton implements ClusterSingletonService, AutoCloseable {
+    private static final Logger LOG = LoggerFactory.getLogger(PCEPTopologyProviderSingleton.class);
+
+    private final ServiceGroupIdentifier sgi;
+    private final PCEPTopologyProvider pcepTopoProvider;
+    private final InstructionScheduler scheduler;
+
+    private ServiceRegistration<?> serviceRegistration;
+    private ClusterSingletonServiceRegistration cssRegistration;
+
+    @GuardedBy("this")
+    private boolean serviceInstantiated;
+
+    PCEPTopologyProviderSingleton(final PCEPTopologyConfiguration configDependencies,
+            final PCEPTopologyProviderDependencies dependenciesProvider,
+            final InstructionScheduler instructionScheduler, final ClusterSingletonServiceProvider cssp,
+            // FIXME: this should not be needed
+            final BundleContext bundleContext) {
+        scheduler = instructionScheduler;
+        sgi = scheduler.getIdentifier();
+        pcepTopoProvider = PCEPTopologyProvider.create(dependenciesProvider, scheduler, configDependencies);
+
+        serviceRegistration = bundleContext.registerService(DefaultTopologyReference.class.getName(),
+            pcepTopoProvider, props(configDependencies));
+        LOG.info("PCEP Topology Provider service {} registered", getIdentifier().getName());
+        cssRegistration = cssp.registerClusterSingletonService(this);
+    }
+
+    @SuppressModernizer
+    private static Dictionary<String, String> props(final PCEPTopologyConfiguration configDependencies) {
+        final Dictionary<String, String> properties = new Hashtable<>();
+        properties.put(PCEPTopologyProvider.class.getName(), configDependencies.getTopologyId().getValue());
+        return properties;
+    }
+
+    @Override
+    @SuppressWarnings("checkstyle:IllegalCatch")
+    public synchronized void instantiateServiceInstance() {
+        LOG.info("PCEP Topology Provider Singleton Service {} instantiated", getIdentifier().getName());
+        try {
+            pcepTopoProvider.instantiateServiceInstance();
+        } catch (final Exception e) {
+            LOG.error("Failed to instantiate PCEP Topology provider", e);
+        }
+        serviceInstantiated = true;
+    }
+
+    @Override
+    public synchronized FluentFuture<? extends CommitInfo> closeServiceInstance() {
+        LOG.info("Close PCEP Topology Provider Singleton Service {}", getIdentifier().getName());
+        if (serviceInstantiated) {
+            serviceInstantiated = false;
+            return pcepTopoProvider.closeServiceInstance();
+        }
+        return CommitInfo.emptyFluentFuture();
+    }
+
+    @Override
+    public ServiceGroupIdentifier getIdentifier() {
+        return sgi;
+    }
+
+    @Override
+    public synchronized void close() throws Exception {
+        if (cssRegistration != null) {
+            cssRegistration.close();
+            cssRegistration = null;
+        }
+        if (serviceRegistration != null) {
+            serviceRegistration.unregister();
+            serviceRegistration = null;
+        }
+        scheduler.close();
+    }
+}
\ No newline at end of file