Initial code drop of netconf protocol implementation

[controller.git] / opendaylight / netconf / config-netconf-connector / src / main / java / org / opendaylight / controller / netconf / confignetconfconnector / operations / Validate.java

diff --git a/opendaylight/netconf/config-netconf-connector/src/main/java/org/opendaylight/controller/netconf/confignetconfconnector/operations/Validate.java b/opendaylight/netconf/config-netconf-connector/src/main/java/org/opendaylight/controller/netconf/confignetconfconnector/operations/Validate.java
new file mode 100644 (file)
index 0000000..b8cae43
--- /dev/null
+++ b/opendaylight/netconf/config-netconf-connector/src/main/java/org/opendaylight/controller/netconf/confignetconfconnector/operations/Validate.java
@@ -0,0 +1,105 @@
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
+package org.opendaylight.controller.netconf.confignetconfconnector.operations;
+
+import com.google.common.base.Preconditions;
+import org.opendaylight.controller.config.api.ValidationException;
+import org.opendaylight.controller.config.util.ConfigRegistryClient;
+import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
+import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorSeverity;
+import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorTag;
+import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorType;
+import org.opendaylight.controller.netconf.confignetconfconnector.transactions.TransactionProvider;
+import org.opendaylight.controller.netconf.util.xml.XmlElement;
+import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class Validate extends AbstractConfigNetconfOperation {
+
+    public static final String VALIDATE = "validate";
+
+    private static final Logger logger = LoggerFactory.getLogger(Validate.class);
+
+    private final TransactionProvider transactionProvider;
+
+    public Validate(final TransactionProvider transactionProvider, ConfigRegistryClient configRegistryClient,
+            String netconfSessionIdForReporting) {
+        super(configRegistryClient, netconfSessionIdForReporting);
+        this.transactionProvider = transactionProvider;
+    }
+
+    private void checkXml(XmlElement xml) {
+        xml.checkName(VALIDATE);
+        xml.checkNamespace(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0);
+
+        XmlElement sourceElement = xml.getOnlyChildElement(XmlNetconfConstants.SOURCE_KEY,
+                XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0);
+        XmlElement sourceChildNode = sourceElement.getOnlyChildElement();
+
+        sourceChildNode.checkNamespace(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0);
+        String datastoreValue = sourceChildNode.getName();
+        Datastore sourceDatastore = Datastore.valueOf(datastoreValue);
+
+        Preconditions.checkState(sourceDatastore == Datastore.candidate, "Only " + Datastore.candidate
+                + " is supported as source for " + VALIDATE + " but was " + datastoreValue);
+    }
+
+    @Override
+    protected String getOperationName() {
+        return VALIDATE;
+    }
+
+    @Override
+    protected Element handle(Document document, XmlElement xml) throws NetconfDocumentedException {
+        try {
+            checkXml(xml);
+        } catch (IllegalStateException e) {
+            logger.warn("Rpc error: {}", ErrorTag.missing_attribute, e);
+            final Map<String, String> errorInfo = new HashMap<>();
+            errorInfo.put(ErrorTag.missing_attribute.name(), "Missing value of datastore attribute");
+            throw new NetconfDocumentedException(e.getMessage(), e, ErrorType.rpc, ErrorTag.missing_attribute,
+                    ErrorSeverity.error, errorInfo);
+        } catch (final IllegalArgumentException e) {
+            logger.warn("Rpc error: {}", ErrorTag.bad_attribute, e);
+            final Map<String, String> errorInfo = new HashMap<>();
+            errorInfo.put(ErrorTag.bad_attribute.name(), e.getMessage());
+            throw new NetconfDocumentedException(e.getMessage(), e, ErrorType.rpc, ErrorTag.bad_attribute,
+                    ErrorSeverity.error, errorInfo);
+        }
+
+        try {
+            transactionProvider.validateTransaction();
+        } catch (ValidationException e) {
+            logger.warn("Validation failed", e);
+            final Map<String, String> errorInfo = new HashMap<>();
+            errorInfo.put(ErrorTag.operation_failed.name(), "Validation failed");
+            throw new NetconfDocumentedException(e.getMessage(), e, ErrorType.application, ErrorTag.operation_failed,
+                    ErrorSeverity.error, errorInfo);
+        } catch (IllegalStateException e) {
+            logger.warn("Validation failed", e);
+            final Map<String, String> errorInfo = new HashMap<>();
+            errorInfo
+                    .put(ErrorTag.operation_failed.name(),
+                            "Datastore is not present. Use 'get-config' or 'edit-config' before triggering 'operations' operation");
+            throw new NetconfDocumentedException(e.getMessage(), e, ErrorType.application, ErrorTag.operation_failed,
+                    ErrorSeverity.error, errorInfo);
+
+        }
+
+        logger.info("Datastore {} validated successfully", Datastore.candidate);
+
+        return document.createElement(XmlNetconfConstants.OK);
+    }
+}