plugins/netconf-server-mdsal/src/main/java/org/opendaylight/netconf/server/mdsal/MdsalNetconfOperationServiceFactory.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.netconf.server.mdsal;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import java.io.IOException;
  13 import java.util.HashSet;
  14 import java.util.Optional;
  15 import java.util.Set;
  16 import java.util.concurrent.ExecutionException;
  17 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  18 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  19 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  20 import org.opendaylight.mdsal.dom.api.DOMSchemaService.YangTextSourceExtension;
  21 import org.opendaylight.netconf.api.CapabilityURN;
  22 import org.opendaylight.netconf.server.api.monitoring.BasicCapability;
  23 import org.opendaylight.netconf.server.api.monitoring.Capability;
  24 import org.opendaylight.netconf.server.api.monitoring.CapabilityListener;
  25 import org.opendaylight.netconf.server.api.monitoring.YangModuleCapability;
  26 import org.opendaylight.netconf.server.api.operations.NetconfOperationService;
  27 import org.opendaylight.netconf.server.api.operations.NetconfOperationServiceFactory;
  28 import org.opendaylight.netconf.server.api.operations.NetconfOperationServiceFactoryListener;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdType;
  30 import org.opendaylight.yangtools.concepts.Registration;
  31 import org.opendaylight.yangtools.yang.common.Revision;
  32 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  33 import org.opendaylight.yangtools.yang.model.api.ModuleLike;
  34 import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
  35 import org.osgi.service.component.annotations.Activate;
  36 import org.osgi.service.component.annotations.Component;
  37 import org.osgi.service.component.annotations.Deactivate;
  38 import org.osgi.service.component.annotations.Reference;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 @Component(service = NetconfOperationServiceFactory.class, immediate = true, property = "type=mdsal-netconf-connector")
  43 public final class MdsalNetconfOperationServiceFactory implements NetconfOperationServiceFactory, AutoCloseable {
  44     private static final Logger LOG = LoggerFactory.getLogger(MdsalNetconfOperationServiceFactory.class);
  45     private static final BasicCapability VALIDATE_CAPABILITY = new BasicCapability(CapabilityURN.VALIDATE);
  46
  47     private final DOMDataBroker dataBroker;
  48     private final DOMRpcService rpcService;
  49
  50     private final CurrentSchemaContext currentSchemaContext;
  51     private final YangTextSourceExtension yangTextSourceExtension;
  52     private final NetconfOperationServiceFactoryListener netconfOperationServiceFactoryListener;
  53
  54     @Activate
  55     public MdsalNetconfOperationServiceFactory(@Reference final DOMSchemaService schemaService,
  56             @Reference final DOMDataBroker dataBroker, @Reference final DOMRpcService rpcService,
  57             @Reference(target = "(type=mapper-aggregator-registry)")
  58             final NetconfOperationServiceFactoryListener netconfOperationServiceFactoryListener) {
  59         this.dataBroker = requireNonNull(dataBroker);
  60         this.rpcService = requireNonNull(rpcService);
  61         this.netconfOperationServiceFactoryListener = requireNonNull(netconfOperationServiceFactoryListener);
  62
  63         yangTextSourceExtension = schemaService.extension(YangTextSourceExtension.class);
  64         currentSchemaContext = CurrentSchemaContext.create(requireNonNull(schemaService), yangTextSourceExtension);
  65         netconfOperationServiceFactoryListener.onAddNetconfOperationServiceFactory(this);
  66     }
  67
  68     @Deactivate
  69     @Override
  70     public void close() {
  71         netconfOperationServiceFactoryListener.onRemoveNetconfOperationServiceFactory(this);
  72         currentSchemaContext.close();
  73     }
  74
  75     @Override
  76     public NetconfOperationService createService(final SessionIdType sessionId) {
  77         return new MdsalNetconfOperationService(currentSchemaContext, sessionId, dataBroker, rpcService);
  78     }
  79
  80     @Override
  81     public Set<Capability> getCapabilities() {
  82         // FIXME: cache returned set
  83         return transformCapabilities(currentSchemaContext.getCurrentContext(), yangTextSourceExtension);
  84     }
  85
  86     // FIXME: ImmutableSet
  87     static Set<Capability> transformCapabilities(final EffectiveModelContext currentContext,
  88             final YangTextSourceExtension rootSchemaSourceProviderDependency) {
  89         final var capabilities = new HashSet<Capability>();
  90
  91         // Added by netconf-impl by default
  92         // capabilities.add(new BasicCapability(CapabilityURN.CANDIDATE));
  93
  94         // FIXME: rework in terms of ModuleEffectiveStatement
  95         for (var module : currentContext.getModules()) {
  96             moduleToCapability(module, rootSchemaSourceProviderDependency).ifPresent(capabilities::add);
  97             for (var submodule : module.getSubmodules()) {
  98                 moduleToCapability(submodule, rootSchemaSourceProviderDependency).ifPresent(capabilities::add);
  99             }
 100         }
 101
 102         return capabilities;
 103     }
 104
 105     private static Optional<YangModuleCapability> moduleToCapability(final ModuleLike module,
 106             final YangTextSourceExtension yangTextSourceExtension) {
 107         final String moduleNamespace = module.getNamespace().toString();
 108         final String moduleName = module.getName();
 109         final String revision = module.getRevision().map(Revision::toString).orElse(null);
 110         final SourceIdentifier moduleSourceIdentifier = new SourceIdentifier(moduleName, revision);
 111
 112         String source;
 113         try {
 114             source = yangTextSourceExtension.getYangTexttSource(moduleSourceIdentifier).get().read();
 115         } catch (ExecutionException | InterruptedException | IOException e) {
 116             LOG.warn("Ignoring source for module {}. Unable to read content", moduleSourceIdentifier, e);
 117             source = null;
 118         }
 119
 120         if (source != null) {
 121             return Optional.of(new YangModuleCapability(moduleNamespace, moduleName, revision, source));
 122         }
 123
 124         LOG.warn("Missing source for module {}. This module will not be available from netconf server",
 125             moduleSourceIdentifier);
 126         return Optional.empty();
 127     }
 128
 129     @Override
 130     public Registration registerCapabilityListener(final CapabilityListener listener) {
 131         // Advertise validate capability only if DOMDataBroker provides DOMDataTransactionValidator
 132         if (dataBroker.extension(DOMDataTransactionValidator.class) != null) {
 133             // FIXME: support VALIDATE_1_1 as well!
 134             listener.onCapabilitiesChanged(Set.of(VALIDATE_CAPABILITY), Set.of());
 135         }
 136         // Advertise namespaces of supported YANG models as NETCONF capabilities
 137         return currentSchemaContext.registerCapabilityListener(listener);
 138     }
 139 }