X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-dom-broker%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Fdom%2Fbroker%2FGlobalBundleScanningSchemaServiceImpl.java;h=cf5e5fafcef1f848f2d59703a2ac93c68ec61d92;hp=bf35037b224beae2e1f4f0434d22c7e58a920bc0;hb=b5d0cd043394f9ef5865324c340b2d1cd78cb639;hpb=ab7bfb1d8a4f5c0fb800074c9a8f12caeb35925c diff --git a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/sal/dom/broker/GlobalBundleScanningSchemaServiceImpl.java b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/sal/dom/broker/GlobalBundleScanningSchemaServiceImpl.java index bf35037b22..cf5e5fafce 100644 --- a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/sal/dom/broker/GlobalBundleScanningSchemaServiceImpl.java +++ b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/sal/dom/broker/GlobalBundleScanningSchemaServiceImpl.java @@ -8,19 +8,27 @@ package org.opendaylight.controller.sal.dom.broker; import static com.google.common.base.Preconditions.checkState; - +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Optional; +import com.google.common.base.Preconditions; +import com.google.common.collect.ImmutableList; +import com.google.common.collect.Iterables; import java.net.URL; +import java.util.ArrayList; +import java.util.Collections; import java.util.Enumeration; - +import java.util.List; +import java.util.concurrent.atomic.AtomicReference; +import javax.annotation.concurrent.GuardedBy; import org.opendaylight.controller.sal.core.api.model.SchemaService; -import org.opendaylight.controller.sal.dom.broker.impl.SchemaContextProvider; import org.opendaylight.yangtools.concepts.ListenerRegistration; import org.opendaylight.yangtools.concepts.Registration; -import org.opendaylight.yangtools.concepts.util.ListenerRegistry; +import org.opendaylight.yangtools.util.ListenerRegistry; import org.opendaylight.yangtools.yang.model.api.Module; import org.opendaylight.yangtools.yang.model.api.SchemaContext; -import org.opendaylight.yangtools.yang.model.api.SchemaServiceListener; -import org.opendaylight.yangtools.yang.parser.impl.util.URLSchemaContextResolver; +import org.opendaylight.yangtools.yang.model.api.SchemaContextListener; +import org.opendaylight.yangtools.yang.model.api.SchemaContextProvider; +import org.opendaylight.yangtools.yang.parser.repo.URLSchemaContextResolver; import org.osgi.framework.Bundle; import org.osgi.framework.BundleContext; import org.osgi.framework.BundleEvent; @@ -32,59 +40,75 @@ import org.osgi.util.tracker.ServiceTrackerCustomizer; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import com.google.common.base.Optional; -import com.google.common.collect.ImmutableSet; -import com.google.common.collect.ImmutableSet.Builder; +public class GlobalBundleScanningSchemaServiceImpl implements SchemaContextProvider, SchemaService, ServiceTrackerCustomizer, AutoCloseable { + private static final Logger LOG = LoggerFactory.getLogger(GlobalBundleScanningSchemaServiceImpl.class); -public class GlobalBundleScanningSchemaServiceImpl implements // - SchemaContextProvider, // - SchemaService, // - ServiceTrackerCustomizer, // - AutoCloseable { - private static final Logger logger = LoggerFactory.getLogger(GlobalBundleScanningSchemaServiceImpl.class); + private static AtomicReference globalInstance = new AtomicReference<>(); - private ListenerRegistry listeners; + @GuardedBy(value = "lock") + private final ListenerRegistry listeners = new ListenerRegistry<>(); + private final URLSchemaContextResolver contextResolver = URLSchemaContextResolver.create("global-bundle"); + private final BundleScanner scanner = new BundleScanner(); + private final BundleContext context; - private BundleContext context; - private BundleScanner scanner = new BundleScanner(); - - private BundleTracker>> bundleTracker; - - private final URLSchemaContextResolver contextResolver = new URLSchemaContextResolver(); + private ServiceTracker listenerTracker; + private BundleTracker> bundleTracker; + private boolean starting = true; + private volatile boolean stopping; + private final Object lock = new Object(); - private ServiceTracker listenerTracker; + private GlobalBundleScanningSchemaServiceImpl(final BundleContext context) { + this.context = Preconditions.checkNotNull(context); + } - private boolean starting = true; + public static GlobalBundleScanningSchemaServiceImpl createInstance(final BundleContext ctx) { + GlobalBundleScanningSchemaServiceImpl instance = new GlobalBundleScanningSchemaServiceImpl(ctx); + Preconditions.checkState(globalInstance.compareAndSet(null, instance)); + instance.start(); + return instance; + } - public ListenerRegistry getListeners() { - return listeners; + public static GlobalBundleScanningSchemaServiceImpl getInstance() { + GlobalBundleScanningSchemaServiceImpl instance = globalInstance.get(); + Preconditions.checkState(instance != null, "Global Instance was not instantiated"); + return instance; } - public void setListeners(ListenerRegistry listeners) { - this.listeners = listeners; + @VisibleForTesting + public static void destroyInstance() { + GlobalBundleScanningSchemaServiceImpl instance = globalInstance.getAndSet(null); + if(instance != null) { + instance.close(); + } } public BundleContext getContext() { return context; } - public void setContext(BundleContext context) { - this.context = context; - } - public void start() { checkState(context != null); - if (listeners == null) { - listeners = new ListenerRegistry<>(); + LOG.debug("start() starting"); + + listenerTracker = new ServiceTracker<>(context, SchemaContextListener.class, GlobalBundleScanningSchemaServiceImpl.this); + bundleTracker = new BundleTracker<>(context, Bundle.RESOLVED | Bundle.STARTING | + Bundle.STOPPING | Bundle.ACTIVE, scanner); + + synchronized(lock) { + bundleTracker.open(); + + LOG.debug("BundleTracker.open() complete"); + + boolean hasExistingListeners = Iterables.size(listeners.getListeners()) > 0; + if(hasExistingListeners) { + tryToUpdateSchemaContext(); + } } - listenerTracker = new ServiceTracker<>(context, SchemaServiceListener.class, GlobalBundleScanningSchemaServiceImpl.this); - bundleTracker = new BundleTracker>>(context, BundleEvent.RESOLVED - | BundleEvent.UNRESOLVED, scanner); - bundleTracker.open(); listenerTracker.open(); starting = false; - tryToUpdateSchemaContext(); + + LOG.debug("start() complete"); } @Override @@ -92,12 +116,13 @@ public class GlobalBundleScanningSchemaServiceImpl implements // return getGlobalContext(); } + @Override public SchemaContext getGlobalContext() { return contextResolver.getSchemaContext().orNull(); } @Override - public void addModule(Module module) { + public void addModule(final Module module) { throw new UnsupportedOperationException(); } @@ -107,73 +132,93 @@ public class GlobalBundleScanningSchemaServiceImpl implements // } @Override - public void removeModule(Module module) { + public void removeModule(final Module module) { throw new UnsupportedOperationException(); } @Override - public ListenerRegistration registerSchemaServiceListener(SchemaServiceListener listener) { - return listeners.register(listener); + public ListenerRegistration registerSchemaContextListener(final SchemaContextListener listener) { + synchronized(lock) { + Optional potentialCtx = contextResolver.getSchemaContext(); + if(potentialCtx.isPresent()) { + listener.onGlobalContextUpdated(potentialCtx.get()); + } + return listeners.register(listener); + } } @Override - public void close() throws Exception { + public void close() { + stopping = true; if (bundleTracker != null) { bundleTracker.close(); } if (listenerTracker != null) { listenerTracker.close(); } - // FIXME: Add listeners.close(); - } + for (ListenerRegistration l : listeners.getListeners()) { + l.close(); + } + } - private void updateContext(SchemaContext snapshot) { + @GuardedBy(value = "lock") + private void notifyListeners(final SchemaContext snapshot) { Object[] services = listenerTracker.getServices(); + for (ListenerRegistration listener : listeners) { + try { + listener.getInstance().onGlobalContextUpdated(snapshot); + } catch (Exception e) { + LOG.error("Exception occured during invoking listener", e); + } + } if (services != null) { for (Object rawListener : services) { - SchemaServiceListener listener = (SchemaServiceListener) rawListener; + final SchemaContextListener listener = (SchemaContextListener) rawListener; try { listener.onGlobalContextUpdated(snapshot); } catch (Exception e) { - logger.error("Exception occured during invoking listener", e); + LOG.error("Exception occured during invoking listener {}", listener, e); } } } - for (ListenerRegistration listener : listeners) { - try { - listener.getInstance().onGlobalContextUpdated(snapshot); - } catch (Exception e) { - logger.error("Exception occured during invoking listener", e); - } - } } - private class BundleScanner implements BundleTrackerCustomizer>> { + private class BundleScanner implements BundleTrackerCustomizer> { @Override - public ImmutableSet> addingBundle(Bundle bundle, BundleEvent event) { + public Iterable addingBundle(final Bundle bundle, final BundleEvent event) { if (bundle.getBundleId() == 0) { - return ImmutableSet.of(); + return Collections.emptyList(); } - Enumeration enumeration = bundle.findEntries("META-INF/yang", "*.yang", false); - Builder> builder = ImmutableSet.> builder(); - while (enumeration != null && enumeration.hasMoreElements()) { - Registration reg = contextResolver.registerSource(enumeration.nextElement()); - builder.add(reg); + final Enumeration enumeration = bundle.findEntries("META-INF/yang", "*.yang", false); + if (enumeration == null) { + return Collections.emptyList(); } - ImmutableSet> urls = builder.build(); - if(urls.isEmpty()) { - return urls; + + final List urls = new ArrayList<>(); + while (enumeration.hasMoreElements()) { + final URL u = enumeration.nextElement(); + try { + urls.add(contextResolver.registerSource(u)); + LOG.debug("Registered {}", u); + } catch (Exception e) { + LOG.warn("Failed to register {}, ignoring it", e); + } + } + + if (!urls.isEmpty()) { + LOG.debug("Loaded {} new URLs from bundle {}, attempting to rebuild schema context", + urls.size(), bundle.getSymbolicName()); + tryToUpdateSchemaContext(); } - tryToUpdateSchemaContext(); - return urls; + + return ImmutableList.copyOf(urls); } @Override - public void modifiedBundle(Bundle bundle, BundleEvent event, ImmutableSet> object) { - logger.debug("Modified bundle {} {} {}", bundle, event, object); + public void modifiedBundle(final Bundle bundle, final BundleEvent event, final Iterable object) { } /** @@ -183,22 +228,30 @@ public class GlobalBundleScanningSchemaServiceImpl implements // */ @Override - public synchronized void removedBundle(Bundle bundle, BundleEvent event, ImmutableSet> urls) { - for (Registration url : urls) { + public void removedBundle(final Bundle bundle, final BundleEvent event, final Iterable urls) { + for (Registration url : urls) { try { url.close(); } catch (Exception e) { - e.printStackTrace(); + LOG.warn("Failed do unregister URL {}, proceeding", url, e); + } + } + + int numUrls = Iterables.size(urls); + if(numUrls > 0 ) { + if(LOG.isDebugEnabled()) { + LOG.debug("removedBundle: {}, state: {}, # urls: {}", bundle.getSymbolicName(), bundle.getState(), numUrls); } + + tryToUpdateSchemaContext(); } - tryToUpdateSchemaContext(); } } @Override - public SchemaServiceListener addingService(ServiceReference reference) { + public SchemaContextListener addingService(final ServiceReference reference) { - SchemaServiceListener listener = context.getService(reference); + SchemaContextListener listener = context.getService(reference); SchemaContext _ctxContext = getGlobalContext(); if (getContext() != null && _ctxContext != null) { listener.onGlobalContextUpdated(_ctxContext); @@ -206,23 +259,30 @@ public class GlobalBundleScanningSchemaServiceImpl implements // return listener; } - public synchronized void tryToUpdateSchemaContext() { - if(starting ) { + public void tryToUpdateSchemaContext() { + if (starting || stopping) { return; } - Optional schema = contextResolver.tryToUpdateSchemaContext(); - if(schema.isPresent()) { - updateContext(schema.get()); + + synchronized(lock) { + Optional schema = contextResolver.getSchemaContext(); + if(schema.isPresent()) { + if(LOG.isDebugEnabled()) { + LOG.debug("Got new SchemaContext: # of modules {}", schema.get().getAllModuleIdentifiers().size()); + } + + notifyListeners(schema.get()); + } } } @Override - public void modifiedService(ServiceReference reference, SchemaServiceListener service) { + public void modifiedService(final ServiceReference reference, final SchemaContextListener service) { // NOOP } @Override - public void removedService(ServiceReference reference, SchemaServiceListener service) { + public void removedService(final ServiceReference reference, final SchemaContextListener service) { context.ungetService(reference); } }