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