restconf/restconf-common/src/main/java/org/opendaylight/restconf/common/util/OperationsResourceUtils.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.common.util;
   9
  10 import com.google.common.collect.ImmutableSet;
  11 import java.util.ArrayList;
  12 import java.util.Collection;
  13 import java.util.Map;
  14 import java.util.Map.Entry;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.eclipse.jdt.annotation.Nullable;
  17 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  18 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  19 import org.opendaylight.yangtools.yang.common.Empty;
  20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  21 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  22 import org.opendaylight.yangtools.yang.data.api.schema.builder.DataContainerNodeBuilder;
  23 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  24 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  25 import org.opendaylight.yangtools.yang.model.api.Module;
  26 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  27 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  28 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  29
  30
  31 // FIXME: remove this class
  32 public final class OperationsResourceUtils {
  33     private OperationsResourceUtils() {
  34         // Hidden on purpose
  35     }
  36
  37     public static @NonNull Entry<InstanceIdentifierContext, ContainerNode>
  38                 contextForModelContext(final @NonNull SchemaContext context, final @Nullable DOMMountPoint mountPoint) {
  39         // Determine which modules we need and construct leaf schemas to correspond to all RPC definitions
  40         final Collection<Module> modules = new ArrayList<>();
  41         final ArrayList<OperationsLeafSchemaNode> rpcLeafSchemas = new ArrayList<>();
  42         for (final Module m : context.getModules()) {
  43             final Collection<? extends RpcDefinition> rpcs = m.getRpcs();
  44             if (!rpcs.isEmpty()) {
  45                 modules.add(new OperationsImportedModule(m));
  46                 rpcLeafSchemas.ensureCapacity(rpcLeafSchemas.size() + rpcs.size());
  47                 for (RpcDefinition rpc : rpcs) {
  48                     rpcLeafSchemas.add(new OperationsLeafSchemaNode(rpc));
  49                 }
  50             }
  51         }
  52
  53         // Now generate a module for RESTCONF so that operations contain what they need
  54         final OperationsContainerSchemaNode operatationsSchema = new OperationsContainerSchemaNode(rpcLeafSchemas);
  55         modules.add(new OperationsRestconfModule(operatationsSchema));
  56
  57         // Now build the operations container and combine it with the context
  58         final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> operationsBuilder = Builders.containerBuilder()
  59                 .withNodeIdentifier(new NodeIdentifier(OperationsContainerSchemaNode.QNAME));
  60         for (final OperationsLeafSchemaNode leaf : rpcLeafSchemas) {
  61             operationsBuilder.withChild(ImmutableNodes.leafNode(leaf.getQName(), Empty.value()));
  62         }
  63
  64         final var opContext = new OperationsEffectiveModuleContext(ImmutableSet.copyOf(modules));
  65         final var stack = SchemaInferenceStack.of(opContext);
  66         stack.enterSchemaTree(operatationsSchema.getQName());
  67
  68         return Map.entry(InstanceIdentifierContext.ofStack(stack, mountPoint), operationsBuilder.build());
  69     }
  70 }