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.common.SimpleDateFormatUtil;
  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;
  40
  41 /**
  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
  44  */
  45 // TODO Implement also yang-library-change notfication
  46 public class SchemaServiceToMdsalWriter implements SchemaContextListener, AutoCloseable {
  47
  48     private static final Logger LOG = LoggerFactory.getLogger(SchemaServiceToMdsalWriter.class);
  49
  50     private static final InstanceIdentifier<ModulesState> MODULES_STATE_INSTANCE_IDENTIFIER =
  51             InstanceIdentifier.create(ModulesState.class);
  52
  53     private final SchemaService schemaService;
  54     private final AtomicInteger moduleSetId;
  55     private final DataBroker dataBroker;
  56
  57     public SchemaServiceToMdsalWriter(final SchemaService schemaService,
  58                                       final DataBroker dataBroker) {
  59         this.schemaService = schemaService;
  60         this.dataBroker = dataBroker;
  61         this.moduleSetId = new AtomicInteger(0);
  62     }
  63
  64     @Override
  65     public void close() throws Exception {
  66         // TODO Delete modules-state from operational data store
  67     }
  68
  69     /**
  70      * Invoke by blueprint
  71      */
  72     public void start() {
  73         schemaService.registerSchemaContextListener(this);
  74     }
  75
  76
  77     @Override
  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);
  83
  84         LOG.debug("Trying to write new module-state: {}", newModuleState);
  85         Futures.addCallback(tx.submit(), new FutureCallback<Void>() {
  86             @Override
  87             public void onSuccess(@Nullable final Void result) {
  88                 LOG.debug("Modules state updated successfully");
  89             }
  90
  91             @Override
  92             public void onFailure(final Throwable t) {
  93                 LOG.warn("Failed to update modules state", t);
  94             }
  95         });
  96     }
  97
  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.Module> moduleList =
 101                 Lists.newArrayList();
 102
 103         for (final Module module : modules) {
 104             moduleList.add(createModuleEntryFromModule(module));
 105         }
 106
 107         return modulesStateBuilder.setModule(moduleList).setModuleSetId(String.valueOf(moduleSetId.getAndIncrement())).build();
 108     }
 109
 110     private org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.module.list.Module createModuleEntryFromModule(final Module module) {
 111         final ModuleBuilder moduleBuilder = new ModuleBuilder();
 112
 113         // TODO Conformance type is always set to Implement value, but it should it really be like this?
 114         // TODO Add also deviations and features lists to module entries
 115         moduleBuilder.setName(new YangIdentifier(module.getName()))
 116                 .setRevision(new OptionalRevision(SimpleDateFormatUtil.getRevisionFormat().format(module.getRevision())))
 117                 .setNamespace(new Uri(module.getNamespace().toString()))
 118                 .setConformanceType(ConformanceType.Implement)
 119                 .setSubmodules(createSubmodulesForModule(module));
 120
 121         return moduleBuilder.build();
 122     }
 123
 124     private Submodules createSubmodulesForModule(final Module module) {
 125         final List<Submodule> submodulesList = Lists.newArrayList();
 126         for (final Module subModule : module.getSubmodules()) {
 127             final SubmoduleBuilder subModuleEntryBuilder = new SubmoduleBuilder();
 128             subModuleEntryBuilder.setName(new YangIdentifier(subModule.getName()))
 129                     .setRevision(new OptionalRevision(SimpleDateFormatUtil.getRevisionFormat().format(subModule.getRevision())));
 130             submodulesList.add(subModuleEntryBuilder.build());
 131         }
 132
 133         return  new SubmodulesBuilder().setSubmodule(submodulesList).build();
 134     }
 135 }