netconf/mdsal-netconf-connector/src/main/java/org/opendaylight/netconf/mdsal/connector/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
   9 package org.opendaylight.netconf.mdsal.connector;
  10
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.io.CharStreams;
  13 import java.io.IOException;
  14 import java.io.InputStream;
  15 import java.io.InputStreamReader;
  16 import java.nio.charset.StandardCharsets;
  17 import java.util.Collections;
  18 import java.util.HashSet;
  19 import java.util.Optional;
  20 import java.util.Set;
  21 import java.util.concurrent.ExecutionException;
  22 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  23 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  24 import org.opendaylight.controller.sal.core.api.model.SchemaService;
  25 import org.opendaylight.netconf.api.capability.BasicCapability;
  26 import org.opendaylight.netconf.api.capability.Capability;
  27 import org.opendaylight.netconf.api.capability.YangModuleCapability;
  28 import org.opendaylight.netconf.api.monitoring.CapabilityListener;
  29 import org.opendaylight.netconf.mapping.api.NetconfOperationServiceFactory;
  30 import org.opendaylight.netconf.mapping.api.NetconfOperationServiceFactoryListener;
  31 import org.opendaylight.yangtools.yang.model.api.Module;
  32 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  33 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
  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.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 public class MdsalNetconfOperationServiceFactory implements NetconfOperationServiceFactory, AutoCloseable {
  41
  42     private static final Logger LOG = LoggerFactory.getLogger(MdsalNetconfOperationServiceFactory.class);
  43     private static final BasicCapability VALIDATE_CAPABILITY =
  44         new BasicCapability("urn:ietf:params:netconf:capability:validate:1.0");
  45
  46     private final DOMDataBroker dataBroker;
  47     private final DOMRpcService rpcService;
  48
  49     private final CurrentSchemaContext currentSchemaContext;
  50     private final SchemaSourceProvider<YangTextSchemaSource> rootSchemaSourceProviderDependency;
  51     private final NetconfOperationServiceFactoryListener netconfOperationServiceFactoryListener;
  52
  53     public MdsalNetconfOperationServiceFactory(
  54             final SchemaService schemaService,
  55             final SchemaSourceProvider<YangTextSchemaSource> rootSchemaSourceProviderDependency,
  56             final NetconfOperationServiceFactoryListener netconfOperationServiceFactoryListener,
  57             final DOMDataBroker dataBroker,
  58             final DOMRpcService rpcService) {
  59
  60         this.dataBroker = dataBroker;
  61         this.rpcService = rpcService;
  62
  63         this.rootSchemaSourceProviderDependency = rootSchemaSourceProviderDependency;
  64         this.currentSchemaContext = new CurrentSchemaContext(Preconditions.checkNotNull(schemaService),
  65                 rootSchemaSourceProviderDependency);
  66         this.netconfOperationServiceFactoryListener = netconfOperationServiceFactoryListener;
  67         this.netconfOperationServiceFactoryListener.onAddNetconfOperationServiceFactory(this);
  68     }
  69
  70     @Override
  71     public MdsalNetconfOperationService createService(final String netconfSessionIdForReporting) {
  72         Preconditions.checkState(dataBroker != null, "MD-SAL provider not yet initialized");
  73         return new MdsalNetconfOperationService(currentSchemaContext, netconfSessionIdForReporting, dataBroker,
  74                 rpcService);
  75     }
  76
  77     @SuppressWarnings("checkstyle:IllegalCatch")
  78     @Override
  79     public void close() {
  80         try {
  81             currentSchemaContext.close();
  82             if (netconfOperationServiceFactoryListener != null) {
  83                 netconfOperationServiceFactoryListener.onRemoveNetconfOperationServiceFactory(this);
  84             }
  85         } catch (Exception e) {
  86             LOG.error("Failed to close resources correctly - ignore", e);
  87         }
  88     }
  89
  90     @Override
  91     public Set<Capability> getCapabilities() {
  92         return transformCapabilities(currentSchemaContext.getCurrentContext(), rootSchemaSourceProviderDependency);
  93     }
  94
  95     static Set<Capability> transformCapabilities(
  96             final SchemaContext currentContext,
  97             final SchemaSourceProvider<YangTextSchemaSource> rootSchemaSourceProviderDependency) {
  98         final Set<Capability> capabilities = new HashSet<>();
  99
 100         // Added by netconf-impl by default
 101         // capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0"));
 102
 103         final Set<Module> modules = currentContext.getModules();
 104         for (final Module module : modules) {
 105             Optional<YangModuleCapability> cap = moduleToCapability(module, rootSchemaSourceProviderDependency);
 106             if (cap.isPresent()) {
 107                 capabilities.add(cap.get());
 108             }
 109             for (final Module submodule : module.getSubmodules()) {
 110                 cap = moduleToCapability(submodule, rootSchemaSourceProviderDependency);
 111                 if (cap.isPresent()) {
 112                     capabilities.add(cap.get());
 113                 }
 114             }
 115         }
 116
 117         return capabilities;
 118     }
 119
 120     private static Optional<YangModuleCapability> moduleToCapability(
 121             final Module module, final SchemaSourceProvider<YangTextSchemaSource> rootSchemaSourceProviderDependency) {
 122
 123         final SourceIdentifier moduleSourceIdentifier = RevisionSourceIdentifier.create(module.getName(),
 124                 module.getRevision());
 125
 126         InputStream sourceStream = null;
 127         String source;
 128         try {
 129             sourceStream = rootSchemaSourceProviderDependency.getSource(moduleSourceIdentifier).get().openStream();
 130             source = CharStreams.toString(new InputStreamReader(sourceStream, StandardCharsets.UTF_8));
 131         } catch (ExecutionException | InterruptedException | IOException e) {
 132             LOG.warn("Ignoring source for module {}. Unable to read content", moduleSourceIdentifier, e);
 133             source = null;
 134         }
 135
 136         try {
 137             if (sourceStream != null) {
 138                 sourceStream.close();
 139             }
 140         } catch (IOException e) {
 141             LOG.warn("Error closing yang source stream {}. Ignoring", moduleSourceIdentifier, e);
 142         }
 143
 144         if (source != null) {
 145             return Optional.of(new YangModuleCapability(module, source));
 146         }
 147
 148         LOG.warn("Missing source for module {}. This module will not be available from netconf server",
 149             moduleSourceIdentifier);
 150         return Optional.empty();
 151     }
 152
 153     @Override
 154     public AutoCloseable registerCapabilityListener(final CapabilityListener listener) {
 155         // Advertise validate capability only if DOMDataBroker provides DOMDataTransactionValidator
 156         if (dataBroker.getSupportedExtensions().get(DOMDataTransactionValidator.class) != null) {
 157             listener.onCapabilitiesChanged(Collections.singleton(VALIDATE_CAPABILITY), Collections.emptySet());
 158         }
 159         // Advertise namespaces of supported YANG models as NETCONF capabilities
 160         return currentSchemaContext.registerCapabilityListener(listener);
 161     }
 162 }