Integrate netconf-mapping-api into netconf-server
[netconf.git] / netconf / mdsal-netconf-connector / src / main / java / org / opendaylight / netconf / mdsal / connector / MdsalNetconfOperationServiceFactory.java
index 566cf0bcf70063cfaef21474045d2683543bb00b..7e57acafe68c519cece920eefc176db7b02cc2e2 100644 (file)
@@ -5,39 +5,49 @@
  * 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.netconf.mdsal.connector;
 
-import com.google.common.base.Optional;
-import com.google.common.base.Preconditions;
+import static java.util.Objects.requireNonNull;
+
 import com.google.common.io.CharStreams;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.nio.charset.StandardCharsets;
 import java.util.HashSet;
+import java.util.Optional;
 import java.util.Set;
-import org.opendaylight.controller.config.util.capability.Capability;
-import org.opendaylight.controller.config.util.capability.YangModuleCapability;
-import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
-import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
-import org.opendaylight.controller.sal.core.api.model.SchemaService;
+import java.util.concurrent.ExecutionException;
+import org.opendaylight.mdsal.dom.api.DOMDataBroker;
+import org.opendaylight.mdsal.dom.api.DOMRpcService;
+import org.opendaylight.mdsal.dom.api.DOMSchemaService;
+import org.opendaylight.mdsal.dom.api.DOMYangTextSourceProvider;
+import org.opendaylight.netconf.api.capability.BasicCapability;
+import org.opendaylight.netconf.api.capability.Capability;
+import org.opendaylight.netconf.api.capability.YangModuleCapability;
 import org.opendaylight.netconf.api.monitoring.CapabilityListener;
