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