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