/* * 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.editconfig; import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Optional; import com.google.common.collect.Multimap; import java.util.Arrays; import java.util.Map; import org.opendaylight.controller.config.api.ServiceReferenceReadableRegistry; import org.opendaylight.controller.netconf.api.NetconfDocumentedException; import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.Config; import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleElementDefinition; import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleElementResolved; import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ServiceRegistryWrapper; import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.Services; import org.opendaylight.controller.netconf.confignetconfconnector.operations.Datastore; import org.opendaylight.controller.netconf.util.exception.MissingNameSpaceException; import org.opendaylight.controller.netconf.util.exception.UnexpectedNamespaceException; import org.opendaylight.controller.netconf.util.xml.XmlElement; import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class EditConfigXmlParser { private static final Logger logger = LoggerFactory.getLogger(EditConfigXmlParser.class); public static final String EDIT_CONFIG = "edit-config"; public static final String DEFAULT_OPERATION_KEY = "default-operation"; static final String ERROR_OPTION_KEY = "error-option"; static final String DEFAULT_ERROR_OPTION = "stop-on-error"; static final String TARGET_KEY = "target"; static final String TEST_OPTION_KEY = "test-option"; public EditConfigXmlParser() { } EditConfigXmlParser.EditConfigExecution fromXml(final XmlElement xml, final Config cfgMapping) throws NetconfDocumentedException { //TODO remove transactionProvider and CfgRegistry from parameters, accept only service ref store EditStrategyType editStrategyType = EditStrategyType.getDefaultStrategy(); xml.checkName(EditConfigXmlParser.EDIT_CONFIG); xml.checkNamespace(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0); XmlElement targetElement = null; XmlElement targetChildNode = null; try { targetElement = xml.getOnlyChildElementWithSameNamespace(EditConfigXmlParser.TARGET_KEY); targetChildNode = targetElement.getOnlyChildElementWithSameNamespace(); } catch (final MissingNameSpaceException | UnexpectedNamespaceException e) { logger.trace("Can't get only child element with same namespace due to {}",e); throw NetconfDocumentedException.wrap(e); } String datastoreValue = targetChildNode.getName(); Datastore targetDatastore = Datastore.valueOf(datastoreValue); logger.debug("Setting {} to '{}'", EditConfigXmlParser.TARGET_KEY, targetDatastore); // check target if (targetDatastore != Datastore.candidate){ throw new NetconfDocumentedException(String.format( "Only %s datastore supported for edit config but was: %s", Datastore.candidate, targetDatastore), NetconfDocumentedException.ErrorType.application, NetconfDocumentedException.ErrorTag.invalid_value, NetconfDocumentedException.ErrorSeverity.error); } // Test option TestOption testOption; Optional testOptionElementOpt = xml .getOnlyChildElementWithSameNamespaceOptionally(EditConfigXmlParser.TEST_OPTION_KEY); if (testOptionElementOpt.isPresent()) { String testOptionValue = testOptionElementOpt.get().getTextContent(); testOption = EditConfigXmlParser.TestOption.getFromXmlName(testOptionValue); } else { testOption = EditConfigXmlParser.TestOption.getDefault(); } logger.debug("Setting {} to '{}'", EditConfigXmlParser.TEST_OPTION_KEY, testOption); // Error option Optional errorOptionElement = xml .getOnlyChildElementWithSameNamespaceOptionally(EditConfigXmlParser.ERROR_OPTION_KEY); if (errorOptionElement.isPresent()) { String errorOptionParsed = errorOptionElement.get().getTextContent(); if (!errorOptionParsed.equals(EditConfigXmlParser.DEFAULT_ERROR_OPTION)){ throw new UnsupportedOperationException("Only " + EditConfigXmlParser.DEFAULT_ERROR_OPTION + " supported for " + EditConfigXmlParser.ERROR_OPTION_KEY + ", was " + errorOptionParsed); } } // Default op Optional defaultContent = xml .getOnlyChildElementWithSameNamespaceOptionally(EditConfigXmlParser.DEFAULT_OPERATION_KEY); if (defaultContent.isPresent()) { String mergeStrategyString = defaultContent.get().getTextContent(); logger.trace("Setting merge strategy to {}", mergeStrategyString); editStrategyType = EditStrategyType.valueOf(mergeStrategyString); } XmlElement configElement = null; try { configElement = xml.getOnlyChildElementWithSameNamespace(XmlNetconfConstants.CONFIG_KEY); } catch (MissingNameSpaceException e) { logger.trace("Can't get only child element with same namespace due to {}",e); throw NetconfDocumentedException.wrap(e); } return new EditConfigXmlParser.EditConfigExecution(cfgMapping, configElement, testOption, editStrategyType); } @VisibleForTesting static enum TestOption { testOnly, set, testThenSet; static TestOption getFromXmlName(String testOptionXmlName) { switch (testOptionXmlName) { case "test-only": return testOnly; case "test-then-set": return testThenSet; case "set": return set; default: throw new IllegalArgumentException("Unsupported test option " + testOptionXmlName + " supported: " + Arrays.toString(TestOption.values())); } } public static TestOption getDefault() { return testThenSet; } } @VisibleForTesting static class EditConfigExecution { private final TestOption testOption; private final EditStrategyType defaultEditStrategyType; private final Services services; private final Config configResolver; private final XmlElement configElement; EditConfigExecution(Config configResolver, XmlElement configElement, TestOption testOption, EditStrategyType defaultStrategy) throws NetconfDocumentedException { Config.checkUnrecognisedChildren(configElement); this.configResolver = configResolver; this.configElement = configElement; this.services = configResolver.fromXmlServices(configElement); this.testOption = testOption; this.defaultEditStrategyType = defaultStrategy; } boolean shouldTest() { return testOption == TestOption.testOnly || testOption == TestOption.testThenSet; } boolean shouldSet() { return testOption == TestOption.set || testOption == TestOption.testThenSet; } Map> getResolvedXmlElements(ServiceReferenceReadableRegistry serviceRegistry) throws NetconfDocumentedException { return configResolver.fromXmlModulesResolved(configElement, defaultEditStrategyType, getServiceRegistryWrapper(serviceRegistry)); } ServiceRegistryWrapper getServiceRegistryWrapper(ServiceReferenceReadableRegistry serviceRegistry) { // TODO cache service registry return new ServiceRegistryWrapper(serviceRegistry); } Map> getModulesDefinition(ServiceReferenceReadableRegistry serviceRegistry) throws NetconfDocumentedException { return configResolver.fromXmlModulesMap(configElement, defaultEditStrategyType, getServiceRegistryWrapper(serviceRegistry)); } EditStrategyType getDefaultStrategy() { return defaultEditStrategyType; } Services getServices() { return services; } } }