Convert blueprint ext classes to MDSAL APIs
[controller.git] / opendaylight / blueprint / src / main / java / org / opendaylight / controller / blueprint / ext / DataStoreAppConfigDefaultXMLReader.java
index 57f3abce85ea5b0da1bf3b66377a40c097d7f4f1..9b55b360d66bab09a531e0174c3ad5fa7166d2d2 100644 (file)
@@ -7,21 +7,22 @@
  */
 package org.opendaylight.controller.blueprint.ext;
 
-import com.google.common.base.Optional;
 import com.google.common.base.Strings;
 import com.google.common.io.Resources;
 import java.io.IOException;
 import java.io.InputStream;
+import java.net.URISyntaxException;
 import java.net.URL;
-import org.opendaylight.controller.sal.core.api.model.SchemaService;
+import java.util.Optional;
+import javax.xml.parsers.ParserConfigurationException;
+import javax.xml.stream.XMLStreamException;
 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
+import org.opendaylight.mdsal.dom.api.DOMSchemaService;
 import org.opendaylight.yangtools.util.xml.UntrustedXML;
 import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
-import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlUtils;
-import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.Module;
 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
@@ -44,14 +45,15 @@ public class DataStoreAppConfigDefaultXMLReader<T extends DataObject> {
 
     private final String logName;
     private final String defaultAppConfigFileName;
-    private final SchemaService schemaService;
+    private final DOMSchemaService schemaService;
     private final BindingNormalizedNodeSerializer bindingSerializer;
     private final BindingContext bindingContext;
     private final ConfigURLProvider inputStreamProvider;
 
     @FunctionalInterface
     public interface FallbackConfigProvider {
-        NormalizedNode<?,?> get(SchemaContext schemaContext, DataSchemaNode dataSchema);
+        NormalizedNode<?,?> get(SchemaContext schemaContext, DataSchemaNode dataSchema) throws IOException,
+                XMLStreamException, ParserConfigurationException, SAXException, URISyntaxException;
     }
 
     @FunctionalInterface
@@ -60,12 +62,12 @@ public class DataStoreAppConfigDefaultXMLReader<T extends DataObject> {
     }
 
     public DataStoreAppConfigDefaultXMLReader(
-            String logName,
-            String defaultAppConfigFileName,
-            SchemaService schemaService,
-            BindingNormalizedNodeSerializer bindingSerializer,
-            BindingContext bindingContext,
-            ConfigURLProvider inputStreamProvider) {
+            final String logName,
+            final String defaultAppConfigFileName,
+            final DOMSchemaService schemaService,
+            final BindingNormalizedNodeSerializer bindingSerializer,
+            final BindingContext bindingContext,
+            final ConfigURLProvider inputStreamProvider) {
 
         this.logName = logName;
         this.defaultAppConfigFileName = defaultAppConfigFileName;
@@ -76,21 +78,22 @@ public class DataStoreAppConfigDefaultXMLReader<T extends DataObject> {
     }
 
     public DataStoreAppConfigDefaultXMLReader(
-            Class<?> testClass,
-            String defaultAppConfigFileName,
-            SchemaService schemaService,
-            BindingNormalizedNodeSerializer bindingSerializer,
-            Class<T> klass) {
+            final Class<?> testClass,
+            final String defaultAppConfigFileName,
+            final DOMSchemaService schemaService,
+            final BindingNormalizedNodeSerializer bindingSerializer,
+            final Class<T> klass) {
         this(testClass.getName(), defaultAppConfigFileName, schemaService, bindingSerializer,
             BindingContext.create(testClass.getName(), klass, null),
             appConfigFileName -> Optional.of(getURL(testClass, defaultAppConfigFileName)));
     }
 
-    private static URL getURL(Class<?> testClass, String defaultAppConfigFileName) {
+    private static URL getURL(final Class<?> testClass, final String defaultAppConfigFileName) {
         return Resources.getResource(testClass, defaultAppConfigFileName);
     }
 
-    public T createDefaultInstance() throws ConfigXMLReaderException {
+    public T createDefaultInstance() throws ConfigXMLReaderException, ParserConfigurationException, XMLStreamException,
+            IOException, SAXException, URISyntaxException {
         return createDefaultInstance((schemaContext, dataSchema) -> {
             throw new IllegalArgumentException("Failed to read XML "
                     + "(not creating model from defaults as runtime would, for better clarity in tests)");
@@ -98,39 +101,27 @@ public class DataStoreAppConfigDefaultXMLReader<T extends DataObject> {
     }
 
     @SuppressWarnings("unchecked")
-    public T createDefaultInstance(FallbackConfigProvider fallback) throws ConfigXMLReaderException {
+    public T createDefaultInstance(final FallbackConfigProvider fallback) throws ConfigXMLReaderException,
+            URISyntaxException, ParserConfigurationException, XMLStreamException, SAXException, IOException {
         YangInstanceIdentifier yangPath = bindingSerializer.toYangInstanceIdentifier(bindingContext.appConfigPath);
 
         LOG.debug("{}: Creating app config instance from path {}, Qname: {}", logName, yangPath,
                 bindingContext.bindingQName);
 
-        if (schemaService == null) {
-            throw new ConfigXMLReaderException(
-                    String.format("%s: Could not obtain the SchemaService OSGi service", logName));
-        }
+        checkNotNull(schemaService, "%s: Could not obtain the SchemaService OSGi service", logName);
 
         SchemaContext schemaContext = schemaService.getGlobalContext();
 
-        Module module = schemaContext.findModuleByNamespaceAndRevision(bindingContext.bindingQName.getNamespace(),
-                bindingContext.bindingQName.getRevision());
-        if (module == null) {
-            throw new ConfigXMLReaderException(
-                    String.format("%s: Could not obtain the module schema for namespace %s, revision %s",
-                    logName, bindingContext.bindingQName.getNamespace(), bindingContext.bindingQName.getRevision()));
-        }
+        Module module = schemaContext.findModule(bindingContext.bindingQName.getModule()).orElse(null);
+        checkNotNull(module, "%s: Could not obtain the module schema for namespace %s, revision %s",
+                logName, bindingContext.bindingQName.getNamespace(), bindingContext.bindingQName.getRevision());
 
         DataSchemaNode dataSchema = module.getDataChildByName(bindingContext.bindingQName);
-        if (dataSchema == null) {
-            throw new ConfigXMLReaderException(
-                    String.format("%s: Could not obtain the schema for %s", logName,
-                    bindingContext.bindingQName));
-        }
+        checkNotNull(dataSchema, "%s: Could not obtain the schema for %s", logName, bindingContext.bindingQName);
 
-        if (!bindingContext.schemaType.isAssignableFrom(dataSchema.getClass())) {
-            throw new ConfigXMLReaderException(
-                    String.format("%s: Expected schema type %s for %s but actual type is %s", logName,
-                    bindingContext.schemaType, bindingContext.bindingQName, dataSchema.getClass()));
-        }
+        checkCondition(bindingContext.schemaType.isAssignableFrom(dataSchema.getClass()),
+                "%s: Expected schema type %s for %s but actual type is %s", logName,
+                bindingContext.schemaType, bindingContext.bindingQName, dataSchema.getClass());
 
         NormalizedNode<?, ?> dataNode = parsePossibleDefaultAppConfigXMLFile(schemaContext, dataSchema);
         if (dataNode == null) {
@@ -138,13 +129,23 @@ public class DataStoreAppConfigDefaultXMLReader<T extends DataObject> {
         }
 
         DataObject appConfig = bindingSerializer.fromNormalizedNode(yangPath, dataNode).getValue();
-        if (appConfig == null) {
-            // This shouldn't happen but need to handle it in case...
-            throw new ConfigXMLReaderException(
-                    String.format("%s: Could not create instance for app config binding %s",
-                    logName, bindingContext.appConfigBindingClass));
-        } else {
-            return (T) appConfig;
+
+        // This shouldn't happen but need to handle it in case...
+        checkNotNull(appConfig, "%s: Could not create instance for app config binding %s", logName,
+                bindingContext.appConfigBindingClass);
+
+        return (T) appConfig;
+    }
+
+    private static void checkNotNull(final Object reference, final String errorMessageFormat,
+            final Object... formatArgs) throws ConfigXMLReaderException {
+        checkCondition(reference != null, errorMessageFormat, formatArgs);
+    }
+
+    private static void checkCondition(final boolean expression, final String errorMessageFormat,
+            final Object... formatArgs) throws ConfigXMLReaderException {
+        if (!expression) {
+            throw new ConfigXMLReaderException(String.format(errorMessageFormat, formatArgs));
         }
     }
 
@@ -157,13 +158,10 @@ public class DataStoreAppConfigDefaultXMLReader<T extends DataObject> {
             appConfigFileName = moduleName + "_" + bindingContext.bindingQName.getLocalName() + ".xml";
         }
 
-        DomToNormalizedNodeParserFactory parserFactory = DomToNormalizedNodeParserFactory.getInstance(
-                XmlUtils.DEFAULT_XML_CODEC_PROVIDER, schemaContext);
-
         Optional<URL> optionalURL;
         try {
             optionalURL = inputStreamProvider.getURL(appConfigFileName);
-        } catch (IOException e) {
+        } catch (final IOException e) {
             String msg = String.format("%s: Could not getURL()", logName);
             LOG.error(msg, e);
             throw new ConfigXMLReaderException(msg, e);
@@ -175,12 +173,13 @@ public class DataStoreAppConfigDefaultXMLReader<T extends DataObject> {
         try (InputStream is = url.openStream()) {
             Document root = UntrustedXML.newDocumentBuilder().parse(is);
             NormalizedNode<?, ?> dataNode = bindingContext.parseDataElement(root.getDocumentElement(), dataSchema,
-                    parserFactory);
+                    schemaContext);
 
             LOG.debug("{}: Parsed data node: {}", logName, dataNode);
 
             return dataNode;
-        } catch (SAXException | IOException e) {
+        } catch (final IOException | SAXException | XMLStreamException | ParserConfigurationException
+                | URISyntaxException e) {
             String msg = String.format("%s: Could not read/parse app config %s", logName, url);
             LOG.error(msg, e);
             throw new ConfigXMLReaderException(msg, e);