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