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