data/yang-data-tree-ri/src/main/java/org/opendaylight/yangtools/yang/data/tree/impl/di/InMemoryDataTreeFactory.java

   1 /*
   2  * Copyright (c) 2014 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.yangtools.yang.data.tree.impl.di;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  12 import javax.inject.Inject;
  13 import javax.inject.Singleton;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.kohsuke.MetaInfServices;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  20 import org.opendaylight.yangtools.yang.data.api.schema.DistinctNodeContainer;
  21 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  22 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  23 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  24 import org.opendaylight.yangtools.yang.data.tree.api.DataTree;
  25 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate;
  26 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration;
  27 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeFactory;
  28 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification;
  29 import org.opendaylight.yangtools.yang.data.tree.api.DataValidationFailedException;
  30 import org.opendaylight.yangtools.yang.data.tree.impl.InMemoryDataTree;
  31 import org.opendaylight.yangtools.yang.data.tree.impl.node.TreeNode;
  32 import org.opendaylight.yangtools.yang.data.tree.impl.node.Version;
  33 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
  34 import org.opendaylight.yangtools.yang.model.api.ContainerLike;
  35 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  36 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  37 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  38 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  39 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  40 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  41 import org.osgi.service.component.annotations.Activate;
  42 import org.osgi.service.component.annotations.Component;
  43 import org.osgi.service.component.annotations.Deactivate;
  44 import org.osgi.service.component.annotations.RequireServiceComponentRuntime;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 /**
  49  * A factory for creating in-memory data trees.
  50  */
  51 @Singleton
  52 @Component
  53 @MetaInfServices
  54 @RequireServiceComponentRuntime
  55 public final class InMemoryDataTreeFactory implements DataTreeFactory {
  56     private static final Logger LOG = LoggerFactory.getLogger(InMemoryDataTreeFactory.class);
  57     // FIXME: YANGTOOLS-1074: we do not want this name
  58     private static final @NonNull NormalizedNode ROOT_CONTAINER =
  59             ImmutableNodes.containerNode(SchemaContext.NAME);
  60
  61     @Inject
  62     public InMemoryDataTreeFactory() {
  63         // Exposed for DI
  64     }
  65
  66     @Override
  67     public DataTree create(final DataTreeConfiguration treeConfig) {
  68         return new InMemoryDataTree(TreeNode.of(createRoot(treeConfig.getRootPath()),
  69             Version.initial()), treeConfig, null);
  70     }
  71
  72     @Override
  73     public DataTree create(final DataTreeConfiguration treeConfig, final EffectiveModelContext initialSchemaContext) {
  74         return createDataTree(treeConfig, initialSchemaContext, true);
  75     }
  76
  77     @Override
  78     public DataTree create(final DataTreeConfiguration treeConfig, final EffectiveModelContext initialSchemaContext,
  79             final DistinctNodeContainer<?, ?> initialRoot) throws DataValidationFailedException {
  80         final DataTree ret = createDataTree(treeConfig, initialSchemaContext, false);
  81
  82         final DataTreeModification mod = ret.takeSnapshot().newModification();
  83         mod.write(YangInstanceIdentifier.of(), initialRoot);
  84         mod.ready();
  85
  86         ret.validate(mod);
  87         final DataTreeCandidate candidate = ret.prepare(mod);
  88         ret.commit(candidate);
  89         return ret;
  90     }
  91
  92     @Activate
  93     @SuppressWarnings("static-method")
  94     void activate() {
  95         LOG.debug("In-memory Data Tree activated");
  96     }
  97
  98     @Deactivate
  99     @SuppressWarnings("static-method")
 100     void deactivate() {
 101         LOG.debug("In-memory Data Tree deactivated");
 102     }
 103
 104     private static @NonNull DataTree createDataTree(final DataTreeConfiguration treeConfig,
 105             final EffectiveModelContext initialSchemaContext, final boolean maskMandatory) {
 106         final DataSchemaNode rootSchemaNode = getRootSchemaNode(initialSchemaContext, treeConfig.getRootPath());
 107         final NormalizedNode rootDataNode = createRoot((DataNodeContainer)rootSchemaNode,
 108             treeConfig.getRootPath());
 109         return new InMemoryDataTree(TreeNode.of(rootDataNode, Version.initial()), treeConfig,
 110             initialSchemaContext, rootSchemaNode, maskMandatory);
 111     }
 112
 113     private static @NonNull NormalizedNode createRoot(final DataNodeContainer schemaNode,
 114             final YangInstanceIdentifier path) {
 115         if (path.isEmpty()) {
 116             checkArgument(schemaNode instanceof ContainerLike,
 117                 "Conceptual tree root has to be a container, not %s", schemaNode);
 118             return ROOT_CONTAINER;
 119         }
 120
 121         final PathArgument arg = path.getLastPathArgument();
 122         if (schemaNode instanceof ContainerSchemaNode) {
 123             checkArgument(arg instanceof NodeIdentifier, "Mismatched container %s path %s", schemaNode, path);
 124             return Builders.containerBuilder().withNodeIdentifier((NodeIdentifier) arg).build();
 125         } else if (schemaNode instanceof ListSchemaNode) {
 126             // This can either be a top-level list or its individual entry
 127             if (arg instanceof NodeIdentifierWithPredicates) {
 128                 return ImmutableNodes.mapEntryBuilder().withNodeIdentifier((NodeIdentifierWithPredicates) arg).build();
 129             }
 130             checkArgument(arg instanceof NodeIdentifier, "Mismatched list %s path %s", schemaNode, path);
 131             return ImmutableNodes.mapNodeBuilder().withNodeIdentifier((NodeIdentifier) arg).build();
 132         } else {
 133             throw new IllegalArgumentException("Unsupported root schema " + schemaNode);
 134         }
 135     }
 136
 137     private static @NonNull NormalizedNode createRoot(final YangInstanceIdentifier path) {
 138         if (path.isEmpty()) {
 139             return ROOT_CONTAINER;
 140         }
 141
 142         final PathArgument arg = path.getLastPathArgument();
 143         if (arg instanceof NodeIdentifier) {
 144             return Builders.containerBuilder().withNodeIdentifier((NodeIdentifier) arg).build();
 145         }
 146         if (arg instanceof NodeIdentifierWithPredicates) {
 147             return ImmutableNodes.mapEntryBuilder().withNodeIdentifier((NodeIdentifierWithPredicates) arg).build();
 148         }
 149
 150         // FIXME: implement augmentations and leaf-lists
 151         throw new IllegalArgumentException("Unsupported root node " + arg);
 152     }
 153
 154     private static DataSchemaNode getRootSchemaNode(final EffectiveModelContext schemaContext,
 155             final YangInstanceIdentifier rootPath) {
 156         final var contextTree = DataSchemaContextTree.from(schemaContext);
 157         final var rootContextNode = contextTree.childByPath(rootPath);
 158         checkArgument(rootContextNode != null, "Failed to find root %s in schema context", rootPath);
 159
 160         final var rootSchemaNode = rootContextNode.dataSchemaNode();
 161         checkArgument(rootSchemaNode instanceof DataNodeContainer, "Root %s resolves to non-container type %s",
 162             rootPath, rootSchemaNode);
 163         return rootSchemaNode;
 164     }
 165 }