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