Migrate netconf to MD-SAL APIs
[netconf.git] / netconf / yanglib / src / main / java / org / opendaylight / yanglib / impl / YangLibProvider.java
index d2876fe9e98ba085b6bb93ed3dc64c8355b2c1a5..48bd4403d5fc4a32eeffdff8307fcf8b4d12c0b9 100644 (file)
@@ -5,88 +5,93 @@
  * 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.yanglib.impl;
 
+import com.google.common.base.Preconditions;
 import com.google.common.base.Predicate;
+import com.google.common.base.Strings;
 import com.google.common.collect.Iterables;
 import com.google.common.util.concurrent.FutureCallback;
-import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.MoreExecutors;
+import java.io.File;
 import java.util.ArrayList;
 import java.util.List;
 import javax.annotation.Nullable;
-import org.opendaylight.controller.md.sal.binding.api.DataBroker;
-import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
-import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
-import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
-import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.ModulesState;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.ModulesStateBuilder;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.OptionalRevision;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.RevisionIdentifier;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.module.list.Module;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.module.list.ModuleBuilder;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.module.list.ModuleKey;
+import org.opendaylight.mdsal.binding.api.DataBroker;
+import org.opendaylight.mdsal.binding.api.WriteTransaction;
+import org.opendaylight.mdsal.common.api.CommitInfo;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.ModulesState;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.ModulesStateBuilder;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.RevisionUtils;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.module.list.Module;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.module.list.ModuleBuilder;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.module.list.ModuleKey;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.YangIdentifier;
-import org.opendaylight.yanglib.api.YangLibRestAppService;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.yanglib.impl.rev141210.YanglibConfig;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.common.Revision;
 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation;
 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaListenerRegistration;
 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceListener;
+import org.opendaylight.yangtools.yang.model.repo.util.FilesystemSchemaSourceCache;
 import org.opendaylight.yangtools.yang.parser.repo.SharedSchemaRepository;
-import org.osgi.framework.BundleContext;
-import org.osgi.framework.FrameworkUtil;
-import org.osgi.framework.ServiceReference;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-
 /**
  * Listens on new schema sources registered event. For each new source
  * registered generates URL representing its schema source and write this URL
  * along with source identifier to
  * ietf-netconf-yang-library/modules-state/module list.
  */
