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