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 com.google.common.collect.ImmutableMap;
  14 import java.net.URI;
  15 import java.net.URISyntaxException;
  16 import java.util.Collections;
  17 import java.util.List;
  18 import java.util.ListIterator;
  19 import java.util.Map;
  20 import java.util.stream.Collectors;
  21 import org.opendaylight.controller.config.util.xml.DocumentedException;
  22 import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorSeverity;
  23 import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorTag;
  24 import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorType;
  25 import org.opendaylight.controller.config.util.xml.XmlElement;
  26 import org.opendaylight.controller.config.util.xml.XmlUtil;
  27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  28 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  29 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
  30 import org.opendaylight.netconf.api.NetconfDocumentedException;
  31 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
  32 import org.opendaylight.netconf.mdsal.connector.CurrentSchemaContext;
  33 import org.opendaylight.netconf.mdsal.connector.TransactionProvider;
  34 import org.opendaylight.netconf.mdsal.connector.ops.DataTreeChangeTracker.DataTreeChange;
  35 import org.opendaylight.netconf.util.mapping.AbstractSingletonNetconfOperation;
  36 import org.opendaylight.yangtools.yang.common.QName;
  37 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  39 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.DomUtils;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
  46 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  47 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  48 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  49 import org.opendaylight.yangtools.yang.model.api.Module;
  50 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  51 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54 import org.w3c.dom.Document;
  55 import org.w3c.dom.Element;
  56 import org.w3c.dom.NodeList;
  57
  58 public class EditConfig extends AbstractSingletonNetconfOperation {
  59
  60     private static final Logger LOG = LoggerFactory.getLogger(EditConfig.class);
  61
  62     private static final String OPERATION_NAME = "edit-config";
  63     private static final String CONFIG_KEY = "config";
  64     private static final String TARGET_KEY = "target";
  65     private static final String DEFAULT_OPERATION_KEY = "default-operation";
  66     private final CurrentSchemaContext schemaContext;
  67     private final TransactionProvider transactionProvider;
  68
  69     public EditConfig(final String netconfSessionIdForReporting, final CurrentSchemaContext schemaContext,
  70             final TransactionProvider transactionProvider) {
  71         super(netconfSessionIdForReporting);
  72         this.schemaContext = schemaContext;
  73         this.transactionProvider = transactionProvider;
  74     }
  75
  76     @Override
  77     protected Element handleWithNoSubsequentOperations(final Document document, final XmlElement operationElement)
  78             throws DocumentedException {
  79         final Datastore targetDatastore = extractTargetParameter(operationElement);
  80         if (targetDatastore == Datastore.running) {
  81             throw new DocumentedException("edit-config on running datastore is not supported",
  82                     ErrorType.PROTOCOL,
  83                     ErrorTag.OPERATION_NOT_SUPPORTED,
  84                     ErrorSeverity.ERROR);
  85         }
  86
  87         final ModifyAction defaultAction = getDefaultOperation(operationElement);
  88
  89         final XmlElement configElement = getElement(operationElement, CONFIG_KEY);
  90
  91         for (final XmlElement element : configElement.getChildElements()) {
  92             final String ns = element.getNamespace();
  93             final DataSchemaNode schemaNode = getSchemaNodeFromNamespace(ns, element).get();
  94
  95             final DataTreeChangeTracker changeTracker = new DataTreeChangeTracker(defaultAction);
  96             final DomToNormalizedNodeParserFactory.BuildingStrategyProvider editOperationStrategyProvider =
  97                     new EditOperationStrategyProvider(changeTracker);
  98
  99             parseIntoNormalizedNode(schemaNode, element, editOperationStrategyProvider);
 100             executeOperations(changeTracker);
 101         }
 102
 103         return XmlUtil.createElement(document, XmlNetconfConstants.OK, Optional.absent());
 104     }
 105
 106     private void executeOperations(final DataTreeChangeTracker changeTracker) throws DocumentedException {
 107         final DOMDataReadWriteTransaction rwTx = transactionProvider.getOrCreateTransaction();
 108         final List<DataTreeChange> aa = changeTracker.getDataTreeChanges();
 109         final ListIterator<DataTreeChange> iterator = aa.listIterator(aa.size());
 110
 111         while (iterator.hasPrevious()) {
 112             final DataTreeChange dtc = iterator.previous();
 113             executeChange(rwTx, dtc);
 114         }
 115     }
 116
 117     private void executeChange(final DOMDataReadWriteTransaction rwtx, final DataTreeChange change)
 118             throws DocumentedException {
 119         final YangInstanceIdentifier path = YangInstanceIdentifier.create(change.getPath());
 120         final NormalizedNode<?, ?> changeData = change.getChangeRoot();
 121         switch (change.getAction()) {
 122         case NONE:
 123             return;
 124         case MERGE:
 125             mergeParentMixin(rwtx, path, changeData);
 126             rwtx.merge(LogicalDatastoreType.CONFIGURATION, path, changeData);
 127             break;
 128         case CREATE:
 129             try {
 130                 final Optional<NormalizedNode<?, ?>> readResult = rwtx.read(LogicalDatastoreType.CONFIGURATION, path).checkedGet();
 131                 if (readResult.isPresent()) {
 132                     throw new DocumentedException("Data already exists, cannot execute CREATE operation",
 133                         ErrorType.PROTOCOL, ErrorTag.DATA_EXISTS, ErrorSeverity.ERROR);
 134                 }
 135                 mergeParentMixin(rwtx, path, changeData);
 136                 rwtx.put(LogicalDatastoreType.CONFIGURATION, path, changeData);
 137             } catch (final ReadFailedException e) {
 138                 LOG.warn("Read from datastore failed when trying to read data for create operation", change, e);
 139             }
 140             break;
 141         case REPLACE:
 142             mergeParentMixin(rwtx, path, changeData);
 143             rwtx.put(LogicalDatastoreType.CONFIGURATION, path, changeData);
 144             break;
 145         case DELETE:
 146             try {
 147                 final Optional<NormalizedNode<?, ?>> readResult = rwtx.read(LogicalDatastoreType.CONFIGURATION, path).checkedGet();
 148                 if (!readResult.isPresent()) {
 149                     throw new DocumentedException("Data is missing, cannot execute DELETE operation",
 150                         ErrorType.PROTOCOL, ErrorTag.DATA_MISSING, ErrorSeverity.ERROR);
 151                 }
 152                 rwtx.delete(LogicalDatastoreType.CONFIGURATION, path);
 153             } catch (final ReadFailedException e) {
 154                 LOG.warn("Read from datastore failed when trying to read data for delete operation", change, e);
 155             }
 156             break;
 157         case REMOVE:
 158             rwtx.delete(LogicalDatastoreType.CONFIGURATION, path);
 159             break;
 160         default:
 161             LOG.warn("Unknown/not implemented operation, not executing");
 162         }
 163     }
 164
 165     private void mergeParentMixin(final DOMDataReadWriteTransaction rwtx, final YangInstanceIdentifier path,
 166                                 final NormalizedNode change) {
 167         final YangInstanceIdentifier parentNodeYid = path.getParent();
 168         if (change instanceof MapEntryNode) {
 169             final SchemaNode schemaNode = SchemaContextUtil.findNodeInSchemaContext(
 170                     schemaContext.getCurrentContext(),
 171                     parentNodeYid.getPathArguments().stream()
 172                             // filter out identifiers not present in the schema tree
 173                             .filter(arg -> !(arg instanceof YangInstanceIdentifier.NodeIdentifierWithPredicates))
 174                             .filter(arg -> !(arg instanceof YangInstanceIdentifier.AugmentationIdentifier))
 175                             .map(YangInstanceIdentifier.PathArgument::getNodeType).collect(Collectors.toList()));
 176
 177             // we should have the schema node that points to the parent list now, enforce it
 178             Preconditions.checkState(schemaNode instanceof ListSchemaNode, "Schema node is not pointing to a list.");
 179
 180             //merge empty ordered or unordered map
 181             if (((ListSchemaNode) schemaNode).isUserOrdered()) {
 182                 final MapNode mixinNode = Builders.orderedMapBuilder()
 183                         .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(parentNodeYid.getLastPathArgument().getNodeType()))
 184                         .build();
 185                 rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid, mixinNode);
 186                 return;
 187             }
 188
 189             final MapNode mixinNode = Builders.mapBuilder()
 190                     .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(parentNodeYid.getLastPathArgument().getNodeType()))
 191                     .build();
 192             rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid, mixinNode);
 193         } else if (parentNodeYid.getLastPathArgument() instanceof YangInstanceIdentifier.AugmentationIdentifier) {
 194             // merge empty augmentation node
 195             final YangInstanceIdentifier.AugmentationIdentifier augmentationYid =
 196                 (YangInstanceIdentifier.AugmentationIdentifier) parentNodeYid.getLastPathArgument();
 197             final AugmentationNode augmentationNode = Builders.augmentationBuilder()
 198                 .withNodeIdentifier(augmentationYid).build();
 199             rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid, augmentationNode);
 200         }
 201     }
 202
 203     private NormalizedNode<?, ?> parseIntoNormalizedNode(final DataSchemaNode schemaNode, final XmlElement element,
 204             final DomToNormalizedNodeParserFactory.BuildingStrategyProvider editOperationStrategyProvider) {
 205         if (schemaNode instanceof ContainerSchemaNode) {
 206             return DomToNormalizedNodeParserFactory
 207                     .getInstance(DomUtils.defaultValueCodecProvider(), schemaContext.getCurrentContext(), editOperationStrategyProvider)
 208                     .getContainerNodeParser()
 209                     .parse(Collections.singletonList(element.getDomElement()), (ContainerSchemaNode) schemaNode);
 210         } else if (schemaNode instanceof ListSchemaNode) {
 211             return DomToNormalizedNodeParserFactory
 212                     .getInstance(DomUtils.defaultValueCodecProvider(), schemaContext.getCurrentContext(), editOperationStrategyProvider)
 213                     .getMapNodeParser()
 214                     .parse(Collections.singletonList(element.getDomElement()), (ListSchemaNode) schemaNode);
 215         } else {
 216             //this should never happen since edit-config on any other node type should not be possible nor makes sense
 217             LOG.debug("DataNode from module is not ContainerSchemaNode nor ListSchemaNode, aborting..");
 218         }
 219         throw new UnsupportedOperationException("implement exception if parse fails");
 220     }
 221
 222     private Optional<DataSchemaNode> getSchemaNodeFromNamespace(final String namespace, final XmlElement element)
 223             throws DocumentedException {
 224         Optional<DataSchemaNode> dataSchemaNode = Optional.absent();
 225         try {
 226             // returns module with newest revision since findModuleByNamespace returns a set of modules and we only
 227             // need the newest one
 228             final Module module = schemaContext.getCurrentContext().findModuleByNamespaceAndRevision(new URI(namespace), null);
 229             if (module == null) {
 230                 // no module is present with this namespace
 231                 throw new NetconfDocumentedException("Unable to find module by namespace: " + namespace,
 232                         ErrorType.APPLICATION, ErrorTag.UNKNOWN_NAMESPACE, ErrorSeverity.ERROR);
 233             }
 234             final DataSchemaNode schemaNode =
 235                     module.getDataChildByName(QName.create(module.getQNameModule(), element.getName()));
 236             if (schemaNode != null) {
 237                 dataSchemaNode = Optional.of(schemaNode);
 238             } else {
 239                 throw new DocumentedException("Unable to find node with namespace: " + namespace + "in module: " + module.toString(),
 240                         ErrorType.APPLICATION,
 241                         ErrorTag.UNKNOWN_NAMESPACE,
 242                         ErrorSeverity.ERROR);
 243             }
 244         } catch (final URISyntaxException e) {
 245             LOG.debug("Unable to create URI for namespace : {}", namespace);
 246         }
 247
 248         return dataSchemaNode;
 249     }
 250
 251     private static Datastore extractTargetParameter(final XmlElement operationElement) throws DocumentedException {
 252         final NodeList elementsByTagName = operationElement.getDomElement().getElementsByTagName(TARGET_KEY);
 253         // Direct lookup instead of using XmlElement class due to performance
 254         if (elementsByTagName.getLength() == 0) {
 255             final Map<String, String> errorInfo = ImmutableMap.of("bad-attribute", TARGET_KEY, "bad-element",
 256                 OPERATION_NAME);
 257             throw new DocumentedException("Missing target element", ErrorType.PROTOCOL, ErrorTag.MISSING_ATTRIBUTE,
 258                 ErrorSeverity.ERROR, errorInfo);
 259         } else if (elementsByTagName.getLength() > 1) {
 260             throw new DocumentedException("Multiple target elements", ErrorType.RPC, ErrorTag.UNKNOWN_ATTRIBUTE,
 261                 ErrorSeverity.ERROR);
 262         } else {
 263             final XmlElement targetChildNode = XmlElement.fromDomElement((Element) elementsByTagName.item(0)).getOnlyChildElement();
 264             return Datastore.valueOf(targetChildNode.getName());
 265         }
 266     }
 267
 268     private static ModifyAction getDefaultOperation(final XmlElement operationElement) throws DocumentedException {
 269         final NodeList elementsByTagName = operationElement.getDomElement().getElementsByTagName(DEFAULT_OPERATION_KEY);
 270         if (elementsByTagName.getLength() == 0) {
 271             return ModifyAction.MERGE;
 272         } else if (elementsByTagName.getLength() > 1) {
 273             throw new DocumentedException("Multiple " + DEFAULT_OPERATION_KEY + " elements", ErrorType.RPC,
 274                 ErrorTag.UNKNOWN_ATTRIBUTE, ErrorSeverity.ERROR);
 275         } else {
 276             return ModifyAction.fromXmlValue(elementsByTagName.item(0).getTextContent());
 277         }
 278
 279     }
 280
 281     private static XmlElement getElement(final XmlElement operationElement, final String elementName)
 282             throws DocumentedException {
 283         final Optional<XmlElement> childNode = operationElement.getOnlyChildElementOptionally(elementName);
 284         if (!childNode.isPresent()) {
 285             throw new DocumentedException(elementName + " element is missing",
 286                     ErrorType.PROTOCOL,
 287                     ErrorTag.MISSING_ELEMENT,
 288                     ErrorSeverity.ERROR);
 289         }
 290
 291         return childNode.get();
 292     }
 293
 294     @Override
 295     protected String getOperationName() {
 296         return OPERATION_NAME;
 297     }
 298
 299 }