2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.netconf.mdsal.connector;
10 import com.google.common.base.Preconditions;
11 import com.google.common.io.CharStreams;
12 import java.io.IOException;
13 import java.io.InputStream;
14 import java.io.InputStreamReader;
15 import java.nio.charset.StandardCharsets;
16 import java.util.Collections;
17 import java.util.HashSet;
18 import java.util.Optional;
20 import java.util.concurrent.ExecutionException;
21 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
22 import org.opendaylight.mdsal.dom.api.DOMRpcService;
23 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
24 import org.opendaylight.mdsal.dom.api.DOMYangTextSourceProvider;
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;
40 public class MdsalNetconfOperationServiceFactory implements NetconfOperationServiceFactory, AutoCloseable {
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");
46 private final DOMDataBroker dataBroker;
47 private final DOMRpcService rpcService;
49 private final CurrentSchemaContext currentSchemaContext;
50 private final SchemaSourceProvider<YangTextSchemaSource> rootSchemaSourceProviderDependency;
51 private final NetconfOperationServiceFactoryListener netconfOperationServiceFactoryListener;
53 public MdsalNetconfOperationServiceFactory(
54 final DOMSchemaService schemaService,
55 final NetconfOperationServiceFactoryListener netconfOperationServiceFactoryListener,
56 final DOMDataBroker dataBroker,
57 final DOMRpcService rpcService) {
59 this.dataBroker = dataBroker;
60 this.rpcService = rpcService;
62 this.rootSchemaSourceProviderDependency = schemaService.getExtensions()
63 .getInstance(DOMYangTextSourceProvider.class);
64 this.currentSchemaContext = new CurrentSchemaContext(Preconditions.checkNotNull(schemaService),
65 rootSchemaSourceProviderDependency);
66 this.netconfOperationServiceFactoryListener = netconfOperationServiceFactoryListener;
67 this.netconfOperationServiceFactoryListener.onAddNetconfOperationServiceFactory(this);
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,
77 @SuppressWarnings("checkstyle:IllegalCatch")
81 currentSchemaContext.close();
82 if (netconfOperationServiceFactoryListener != null) {
83 netconfOperationServiceFactoryListener.onRemoveNetconfOperationServiceFactory(this);
85 } catch (Exception e) {
86 LOG.error("Failed to close resources correctly - ignore", e);
91 public Set<Capability> getCapabilities() {
92 return transformCapabilities(currentSchemaContext.getCurrentContext(), rootSchemaSourceProviderDependency);
95 static Set<Capability> transformCapabilities(
96 final SchemaContext currentContext,
97 final SchemaSourceProvider<YangTextSchemaSource> rootSchemaSourceProviderDependency) {
98 final Set<Capability> capabilities = new HashSet<>();
100 // Added by netconf-impl by default
101 // capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0"));
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());
109 for (final Module submodule : module.getSubmodules()) {
110 cap = moduleToCapability(submodule, rootSchemaSourceProviderDependency);
111 if (cap.isPresent()) {
112 capabilities.add(cap.get());
120 private static Optional<YangModuleCapability> moduleToCapability(
121 final Module module, final SchemaSourceProvider<YangTextSchemaSource> rootSchemaSourceProviderDependency) {
123 final SourceIdentifier moduleSourceIdentifier = RevisionSourceIdentifier.create(module.getName(),
124 module.getRevision());
126 InputStream sourceStream = null;
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);
137 if (sourceStream != null) {
138 sourceStream.close();
140 } catch (IOException e) {
141 LOG.warn("Error closing yang source stream {}. Ignoring", moduleSourceIdentifier, e);
144 if (source != null) {
145 return Optional.of(new YangModuleCapability(module, source));
148 LOG.warn("Missing source for module {}. This module will not be available from netconf server",
149 moduleSourceIdentifier);
150 return Optional.empty();
154 public AutoCloseable registerCapabilityListener(final CapabilityListener listener) {
155 // Advertise validate capability only if DOMDataBroker provides DOMDataTransactionValidator
156 if (dataBroker.getExtensions().get(DOMDataTransactionValidator.class) != null) {
157 listener.onCapabilitiesChanged(Collections.singleton(VALIDATE_CAPABILITY), Collections.emptySet());
159 // Advertise namespaces of supported YANG models as NETCONF capabilities
160 return currentSchemaContext.registerCapabilityListener(listener);