netconf/mdsal-netconf-yang-library/src/main/java/org/opendaylight/netconf/mdsal/yang/library/SchemaServiceToMdsalWriter.java

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