-public class YangLibProvider implements BindingAwareProvider, AutoCloseable, SchemaSourceListener{
+public class YangLibProvider implements AutoCloseable, SchemaSourceListener {
     private static final Logger LOG = LoggerFactory.getLogger(YangLibProvider.class);
 
-    private static final Predicate<PotentialSchemaSource<?>> YANG_SCHEMA_SOURCE = new Predicate<PotentialSchemaSource<?>>() {
-        @Override
-        public boolean apply(final PotentialSchemaSource<?> input) {
-            // filter out non yang sources
-            return YangTextSchemaSource.class.isAssignableFrom(input.getRepresentation());
-        }
-    };
-
-    protected DataBroker dataBroker;
-    protected SchemaListenerRegistration schemaListenerRegistration;
-    protected final SharedSchemaRepository schemaRepository;
-    private final String bindingAddress;
-    private final long bindingPort;
-
-    public YangLibProvider(final SharedSchemaRepository schemaRepository,
-                           final String bindingAddress, final long bindingPort) {
-        this.schemaRepository = schemaRepository;
-        this.bindingAddress = bindingAddress;
-        this.bindingPort = bindingPort;
+    private static final Predicate<PotentialSchemaSource<?>> YANG_SCHEMA_SOURCE =
+        input -> YangTextSchemaSource.class.isAssignableFrom(input.getRepresentation());
+
+    private final DataBroker dataBroker;
+    private final YanglibConfig yanglibConfig;
+    private final SharedSchemaRepository schemaRepository;
+    private SchemaListenerRegistration schemaListenerRegistration;
+
+    public YangLibProvider(final YanglibConfig yanglibConfig, final DataBroker dataBroker,
+            final SharedSchemaRepository schemaRepository) {
+        this.yanglibConfig = Preconditions.checkNotNull(yanglibConfig);
+        this.dataBroker = Preconditions.checkNotNull(dataBroker);
+        this.schemaRepository = Preconditions.checkNotNull(schemaRepository);
     }
 
     @Override
-    public void close() throws Exception {
-        dataBroker = null;
-        schemaListenerRegistration.close();
+    public void close() {
+        if (schemaListenerRegistration != null) {
+            schemaListenerRegistration.close();
+        }
     }
 
-    @Override
-    public void onSessionInitiated(final BindingAwareBroker.ProviderContext providerContext) {
-        this.dataBroker = providerContext.getSALService(DataBroker.class);
+    public void init() {
+        if (Strings.isNullOrEmpty(yanglibConfig.getCacheFolder())) {
+            LOG.info("No cache-folder set in yanglib-config - yang library services will not be available");
+            return;
+        }
+
+        final File cacheFolderFile = new File(yanglibConfig.getCacheFolder());
+        Preconditions.checkArgument(cacheFolderFile.exists(), "cache-folder %s does not exist", cacheFolderFile);
+        Preconditions.checkArgument(cacheFolderFile.isDirectory(), "cache-folder %s is not a directory",
+                cacheFolderFile);
+
+        final FilesystemSchemaSourceCache<YangTextSchemaSource> cache =
+                new FilesystemSchemaSourceCache<>(schemaRepository, YangTextSchemaSource.class, cacheFolderFile);
+        schemaRepository.registerSchemaSourceListener(cache);
+
         schemaListenerRegistration = schemaRepository.registerSchemaSourceListener(this);
-        getObjectFromBundleContext(YangLibRestAppService.class, YangLibRestAppService.class.getName())
-        .getYangLibService().setSchemaRepository(schemaRepository);
+
+        LOG.info("Started yang library with sources from {}", cacheFolderFile);
     }
 
     @Override
@@ -98,21 +103,19 @@ public class YangLibProvider implements BindingAwareProvider, AutoCloseable, Sch
     public void schemaSourceRegistered(final Iterable<PotentialSchemaSource<?>> sources) {
         final List<Module> newModules = new ArrayList<>();
 
-        for(PotentialSchemaSource<?> potentialYangSource : Iterables.filter(sources, YANG_SCHEMA_SOURCE)) {
+        for (PotentialSchemaSource<?> potentialYangSource : Iterables.filter(sources, YANG_SCHEMA_SOURCE)) {
             final YangIdentifier moduleName = new YangIdentifier(potentialYangSource.getSourceIdentifier().getName());
 
-            final OptionalRevision moduleRevision = getRevisionForModule(potentialYangSource.getSourceIdentifier());
-
             final Module newModule = new ModuleBuilder()
                     .setName(moduleName)
-                    .setRevision(moduleRevision)
+                    .setRevision(RevisionUtils.fromYangCommon(potentialYangSource.getSourceIdentifier().getRevision()))
                     .setSchema(getUrlForModule(potentialYangSource.getSourceIdentifier()))
                     .build();
 
             newModules.add(newModule);
         }
 
-        if(newModules.isEmpty()) {
+        if (newModules.isEmpty()) {
             // If no new yang modules then do nothing
             return;
         }
@@ -121,22 +124,22 @@ public class YangLibProvider implements BindingAwareProvider, AutoCloseable, Sch
         tx.merge(LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.create(ModulesState.class),
                 new ModulesStateBuilder().setModule(newModules).build());
 
-        Futures.addCallback(tx.submit(), new FutureCallback<Void>() {
+        tx.commit().addCallback(new FutureCallback<CommitInfo>() {
             @Override
-            public void onSuccess(@Nullable Void result) {
+            public void onSuccess(@Nullable final CommitInfo result) {
                 LOG.debug("Modules state successfully populated with new modules");
             }
 
             @Override
-            public void onFailure(Throwable t) {
-                LOG.warn("Unable to update modules state", t);
+            public void onFailure(final Throwable throwable) {
+                LOG.warn("Unable to update modules state", throwable);
             }
-        });
+        }, MoreExecutors.directExecutor());
     }
 
     @Override
     public void schemaSourceUnregistered(final PotentialSchemaSource<?> source) {
-        if(!YANG_SCHEMA_SOURCE.apply(source)) {
+        if (!YANG_SCHEMA_SOURCE.apply(source)) {
             // if representation of potential schema source is not yang text schema source do nothing
             // we do not want to delete this module entry from module list
             return;
@@ -148,37 +151,29 @@ public class YangLibProvider implements BindingAwareProvider, AutoCloseable, Sch
                         .child(Module.class,
                                 new ModuleKey(
                                         new YangIdentifier(source.getSourceIdentifier().getName()),
-                                        getRevisionForModule(source.getSourceIdentifier()))));
+                                        RevisionUtils.fromYangCommon(source.getSourceIdentifier().getRevision()))));
 
-        Futures.addCallback(tx.submit(), new FutureCallback<Void>() {
+        tx.commit().addCallback(new FutureCallback<CommitInfo>() {
             @Override
-            public void onSuccess(@Nullable Void result) {
+            public void onSuccess(@Nullable final CommitInfo result) {
                 LOG.debug("Modules state successfully updated.");
             }
 
             @Override
-            public void onFailure(Throwable t) {
-                LOG.warn("Unable to update modules state", t);
+            public void onFailure(final Throwable throwable) {
+                LOG.warn("Unable to update modules state", throwable);
             }
-        });
+        }, MoreExecutors.directExecutor());
     }
 
-    private Uri getUrlForModule(final SourceIdentifier sourceIdentifier) {
-        final String revision = sourceIdentifier.getRevision().equals(SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION)
-                ? "" : sourceIdentifier.getRevision();
-        return new Uri("http://" + bindingAddress + ":" + bindingPort
-                + "/yanglib/schemas/" + sourceIdentifier.getName() + "/" + revision);
-    }
 
-    private OptionalRevision getRevisionForModule(final SourceIdentifier sourceIdentifier) {
-        return sourceIdentifier.getRevision().equals(SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION)
-                ? new OptionalRevision("")
-                : new OptionalRevision(new RevisionIdentifier(sourceIdentifier.getRevision()));
+
+    private Uri getUrlForModule(final SourceIdentifier sourceIdentifier) {
+        return new Uri("http://" + yanglibConfig.getBindingAddr() + ':' + yanglibConfig.getBindingPort()
+                + "/yanglib/schemas/" + sourceIdentifier.getName() + '/' + revString(sourceIdentifier));
     }
 
-    private <T> T getObjectFromBundleContext(final Class<T> type, final String serviceRefName) {
-        final BundleContext bundleContext = FrameworkUtil.getBundle(getClass()).getBundleContext();
-        final ServiceReference<?> serviceReference = bundleContext.getServiceReference(serviceRefName);
-        return (T) bundleContext.getService(serviceReference);
+    private static String revString(final SourceIdentifier id) {
+        return id.getRevision().map(Revision::toString).orElse("");
     }
 }