2 * Copyright (c) 2016 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
9 package org.opendaylight.netconf.mdsal.yang.library;
11 import com.google.common.collect.Lists;
12 import com.google.common.util.concurrent.FutureCallback;
13 import com.google.common.util.concurrent.Futures;
14 import com.google.common.util.concurrent.MoreExecutors;
15 import java.util.List;
17 import java.util.concurrent.atomic.AtomicInteger;
18 import javax.annotation.Nullable;
19 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
20 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
21 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
22 import org.opendaylight.controller.sal.core.api.model.SchemaService;
23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.ModulesState;
25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.ModulesStateBuilder;
26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.OptionalRevision;
27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.module.list.Module.ConformanceType;
28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.module.list.ModuleBuilder;
29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.module.list.module.Submodules;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.module.list.module.SubmodulesBuilder;
31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.module.list.module.submodules.Submodule;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.module.list.module.submodules.SubmoduleBuilder;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.YangIdentifier;
34 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
35 import org.opendaylight.yangtools.yang.model.api.Module;
36 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
37 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
42 * Listens for updates on global schema context, transforms context to ietf-yang-library:modules-state and
43 * writes this state to operational data store.
45 // TODO Implement also yang-library-change notfication
46 public class SchemaServiceToMdsalWriter implements SchemaContextListener, AutoCloseable {
48 private static final Logger LOG = LoggerFactory.getLogger(SchemaServiceToMdsalWriter.class);
50 private static final InstanceIdentifier<ModulesState> MODULES_STATE_INSTANCE_IDENTIFIER =
51 InstanceIdentifier.create(ModulesState.class);
53 private final SchemaService schemaService;
54 private final AtomicInteger moduleSetId;
55 private final DataBroker dataBroker;
57 public SchemaServiceToMdsalWriter(final SchemaService schemaService,
58 final DataBroker dataBroker) {
59 this.schemaService = schemaService;
60 this.dataBroker = dataBroker;
61 this.moduleSetId = new AtomicInteger(0);
65 public void close() throws Exception {
66 // TODO Delete modules-state from operational data store
70 * Invoked by blueprint.
73 schemaService.registerSchemaContextListener(this);
78 public void onGlobalContextUpdated(final SchemaContext context) {
79 final ModulesState newModuleState = createModuleStateFromModules(context.getModules());
80 final WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
81 tx.put(LogicalDatastoreType.OPERATIONAL,
82 MODULES_STATE_INSTANCE_IDENTIFIER, newModuleState);
84 LOG.debug("Trying to write new module-state: {}", newModuleState);
85 Futures.addCallback(tx.submit(), new FutureCallback<Void>() {
87 public void onSuccess(@Nullable final Void result) {
88 LOG.debug("Modules state updated successfully");
92 public void onFailure(final Throwable throwable) {
93 LOG.warn("Failed to update modules state", throwable);
95 }, MoreExecutors.directExecutor());
98 private ModulesState createModuleStateFromModules(final Set<Module> modules) {
99 final ModulesStateBuilder modulesStateBuilder = new ModulesStateBuilder();
100 final List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.module.list
101 .Module> moduleList =
102 Lists.newArrayList();
104 for (final Module module : modules) {
105 moduleList.add(createModuleEntryFromModule(module));
108 return modulesStateBuilder.setModule(moduleList).setModuleSetId(String.valueOf(moduleSetId.getAndIncrement()))
112 private org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.module.list.Module
113 createModuleEntryFromModule(final Module module) {
114 final ModuleBuilder moduleBuilder = new ModuleBuilder();
116 // TODO Conformance type is always set to Implement value, but it should it really be like this?
117 // TODO Add also deviations and features lists to module entries
118 moduleBuilder.setName(new YangIdentifier(module.getName()))
119 .setRevision(new OptionalRevision(module.getQNameModule().getFormattedRevision()))
120 .setNamespace(new Uri(module.getNamespace().toString()))
121 .setConformanceType(ConformanceType.Implement)
122 .setSubmodules(createSubmodulesForModule(module));
124 return moduleBuilder.build();
127 private Submodules createSubmodulesForModule(final Module module) {
128 final List<Submodule> submodulesList = Lists.newArrayList();
129 for (final Module subModule : module.getSubmodules()) {
130 final SubmoduleBuilder subModuleEntryBuilder = new SubmoduleBuilder();
131 subModuleEntryBuilder.setName(new YangIdentifier(subModule.getName()))
132 .setRevision(new OptionalRevision(subModule.getQNameModule().getFormattedRevision()));
133 submodulesList.add(subModuleEntryBuilder.build());
136 return new SubmodulesBuilder().setSubmodule(submodulesList).build();