plugins/netconf-server-mdsal/src/main/java/org/opendaylight/netconf/server/mdsal/operations/EditConfig.java

   1 /*
   2  * Copyright (c) 2015 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.netconf.server.mdsal.operations;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import java.util.List;
  13 import java.util.concurrent.ExecutionException;
  14 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  15 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
  16 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteOperations;
  17 import org.opendaylight.netconf.api.DocumentedException;
  18 import org.opendaylight.netconf.api.EffectiveOperation;
  19 import org.opendaylight.netconf.api.xml.XmlElement;
  20 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
  21 import org.opendaylight.netconf.server.mdsal.CurrentSchemaContext;
  22 import org.opendaylight.netconf.server.mdsal.TransactionProvider;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdType;
  24 import org.opendaylight.yangtools.yang.common.ErrorSeverity;
  25 import org.opendaylight.yangtools.yang.common.ErrorTag;
  26 import org.opendaylight.yangtools.yang.common.ErrorType;
  27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  30 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  31 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  32 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  33 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
  34 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37 import org.w3c.dom.Document;
  38 import org.w3c.dom.Element;
  39
  40 public final class EditConfig extends AbstractEdit {
  41     private static final Logger LOG = LoggerFactory.getLogger(EditConfig.class);
  42     private static final String OPERATION_NAME = "edit-config";
  43     private static final String DEFAULT_OPERATION = "default-operation";
  44
  45     private final TransactionProvider transactionProvider;
  46
  47     public EditConfig(final SessionIdType sessionId, final CurrentSchemaContext schemaContext,
  48             final TransactionProvider transactionProvider) {
  49         super(sessionId, schemaContext);
  50         this.transactionProvider = requireNonNull(transactionProvider);
  51     }
  52
  53     @Override
  54     protected String getOperationName() {
  55         return OPERATION_NAME;
  56     }
  57
  58     @Override
  59     protected Element handleWithNoSubsequentOperations(final Document document, final XmlElement operationElement)
  60             throws DocumentedException {
  61         if (Datastore.valueOf(extractTargetElement(operationElement, OPERATION_NAME).getName()) == Datastore.running) {
  62             throw new DocumentedException("edit-config on running datastore is not supported",
  63                     ErrorType.PROTOCOL, ErrorTag.OPERATION_NOT_SUPPORTED, ErrorSeverity.ERROR);
  64         }
  65
  66         final var defaultAction = getDefaultOperation(operationElement);
  67         for (var element : getConfigElement(operationElement).getChildElements()) {
  68             final var writer = new SplittingNormalizedNodeMetadataStreamWriter(defaultAction);
  69             parseIntoNormalizedNode(getSchemaNodeFromNamespace(element.getNamespace(), element), element, writer);
  70             executeOperations(writer.getDataTreeChanges());
  71         }
  72
  73         return document.createElement(XmlNetconfConstants.OK);
  74     }
  75
  76     private void executeOperations(final List<DataTreeChange> changes) throws DocumentedException {
  77         final var rwTx = transactionProvider.getOrCreateTransaction();
  78         final var iterator = changes.listIterator(changes.size());
  79         while (iterator.hasPrevious()) {
  80             executeChange(rwTx, iterator.previous());
  81         }
  82     }
  83
  84     // FIXME: we should have proper ReadWriteOperations
  85     private void executeChange(final DOMDataTreeReadWriteTransaction rwtx, final DataTreeChange change)
  86             throws DocumentedException {
  87         final var path = change.getPath();
  88         final var changeData = change.getChangeRoot();
  89         switch (change.getAction()) {
  90             case NONE:
  91                 return;
  92             case MERGE:
  93                 mergeParentMixin(rwtx, path, changeData);
  94                 rwtx.merge(LogicalDatastoreType.CONFIGURATION, path, changeData);
  95                 break;
  96             case CREATE:
  97                 try {
  98                     // FIXME: synchronous operation: can we get a rwTx.create() with a per-operation result instead?
  99                     if (rwtx.exists(LogicalDatastoreType.CONFIGURATION, path).get()) {
 100                         throw new DocumentedException("Data already exists, cannot execute CREATE operation",
 101                             ErrorType.PROTOCOL, ErrorTag.DATA_EXISTS, ErrorSeverity.ERROR);
 102                     }
 103                     mergeParentMixin(rwtx, path, changeData);
 104                     rwtx.put(LogicalDatastoreType.CONFIGURATION, path, changeData);
 105                 } catch (final InterruptedException | ExecutionException e) {
 106                     LOG.warn("Read from datastore failed when trying to read data for create operation {}", change, e);
 107                 }
 108                 break;
 109             case REPLACE:
 110                 mergeParentMixin(rwtx, path, changeData);
 111                 rwtx.put(LogicalDatastoreType.CONFIGURATION, path, changeData);
 112                 break;
 113             case DELETE:
 114                 try {
 115                     // FIXME: synchronous operation: can we get a rwTx.delete() semantics with a per-operation result
 116                     //        instead?
 117                     if (!rwtx.exists(LogicalDatastoreType.CONFIGURATION, path).get()) {
 118                         throw new DocumentedException("Data is missing, cannot execute DELETE operation",
 119                             ErrorType.PROTOCOL, ErrorTag.DATA_MISSING, ErrorSeverity.ERROR);
 120                     }
 121                     rwtx.delete(LogicalDatastoreType.CONFIGURATION, path);
 122                 } catch (final InterruptedException | ExecutionException e) {
 123                     LOG.warn("Read from datastore failed when trying to read data for delete operation {}", change, e);
 124                 }
 125                 break;
 126             case REMOVE:
 127                 rwtx.delete(LogicalDatastoreType.CONFIGURATION, path);
 128                 break;
 129             default:
 130                 LOG.warn("Unknown/not implemented operation, not executing");
 131         }
 132     }
 133
 134     private void mergeParentMixin(final DOMDataTreeWriteOperations rwtx, final YangInstanceIdentifier path,
 135                                   final NormalizedNode change) {
 136         final var parentNodeYid = path.getParent();
 137         if (change instanceof MapEntryNode) {
 138             final var dataSchemaNode = DataSchemaContextTree.from(schemaContext.getCurrentContext())
 139                 .findChild(parentNodeYid)
 140                 .orElseThrow(() -> new IllegalStateException("Cannot find schema for " + parentNodeYid))
 141                 .getDataSchemaNode();
 142
 143             // we should have the schema node that points to the parent list now, enforce it
 144             if (!(dataSchemaNode instanceof ListSchemaNode listSchemaNode)) {
 145                 throw new IllegalStateException("Schema node is not pointing to a list");
 146             }
 147
 148             // merge empty ordered or unordered map
 149             rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid,
 150                 (listSchemaNode.isUserOrdered() ? Builders.orderedMapBuilder() : Builders.mapBuilder())
 151                     .withNodeIdentifier(new NodeIdentifier(parentNodeYid.getLastPathArgument().getNodeType()))
 152                     .build());
 153         } else if (parentNodeYid.getLastPathArgument() instanceof AugmentationIdentifier augId) {
 154             // merge empty augmentation node
 155             rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid, Builders.augmentationBuilder()
 156                 .withNodeIdentifier(augId)
 157                 .build());
 158         }
 159     }
 160
 161     private static EffectiveOperation getDefaultOperation(final XmlElement operationElement)
 162             throws DocumentedException {
 163         final var elementsByTagName = getElementsByTagName(operationElement, DEFAULT_OPERATION);
 164         return switch (elementsByTagName.getLength()) {
 165             case 0 -> EffectiveOperation.MERGE;
 166             case 1 ->  EffectiveOperation.ofXmlValue(elementsByTagName.item(0).getTextContent());
 167             default -> throw new DocumentedException("Multiple " + DEFAULT_OPERATION + " elements", ErrorType.RPC,
 168                 ErrorTag.UNKNOWN_ATTRIBUTE, ErrorSeverity.ERROR);
 169         };
 170     }
 171 }