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