restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/legacy/SchemaContextHandler.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 package org.opendaylight.restconf.nb.rfc8040.legacy;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.VisibleForTesting;
  13 import com.google.common.base.Throwables;
  14 import java.util.Collection;
  15 import java.util.List;
  16 import java.util.Map;
  17 import java.util.concurrent.ExecutionException;
  18 import java.util.concurrent.atomic.AtomicInteger;
  19 import javax.annotation.PreDestroy;
  20 import javax.inject.Inject;
  21 import javax.inject.Singleton;
  22 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  23 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
  24 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  25 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  26 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  27 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.ModulesState;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.YangLibrary;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.Module;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.Module.ConformanceType;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.module.Deviation;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.module.Submodule;
  34 import org.opendaylight.yangtools.concepts.Registration;
  35 import org.opendaylight.yangtools.yang.common.QName;
  36 import org.opendaylight.yangtools.yang.common.Revision;
  37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  40 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  43 import org.opendaylight.yangtools.yang.data.api.schema.SystemMapNode;
  44 import org.opendaylight.yangtools.yang.data.api.schema.builder.CollectionNodeBuilder;
  45 import org.opendaylight.yangtools.yang.data.api.schema.builder.DataContainerNodeBuilder;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  47 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  48 import org.opendaylight.yangtools.yang.data.tree.api.ConflictingModificationAppliedException;
  49 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  50 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextListener;
  51 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
  52 import org.opendaylight.yangtools.yang.model.api.ModuleLike;
  53 import org.osgi.service.component.annotations.Activate;
  54 import org.osgi.service.component.annotations.Component;
  55 import org.osgi.service.component.annotations.Deactivate;
  56 import org.osgi.service.component.annotations.Reference;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 /**
  61  * A component which maintains the state of {@code ietf-yang-library} inside the datastore.
  62  */
  63 // FIXME: this should be reconciled with the two other implementations we have.
  64 @Singleton
  65 @Component(service = { })
  66 public final class SchemaContextHandler implements EffectiveModelContextListener, AutoCloseable {
  67     private static final Logger LOG = LoggerFactory.getLogger(SchemaContextHandler.class);
  68
  69     private static final NodeIdentifier MODULE_CONFORMANCE_NODEID =
  70         NodeIdentifier.create(QName.create(YangLibrary.QNAME, "conformance-type").intern());
  71     private static final NodeIdentifier MODULE_FEATURE_NODEID =
  72         NodeIdentifier.create(QName.create(YangLibrary.QNAME, "feature").intern());
  73     private static final NodeIdentifier MODULE_NAME_NODEID =
  74         NodeIdentifier.create(QName.create(YangLibrary.QNAME, "name").intern());
  75     private static final NodeIdentifier MODULE_NAMESPACE_NODEID =
  76         NodeIdentifier.create(QName.create(YangLibrary.QNAME, "namespace").intern());
  77     private static final NodeIdentifier MODULE_REVISION_NODEID =
  78         NodeIdentifier.create(QName.create(YangLibrary.QNAME, "revision").intern());
  79     private static final NodeIdentifier MODULE_SCHEMA_NODEID =
  80         NodeIdentifier.create(QName.create(YangLibrary.QNAME, "schema").intern());
  81     private static final NodeIdentifier MODULE_SET_ID_LEAF_NODEID =
  82         NodeIdentifier.create(QName.create(YangLibrary.QNAME, "module-set-id").intern());
  83
  84     private final AtomicInteger moduleSetId = new AtomicInteger();
  85     private final DOMDataBroker domDataBroker;
  86     private final Registration listenerRegistration;
  87
  88     private volatile EffectiveModelContext schemaContext;
  89
  90     @Inject
  91     @Activate
  92     public SchemaContextHandler(@Reference final DOMDataBroker domDataBroker,
  93             @Reference final DOMSchemaService domSchemaService) {
  94         this.domDataBroker = requireNonNull(domDataBroker);
  95         listenerRegistration = domSchemaService.registerSchemaContextListener(this);
  96     }
  97
  98     @PreDestroy
  99     @Deactivate
 100     @Override
 101     public void close() {
 102         listenerRegistration.close();
 103     }
 104
 105     @Override
 106     public void onModelContextUpdated(final EffectiveModelContext context) {
 107         schemaContext = requireNonNull(context);
 108
 109         if (context.findModuleStatement(YangLibrary.QNAME.getModule()).isPresent()) {
 110             putData(mapModulesByIetfYangLibraryYang(context, String.valueOf(moduleSetId.incrementAndGet())));
 111         }
 112     }
 113
 114     @VisibleForTesting
 115     EffectiveModelContext get() {
 116         return schemaContext;
 117     }
 118
 119     private void putData(final ContainerNode normNode) {
 120         final DOMDataTreeWriteTransaction wTx = domDataBroker.newWriteOnlyTransaction();
 121         wTx.put(LogicalDatastoreType.OPERATIONAL,
 122                 YangInstanceIdentifier.of(NodeIdentifier.create(normNode.name().getNodeType())), normNode);
 123         try {
 124             wTx.commit().get();
 125         } catch (InterruptedException e) {
 126             throw new RestconfDocumentedException("Problem occurred while putting data to DS.", e);
 127         } catch (ExecutionException e) {
 128             final TransactionCommitFailedException failure = Throwables.getCauseAs(e,
 129                 TransactionCommitFailedException.class);
 130             if (failure.getCause() instanceof ConflictingModificationAppliedException) {
 131                 /*
 132                  * Ignore error when another cluster node is already putting the same data to DS.
 133                  * We expect that cluster is homogeneous and that node was going to write the same data
 134                  * (that means no retry is needed). Transaction chain reset must be invoked to be able
 135                  * to continue writing data with another transaction after failed transaction.
 136                  * This is workaround for bug https://bugs.opendaylight.org/show_bug.cgi?id=7728
 137                  */
 138                 LOG.warn("Ignoring that another cluster node is already putting the same data to DS.", e);
 139             } else {
 140                 throw new RestconfDocumentedException("Problem occurred while putting data to DS.", failure);
 141             }
 142         }
 143     }
 144
 145     /**
 146      * Map data from modules to {@link NormalizedNode}.
 147      *
 148      * @param context schema context
 149      * @param moduleSetId module-set-id of actual set
 150      * @return mapped data as {@link NormalizedNode}
 151      */
 152     @VisibleForTesting
 153     public static ContainerNode mapModulesByIetfYangLibraryYang(final EffectiveModelContext context,
 154             final String moduleSetId) {
 155         final var mapBuilder = Builders.mapBuilder()
 156             .withNodeIdentifier(new NodeIdentifier(Module.QNAME));
 157         for (var module : context.getModules()) {
 158             fillMapByModules(mapBuilder, Module.QNAME, false, module, context);
 159         }
 160         return Builders.containerBuilder()
 161             .withNodeIdentifier(new NodeIdentifier(ModulesState.QNAME))
 162             .withChild(ImmutableNodes.leafNode(MODULE_SET_ID_LEAF_NODEID, moduleSetId))
 163             .withChild(mapBuilder.build())
 164             .build();
 165     }
 166
 167     /**
 168      * Map data by the specific module or submodule.
 169      *
 170      * @param mapBuilder ordered list builder for children
 171      * @param mapQName QName corresponding to the list builder
 172      * @param isSubmodule true if module is specified as submodule, false otherwise
 173      * @param module specific module or submodule
 174      * @param context schema context
 175      */
 176     private static void fillMapByModules(final CollectionNodeBuilder<MapEntryNode, SystemMapNode> mapBuilder,
 177             final QName mapQName, final boolean isSubmodule, final ModuleLike module,
 178             final EffectiveModelContext context) {
 179         final var mapEntryBuilder = newCommonLeafsMapEntryBuilder(mapQName, module);
 180
 181         mapEntryBuilder.withChild(ImmutableNodes.leafNode(MODULE_SCHEMA_NODEID,
 182             "/modules/" + module.getName() + "/"
 183             // FIXME: orElse(null) does not seem appropriate here
 184             + module.getQNameModule().getRevision().map(Revision::toString).orElse(null)));
 185
 186         if (!isSubmodule) {
 187             mapEntryBuilder.withChild(ImmutableNodes.leafNode(MODULE_NAMESPACE_NODEID,
 188                 module.getNamespace().toString()));
 189
 190             // features - not mandatory
 191             if (module.getFeatures() != null && !module.getFeatures().isEmpty()) {
 192                 addFeatureLeafList(mapEntryBuilder, module.getFeatures());
 193             }
 194             // deviations - not mandatory
 195             final ConformanceType conformance;
 196             if (module.getDeviations() != null && !module.getDeviations().isEmpty()) {
 197                 addDeviationList(module, mapEntryBuilder, context);
 198                 conformance = ConformanceType.Implement;
 199             } else {
 200                 conformance = ConformanceType.Import;
 201             }
 202             mapEntryBuilder.withChild(
 203                 ImmutableNodes.leafNode(MODULE_CONFORMANCE_NODEID, conformance.getName()));
 204
 205             // submodules - not mandatory
 206             if (module.getSubmodules() != null && !module.getSubmodules().isEmpty()) {
 207                 addSubmodules(module, mapEntryBuilder, context);
 208             }
 209         }
 210         mapBuilder.withChild(mapEntryBuilder.build());
 211     }
 212
 213     /**
 214      * Mapping submodules of specific module.
 215      *
 216      * @param module module with submodules
 217      * @param mapEntryBuilder mapEntryBuilder of parent for mapping children
 218      * @param context schema context
 219      */
 220     private static void addSubmodules(final ModuleLike module,
 221             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder,
 222             final EffectiveModelContext context) {
 223         final var mapBuilder = Builders.mapBuilder()
 224             .withNodeIdentifier(new NodeIdentifier(Submodule.QNAME));
 225
 226         for (var submodule : module.getSubmodules()) {
 227             fillMapByModules(mapBuilder, Submodule.QNAME, true, submodule, context);
 228         }
 229         mapEntryBuilder.withChild(mapBuilder.build());
 230     }
 231
 232     /**
 233      * Mapping deviations of specific module.
 234      *
 235      * @param module
 236      *             module with deviations
 237      * @param mapEntryBuilder
 238      *             mapEntryBuilder of parent for mapping children
 239      * @param context
 240      *             schema context
 241      */
 242     private static void addDeviationList(final ModuleLike module,
 243             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder,
 244             final EffectiveModelContext context) {
 245         final var deviations = Builders.mapBuilder()
 246             .withNodeIdentifier(new NodeIdentifier(Deviation.QNAME));
 247         for (var deviation : module.getDeviations()) {
 248             final List<QName> ids = deviation.getTargetPath().getNodeIdentifiers();
 249             final QName lastComponent = ids.get(ids.size() - 1);
 250
 251             deviations.withChild(newCommonLeafsMapEntryBuilder(Deviation.QNAME,
 252                 context.findModule(lastComponent.getModule()).orElseThrow())
 253                 .build());
 254         }
 255         mapEntryBuilder.withChild(deviations.build());
 256     }
 257
 258     /**
 259      * Mapping features of specific module.
 260      *
 261      * @param mapEntryBuilder mapEntryBuilder of parent for mapping children
 262      * @param features features of specific module
 263      */
 264     private static void addFeatureLeafList(
 265             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder,
 266             final Collection<? extends FeatureDefinition> features) {
 267         final var leafSetBuilder = Builders.<String>leafSetBuilder()
 268                 .withNodeIdentifier(MODULE_FEATURE_NODEID);
 269         for (var feature : features) {
 270             leafSetBuilder.withChildValue(feature.getQName().getLocalName());
 271         }
 272         mapEntryBuilder.withChild(leafSetBuilder.build());
 273     }
 274
 275     private static DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> newCommonLeafsMapEntryBuilder(
 276             final QName qname, final ModuleLike module) {
 277         final var name = module.getName();
 278         final var revision = module.getQNameModule().getRevision().map(Revision::toString).orElse("");
 279         return Builders.mapEntryBuilder()
 280             .withNodeIdentifier(NodeIdentifierWithPredicates.of(qname,
 281                 Map.of(MODULE_NAME_NODEID.getNodeType(), name, MODULE_REVISION_NODEID.getNodeType(), revision)))
 282             .withChild(ImmutableNodes.leafNode(MODULE_NAME_NODEID, name))
 283             .withChild(ImmutableNodes.leafNode(MODULE_REVISION_NODEID, revision));
 284     }
 285 }