netconf/mdsal-netconf-connector/src/main/java/org/opendaylight/netconf/mdsal/connector/ops/get/GetConfig.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.get;
   9
  10 import java.util.Optional;
  11 import java.util.concurrent.ExecutionException;
  12 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  13 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
  14 import org.opendaylight.netconf.api.DocumentedException;
  15 import org.opendaylight.netconf.api.xml.XmlElement;
  16 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
  17 import org.opendaylight.netconf.mdsal.connector.CurrentSchemaContext;
  18 import org.opendaylight.netconf.mdsal.connector.TransactionProvider;
  19 import org.opendaylight.netconf.mdsal.connector.ops.Datastore;
  20 import org.opendaylight.yangtools.yang.common.ErrorSeverity;
  21 import org.opendaylight.yangtools.yang.common.ErrorTag;
  22 import org.opendaylight.yangtools.yang.common.ErrorType;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  24 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27 import org.w3c.dom.Document;
  28 import org.w3c.dom.Element;
  29
  30 public class GetConfig extends AbstractGet {
  31     private static final Logger LOG = LoggerFactory.getLogger(GetConfig.class);
  32     private static final String OPERATION_NAME = "get-config";
  33
  34     private final TransactionProvider transactionProvider;
  35
  36     public GetConfig(final String netconfSessionIdForReporting, final CurrentSchemaContext schemaContext,
  37                      final TransactionProvider transactionProvider) {
  38         super(netconfSessionIdForReporting, schemaContext);
  39         this.transactionProvider = transactionProvider;
  40     }
  41
  42     @Override
  43     protected Element handleWithNoSubsequentOperations(final Document document, final XmlElement operationElement)
  44             throws DocumentedException {
  45         GetConfigExecution getConfigExecution = null;
  46         try {
  47             getConfigExecution = GetConfigExecution.fromXml(operationElement, OPERATION_NAME);
  48
  49         } catch (final DocumentedException e) {
  50             LOG.warn("Get request processing failed on session: {}", getNetconfSessionIdForReporting(), e);
  51             throw e;
  52         }
  53
  54         final Optional<YangInstanceIdentifier> dataRootOptional = getDataRootFromFilter(operationElement);
  55         if (dataRootOptional.isEmpty()) {
  56             return document.createElement(XmlNetconfConstants.DATA_KEY);
  57         }
  58
  59         final YangInstanceIdentifier dataRoot = dataRootOptional.orElseThrow();
  60
  61         // FIXME: Proper exception should be thrown
  62         final var datastore = getConfigExecution.getDatastore()
  63             .orElseThrow(() -> new IllegalStateException("Source element missing from request"));
  64
  65         final DOMDataTreeReadWriteTransaction rwTx = getTransaction(datastore);
  66         try {
  67             final Optional<NormalizedNode> normalizedNodeOptional = rwTx.read(
  68                     LogicalDatastoreType.CONFIGURATION, dataRoot).get();
  69             if (datastore == Datastore.running) {
  70                 transactionProvider.abortRunningTransaction(rwTx);
  71             }
  72
  73             if (normalizedNodeOptional.isEmpty()) {
  74                 return document.createElement(XmlNetconfConstants.DATA_KEY);
  75             }
  76
  77             return serializeNodeWithParentStructure(document, dataRoot, normalizedNodeOptional.orElseThrow());
  78         } catch (final InterruptedException | ExecutionException e) {
  79             LOG.warn("Unable to read data: {}", dataRoot, e);
  80             throw new IllegalStateException("Unable to read data " + dataRoot, e);
  81         }
  82     }
  83
  84     private DOMDataTreeReadWriteTransaction getTransaction(final Datastore datastore) throws DocumentedException {
  85         if (datastore == Datastore.candidate) {
  86             return transactionProvider.getOrCreateTransaction();
  87         } else if (datastore == Datastore.running) {
  88             return transactionProvider.createRunningTransaction();
  89         }
  90         throw new DocumentedException("Incorrect Datastore: ", ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT,
  91                 ErrorSeverity.ERROR);
  92     }
  93
  94     @Override
  95     protected String getOperationName() {
  96         return OPERATION_NAME;
  97     }
  98 }