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