-import org.opendaylight.netconf.mapping.api.NetconfOperationServiceFactory;
-import org.opendaylight.netconf.mapping.api.NetconfOperationServiceFactoryListener;
-import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
-import org.opendaylight.yangtools.yang.model.api.Module;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
-import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceException;
+import org.opendaylight.netconf.server.api.operations.NetconfOperationService;
+import org.opendaylight.netconf.server.api.operations.NetconfOperationServiceFactory;
+import org.opendaylight.netconf.server.api.operations.NetconfOperationServiceFactoryListener;
+import org.opendaylight.yangtools.concepts.Registration;
+import org.opendaylight.yangtools.yang.common.Revision;
+import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
+import org.opendaylight.yangtools.yang.model.api.ModuleLike;
 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.SchemaSourceProvider;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+import org.osgi.service.component.annotations.Reference;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class MdsalNetconfOperationServiceFactory implements NetconfOperationServiceFactory, AutoCloseable {
-
+@Component(service = NetconfOperationServiceFactory.class, immediate = true, property = "type=mdsal-netconf-connector")
+public final class MdsalNetconfOperationServiceFactory implements NetconfOperationServiceFactory, AutoCloseable {
     private static final Logger LOG = LoggerFactory.getLogger(MdsalNetconfOperationServiceFactory.class);
+    private static final BasicCapability VALIDATE_CAPABILITY =
+            new BasicCapability("urn:ietf:params:netconf:capability:validate:1.0");
 
     private final DOMDataBroker dataBroker;
     private final DOMRpcService rpcService;
@@ -46,74 +56,72 @@ public class MdsalNetconfOperationServiceFactory implements NetconfOperationServ
     private final SchemaSourceProvider<YangTextSchemaSource> rootSchemaSourceProviderDependency;
     private final NetconfOperationServiceFactoryListener netconfOperationServiceFactoryListener;
 
-    public MdsalNetconfOperationServiceFactory(final SchemaService schemaService,
-                                               final SchemaSourceProvider<YangTextSchemaSource> rootSchemaSourceProviderDependency,
-                                               final NetconfOperationServiceFactoryListener netconfOperationServiceFactoryListener,
-                                               final DOMDataBroker dataBroker,
-                                               final DOMRpcService rpcService) {
-
-        this.dataBroker = dataBroker;
-        this.rpcService = rpcService;
-
-        this.rootSchemaSourceProviderDependency = rootSchemaSourceProviderDependency;
-        this.currentSchemaContext = new CurrentSchemaContext(Preconditions.checkNotNull(schemaService), rootSchemaSourceProviderDependency);
-        this.netconfOperationServiceFactoryListener = netconfOperationServiceFactoryListener;
-        this.netconfOperationServiceFactoryListener.onAddNetconfOperationServiceFactory(this);
+    @Activate
+    public MdsalNetconfOperationServiceFactory(@Reference final DOMSchemaService schemaService,
+            @Reference final DOMDataBroker dataBroker, @Reference final DOMRpcService rpcService,
+            @Reference(target = "(type=mapper-aggregator-registry)")
+            final NetconfOperationServiceFactoryListener netconfOperationServiceFactoryListener) {
+        this.dataBroker = requireNonNull(dataBroker);
+        this.rpcService = requireNonNull(rpcService);
+        this.netconfOperationServiceFactoryListener = requireNonNull(netconfOperationServiceFactoryListener);
+
+        rootSchemaSourceProviderDependency = schemaService.getExtensions()
+                .getInstance(DOMYangTextSourceProvider.class);
+        currentSchemaContext = CurrentSchemaContext.create(requireNonNull(schemaService),
+                rootSchemaSourceProviderDependency);
+        netconfOperationServiceFactoryListener.onAddNetconfOperationServiceFactory(this);
     }
 
+    @Deactivate
     @Override
-    public MdsalNetconfOperationService createService(final String netconfSessionIdForReporting) {
-        Preconditions.checkState(dataBroker != null, "MD-SAL provider not yet initialized");
-        return new MdsalNetconfOperationService(currentSchemaContext, netconfSessionIdForReporting, dataBroker, rpcService);
+    public void close() {
+        netconfOperationServiceFactoryListener.onRemoveNetconfOperationServiceFactory(this);
+        currentSchemaContext.close();
     }
 
     @Override
-    public void close() throws Exception {
-        currentSchemaContext.close();
-        netconfOperationServiceFactoryListener.onRemoveNetconfOperationServiceFactory(this);
+    public NetconfOperationService createService(final String netconfSessionIdForReporting) {
+        return new MdsalNetconfOperationService(currentSchemaContext, netconfSessionIdForReporting, dataBroker,
+                rpcService);
     }
 
     @Override
     public Set<Capability> getCapabilities() {
+        // FIXME: cache returned set
         return transformCapabilities(currentSchemaContext.getCurrentContext(), rootSchemaSourceProviderDependency);
     }
 
-    static Set<Capability> transformCapabilities(final SchemaContext currentContext, final SchemaSourceProvider<YangTextSchemaSource> rootSchemaSourceProviderDependency) {
-        final Set<Capability> capabilities = new HashSet<>();
+    // FIXME: ImmutableSet
+    static Set<Capability> transformCapabilities(
+            final EffectiveModelContext currentContext,
+            final SchemaSourceProvider<YangTextSchemaSource> rootSchemaSourceProviderDependency) {
+        final var capabilities = new HashSet<Capability>();
 
         // Added by netconf-impl by default
-//        capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0"));
+        // capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0"));
 
-        final Set<Module> modules = currentContext.getModules();
-        for (final Module module : modules) {
-            Optional<YangModuleCapability> cap = moduleToCapability(module, rootSchemaSourceProviderDependency);
-            if(cap.isPresent()) {
-                capabilities.add(cap.get());
-            }
-            for (final Module submodule : module.getSubmodules()) {
-                cap = moduleToCapability(submodule, rootSchemaSourceProviderDependency);
-                if(cap.isPresent()) {
-                    capabilities.add(cap.get());
-                }
+        // FIXME: rework in terms of ModuleEffectiveStatement
+        for (var module : currentContext.getModules()) {
+            moduleToCapability(module, rootSchemaSourceProviderDependency).ifPresent(capabilities::add);
+            for (var submodule : module.getSubmodules()) {
+                moduleToCapability(submodule, rootSchemaSourceProviderDependency).ifPresent(capabilities::add);
             }
         }
 
         return capabilities;
     }
 
-    private static Optional<YangModuleCapability> moduleToCapability(
-            final Module module, final SchemaSourceProvider<YangTextSchemaSource> rootSchemaSourceProviderDependency) {
-
-        final SourceIdentifier moduleSourceIdentifier = SourceIdentifier.create(module.getName(),
-                (SimpleDateFormatUtil.DEFAULT_DATE_REV == module.getRevision() ? Optional.absent() :
-                        Optional.of(SimpleDateFormatUtil.getRevisionFormat().format(module.getRevision()))));
+    private static Optional<YangModuleCapability> moduleToCapability(final ModuleLike module,
+            final SchemaSourceProvider<YangTextSchemaSource> rootSchemaSourceProviderDependency) {
+        final SourceIdentifier moduleSourceIdentifier = new SourceIdentifier(module.getName(),
+                module.getRevision().map(Revision::toString).orElse(null));
 
         InputStream sourceStream = null;
         String source;
         try {
-            sourceStream = rootSchemaSourceProviderDependency.getSource(moduleSourceIdentifier).checkedGet().openStream();
+            sourceStream = rootSchemaSourceProviderDependency.getSource(moduleSourceIdentifier).get().openStream();
             source = CharStreams.toString(new InputStreamReader(sourceStream, StandardCharsets.UTF_8));
-        } catch (IOException | SchemaSourceException e) {
+        } catch (ExecutionException | InterruptedException | IOException e) {
             LOG.warn("Ignoring source for module {}. Unable to read content", moduleSourceIdentifier, e);
             source = null;
         }
@@ -126,17 +134,22 @@ public class MdsalNetconfOperationServiceFactory implements NetconfOperationServ
             LOG.warn("Error closing yang source stream {}. Ignoring", moduleSourceIdentifier, e);
         }
 
-        if(source !=null) {
+        if (source != null) {
             return Optional.of(new YangModuleCapability(module, source));
-        } else {
-            LOG.warn("Missing source for module {}. This module will not be available from netconf server",
-                    moduleSourceIdentifier);
         }
-        return Optional.absent();
+
+        LOG.warn("Missing source for module {}. This module will not be available from netconf server",
+            moduleSourceIdentifier);
+        return Optional.empty();
     }
 
     @Override
-    public AutoCloseable registerCapabilityListener(final CapabilityListener listener) {
+    public Registration registerCapabilityListener(final CapabilityListener listener) {
+        // Advertise validate capability only if DOMDataBroker provides DOMDataTransactionValidator
+        if (dataBroker.getExtensions().get(DOMDataTransactionValidator.class) != null) {
+            listener.onCapabilitiesChanged(Set.of(VALIDATE_CAPABILITY), Set.of());
+        }
+        // Advertise namespaces of supported YANG models as NETCONF capabilities
         return currentSchemaContext.registerCapabilityListener(listener);
     }
 }