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