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.DOMYangTextSourceProvider;
  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.repo.api.SourceIdentifier;
  35 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  36 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
  37 import org.osgi.service.component.annotations.Activate;
  38 import org.osgi.service.component.annotations.Component;
  39 import org.osgi.service.component.annotations.Deactivate;
  40 import org.osgi.service.component.annotations.Reference;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 @Component(service = NetconfOperationServiceFactory.class, immediate = true, property = "type=mdsal-netconf-connector")
  45 public final class MdsalNetconfOperationServiceFactory implements NetconfOperationServiceFactory, AutoCloseable {
  46     private static final Logger LOG = LoggerFactory.getLogger(MdsalNetconfOperationServiceFactory.class);
  47     private static final BasicCapability VALIDATE_CAPABILITY = new BasicCapability(CapabilityURN.VALIDATE);
  48
  49     private final DOMDataBroker dataBroker;
  50     private final DOMRpcService rpcService;
  51
  52     private final CurrentSchemaContext currentSchemaContext;
  53     private final SchemaSourceProvider<YangTextSchemaSource> rootSchemaSourceProviderDependency;
  54     private final NetconfOperationServiceFactoryListener netconfOperationServiceFactoryListener;
  55
  56     @Activate
  57     public MdsalNetconfOperationServiceFactory(@Reference final DOMSchemaService schemaService,
  58             @Reference final DOMDataBroker dataBroker, @Reference final DOMRpcService rpcService,
  59             @Reference(target = "(type=mapper-aggregator-registry)")
  60             final NetconfOperationServiceFactoryListener netconfOperationServiceFactoryListener) {
  61         this.dataBroker = requireNonNull(dataBroker);
  62         this.rpcService = requireNonNull(rpcService);
  63         this.netconfOperationServiceFactoryListener = requireNonNull(netconfOperationServiceFactoryListener);
  64
  65         rootSchemaSourceProviderDependency = schemaService.getExtensions()
  66                 .getInstance(DOMYangTextSourceProvider.class);
  67         currentSchemaContext = CurrentSchemaContext.create(requireNonNull(schemaService),
  68                 rootSchemaSourceProviderDependency);
  69         netconfOperationServiceFactoryListener.onAddNetconfOperationServiceFactory(this);
  70     }
  71
  72     @Deactivate
  73     @Override
  74     public void close() {
  75         netconfOperationServiceFactoryListener.onRemoveNetconfOperationServiceFactory(this);
  76         currentSchemaContext.close();
  77     }
  78
  79     @Override
  80     public NetconfOperationService createService(final SessionIdType sessionId) {
  81         return new MdsalNetconfOperationService(currentSchemaContext, sessionId, dataBroker, rpcService);
  82     }
  83
  84     @Override
  85     public Set<Capability> getCapabilities() {
  86         // FIXME: cache returned set
  87         return transformCapabilities(currentSchemaContext.getCurrentContext(), rootSchemaSourceProviderDependency);
  88     }
  89
  90     // FIXME: ImmutableSet
  91     static Set<Capability> transformCapabilities(
  92             final EffectiveModelContext currentContext,
  93             final SchemaSourceProvider<YangTextSchemaSource> rootSchemaSourceProviderDependency) {
  94         final var capabilities = new HashSet<Capability>();
  95
  96         // Added by netconf-impl by default
  97         // capabilities.add(new BasicCapability(CapabilityURN.CANDIDATE));
  98
  99         // FIXME: rework in terms of ModuleEffectiveStatement
 100         for (var module : currentContext.getModules()) {
 101             moduleToCapability(module, rootSchemaSourceProviderDependency).ifPresent(capabilities::add);
 102             for (var submodule : module.getSubmodules()) {
 103                 moduleToCapability(submodule, rootSchemaSourceProviderDependency).ifPresent(capabilities::add);
 104             }
 105         }
 106
 107         return capabilities;
 108     }
 109
 110     private static Optional<YangModuleCapability> moduleToCapability(final ModuleLike module,
 111             final SchemaSourceProvider<YangTextSchemaSource> rootSchemaSourceProviderDependency) {
 112         final String moduleNamespace = module.getNamespace().toString();
 113         final String moduleName = module.getName();
 114         final String revision = module.getRevision().map(Revision::toString).orElse(null);
 115         final SourceIdentifier moduleSourceIdentifier = new SourceIdentifier(moduleName, revision);
 116
 117         String source;
 118         try {
 119             source = rootSchemaSourceProviderDependency.getSource(moduleSourceIdentifier).get().read();
 120         } catch (ExecutionException | InterruptedException | IOException e) {
 121             LOG.warn("Ignoring source for module {}. Unable to read content", moduleSourceIdentifier, e);
 122             source = null;
 123         }
 124
 125         if (source != null) {
 126             return Optional.of(new YangModuleCapability(moduleNamespace, moduleName, revision, source));
 127         }
 128
 129         LOG.warn("Missing source for module {}. This module will not be available from netconf server",
 130             moduleSourceIdentifier);
 131         return Optional.empty();
 132     }
 133
 134     @Override
 135     public Registration registerCapabilityListener(final CapabilityListener listener) {
 136         // Advertise validate capability only if DOMDataBroker provides DOMDataTransactionValidator
 137         if (dataBroker.getExtensions().get(DOMDataTransactionValidator.class) != null) {
 138             // FIXME: support VALIDATE_1_1 as well!
 139             listener.onCapabilitiesChanged(Set.of(VALIDATE_CAPABILITY), Set.of());
 140         }
 141         // Advertise namespaces of supported YANG models as NETCONF capabilities
 142         return currentSchemaContext.registerCapabilityListener(listener);
 143     }
 144 }