git.opendaylight Code Review - netconf.git/blob

   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.rests.services.impl;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.ImmutableSet;
  13 import java.util.ArrayList;
  14 import java.util.Collection;
  15 import java.util.Map;
  16 import java.util.Map.Entry;
  17 import java.util.Optional;
  18 import javax.ws.rs.Path;
  19 import javax.ws.rs.core.UriInfo;
  20 import org.eclipse.jdt.annotation.NonNull;
  21 import org.eclipse.jdt.annotation.Nullable;
  22 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  23 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  24 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  25 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  26 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  27 import org.opendaylight.restconf.nb.rfc8040.databind.DatabindProvider;
  28 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  29 import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfOperationsService;
  30 import org.opendaylight.restconf.nb.rfc8040.utils.RestconfConstants;
  31 import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier;
  32 import org.opendaylight.yangtools.yang.common.Empty;
  33 import org.opendaylight.yangtools.yang.common.ErrorTag;
  34 import org.opendaylight.yangtools.yang.common.ErrorType;
  35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  36 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  37 import org.opendaylight.yangtools.yang.data.api.schema.builder.DataContainerNodeBuilder;
  38 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  39 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  40 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  41 import org.opendaylight.yangtools.yang.model.api.Module;
  42 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  43 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46
  47 /**
  48  * Implementation of {@link RestconfOperationsService}.
  49  */
  50 @Path("/")
  51 public class RestconfOperationsServiceImpl implements RestconfOperationsService {
  52     private static final Logger LOG = LoggerFactory.getLogger(RestconfOperationsServiceImpl.class);
  53
  54     private final DatabindProvider databindProvider;
  55     private final DOMMountPointService mountPointService;
  56
  57     /**
  58      * Set {@link DatabindProvider} for getting actual {@link EffectiveModelContext}.
  59      *
  60      * @param databindProvider a {@link DatabindProvider}
  61      * @param mountPointService a {@link DOMMountPointService}
  62      */
  63     public RestconfOperationsServiceImpl(final DatabindProvider databindProvider,
  64             final DOMMountPointService mountPointService) {
  65         this.databindProvider = requireNonNull(databindProvider);
  66         this.mountPointService = requireNonNull(mountPointService);
  67     }
  68
  69     @Override
  70     public String getOperationsJSON() {
  71         return OperationsContent.JSON.bodyFor(databindProvider.currentContext().modelContext());
  72     }
  73
  74     @Override
  75     public String getOperationsXML() {
  76         return OperationsContent.XML.bodyFor(databindProvider.currentContext().modelContext());
  77     }
  78
  79     @Override
  80     public NormalizedNodePayload getOperations(final String identifier, final UriInfo uriInfo) {
  81         if (!identifier.contains(RestconfConstants.MOUNT)) {
  82             final var errMsg = """
  83                     URI has bad format. If operations behind mount point should be showed, URI has to end with %s.
  84                     """.formatted(RestconfConstants.MOUNT);
  85             LOG.debug("{} for {}", errMsg, identifier);
  86             throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
  87         }
  88
  89         final InstanceIdentifierContext mountPointIdentifier = ParserIdentifier.toInstanceIdentifier(identifier,
  90             databindProvider.currentContext().modelContext(), Optional.of(mountPointService));
  91         final DOMMountPoint mountPoint = mountPointIdentifier.getMountPoint();
  92         final var entry = contextForModelContext(modelContext(mountPoint), mountPoint);
  93         return NormalizedNodePayload.of(entry.getKey(), entry.getValue());
  94     }
  95
  96     private static EffectiveModelContext modelContext(final DOMMountPoint mountPoint) {
  97         return mountPoint.getService(DOMSchemaService.class)
  98             .flatMap(svc -> Optional.ofNullable(svc.getGlobalContext()))
  99             .orElse(null);
 100     }
 101
 102     // FIXME: remove this method and everything it uses
 103     @Deprecated(forRemoval = true, since = "4.0.0")
 104     private static @NonNull Entry<InstanceIdentifierContext, ContainerNode> contextForModelContext(
 105             final @NonNull EffectiveModelContext context, final @Nullable DOMMountPoint mountPoint) {
 106         // Determine which modules we need and construct leaf schemas to correspond to all RPC definitions
 107         final Collection<Module> modules = new ArrayList<>();
 108         final ArrayList<OperationsLeafSchemaNode> rpcLeafSchemas = new ArrayList<>();
 109         for (final Module m : context.getModules()) {
 110             final Collection<? extends RpcDefinition> rpcs = m.getRpcs();
 111             if (!rpcs.isEmpty()) {
 112                 modules.add(new OperationsImportedModule(m));
 113                 rpcLeafSchemas.ensureCapacity(rpcLeafSchemas.size() + rpcs.size());
 114                 for (RpcDefinition rpc : rpcs) {
 115                     rpcLeafSchemas.add(new OperationsLeafSchemaNode(rpc));
 116                 }
 117             }
 118         }
 119
 120         // Now generate a module for RESTCONF so that operations contain what they need
 121         final OperationsContainerSchemaNode operatationsSchema = new OperationsContainerSchemaNode(rpcLeafSchemas);
 122         modules.add(new OperationsRestconfModule(operatationsSchema));
 123
 124         // Now build the operations container and combine it with the context
 125         final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> operationsBuilder = Builders.containerBuilder()
 126                 .withNodeIdentifier(new NodeIdentifier(OperationsContainerSchemaNode.QNAME));
 127         for (final OperationsLeafSchemaNode leaf : rpcLeafSchemas) {
 128             operationsBuilder.withChild(ImmutableNodes.leafNode(leaf.getQName(), Empty.value()));
 129         }
 130
 131         final var opContext = new OperationsEffectiveModuleContext(ImmutableSet.copyOf(modules));
 132         final var stack = SchemaInferenceStack.of(opContext);
 133         stack.enterSchemaTree(operatationsSchema.getQName());
 134
 135         return Map.entry(InstanceIdentifierContext.ofStack(stack, mountPoint), operationsBuilder.build());
 136     }
 137
 138 }