Adjust to yangtools-2.0.0 changes
[controller.git] / opendaylight / blueprint / src / main / java / org / opendaylight / controller / blueprint / ext / DataStoreAppConfigDefaultXMLReader.java
1 /*
2  * Copyright (c) 2016 Brocade Communications 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.controller.blueprint.ext;
9
10 import com.google.common.base.Optional;
11 import com.google.common.base.Strings;
12 import com.google.common.io.Resources;
13 import java.io.IOException;
14 import java.io.InputStream;
15 import java.net.URISyntaxException;
16 import java.net.URL;
17 import javax.xml.parsers.ParserConfigurationException;
18 import javax.xml.stream.XMLStreamException;
19 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
20 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
21 import org.opendaylight.yangtools.util.xml.UntrustedXML;
22 import org.opendaylight.yangtools.yang.binding.DataObject;
23 import org.opendaylight.yangtools.yang.common.QName;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
25 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
26 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
27 import org.opendaylight.yangtools.yang.model.api.Module;
28 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
29 import org.slf4j.Logger;
30 import org.slf4j.LoggerFactory;
31 import org.w3c.dom.Document;
32 import org.xml.sax.SAXException;
33
34 /**
35  * DataObject XML file reader used by {@link DataStoreAppConfigMetadata}.
36  * Available as a standalone class to make it easy to write unit tests which can
37  * catch malformed default "clustered-app-conf" config data XML files in
38  * downstream projects.
39  *
40  * @author Thomas Pantelis (originally; re-factored by Michael Vorburger.ch)
41  */
42 public class DataStoreAppConfigDefaultXMLReader<T extends DataObject> {
43
44     private static final Logger LOG = LoggerFactory.getLogger(DataStoreAppConfigDefaultXMLReader.class);
45
46     private final String logName;
47     private final String defaultAppConfigFileName;
48     private final DOMSchemaService schemaService;
49     private final BindingNormalizedNodeSerializer bindingSerializer;
50     private final BindingContext bindingContext;
51     private final ConfigURLProvider inputStreamProvider;
52
53     @FunctionalInterface
54     public interface FallbackConfigProvider {
55         NormalizedNode<?,?> get(SchemaContext schemaContext, DataSchemaNode dataSchema) throws IOException,
56                 XMLStreamException, ParserConfigurationException, SAXException, URISyntaxException;
57     }
58
59     @FunctionalInterface
60     public interface ConfigURLProvider {
61         Optional<URL> getURL(String appConfigFileName) throws IOException;
62     }
63
64     public DataStoreAppConfigDefaultXMLReader(
65             final String logName,
66             final String defaultAppConfigFileName,
67             final DOMSchemaService schemaService,
68             final BindingNormalizedNodeSerializer bindingSerializer,
69             final BindingContext bindingContext,
70             final ConfigURLProvider inputStreamProvider) {
71
72         this.logName = logName;
73         this.defaultAppConfigFileName = defaultAppConfigFileName;
74         this.schemaService = schemaService;
75         this.bindingSerializer = bindingSerializer;
76         this.bindingContext = bindingContext;
77         this.inputStreamProvider = inputStreamProvider;
78     }
79
80     public DataStoreAppConfigDefaultXMLReader(
81             final Class<?> testClass,
82             final String defaultAppConfigFileName,
83             final DOMSchemaService schemaService,
84             final BindingNormalizedNodeSerializer bindingSerializer,
85             final Class<T> klass) {
86         this(testClass.getName(), defaultAppConfigFileName, schemaService, bindingSerializer,
87             BindingContext.create(testClass.getName(), klass, null),
88             appConfigFileName -> Optional.of(getURL(testClass, defaultAppConfigFileName)));
89     }
90
91     private static URL getURL(final Class<?> testClass, final String defaultAppConfigFileName) {
92         return Resources.getResource(testClass, defaultAppConfigFileName);
93     }
94
95     public T createDefaultInstance() throws ConfigXMLReaderException, ParserConfigurationException, XMLStreamException,
96             IOException, SAXException, URISyntaxException {
97         return createDefaultInstance((schemaContext, dataSchema) -> {
98             throw new IllegalArgumentException("Failed to read XML "
99                     + "(not creating model from defaults as runtime would, for better clarity in tests)");
100         });
101     }
102
103     @SuppressWarnings("unchecked")
104     public T createDefaultInstance(final FallbackConfigProvider fallback) throws ConfigXMLReaderException,
105             URISyntaxException, ParserConfigurationException, XMLStreamException, SAXException, IOException {
106         YangInstanceIdentifier yangPath = bindingSerializer.toYangInstanceIdentifier(bindingContext.appConfigPath);
107
108         LOG.debug("{}: Creating app config instance from path {}, Qname: {}", logName, yangPath,
109                 bindingContext.bindingQName);
110
111         checkNotNull(schemaService, "%s: Could not obtain the SchemaService OSGi service", logName);
112
113         SchemaContext schemaContext = schemaService.getGlobalContext();
114
115         Module module = schemaContext.findModule(bindingContext.bindingQName.getModule()).orElse(null);
116         checkNotNull(module, "%s: Could not obtain the module schema for namespace %s, revision %s",
117                 logName, bindingContext.bindingQName.getNamespace(), bindingContext.bindingQName.getRevision());
118
119         DataSchemaNode dataSchema = module.getDataChildByName(bindingContext.bindingQName);
120         checkNotNull(dataSchema, "%s: Could not obtain the schema for %s", logName, bindingContext.bindingQName);
121
122         checkCondition(bindingContext.schemaType.isAssignableFrom(dataSchema.getClass()),
123                 "%s: Expected schema type %s for %s but actual type is %s", logName,
124                 bindingContext.schemaType, bindingContext.bindingQName, dataSchema.getClass());
125
126         NormalizedNode<?, ?> dataNode = parsePossibleDefaultAppConfigXMLFile(schemaContext, dataSchema);
127         if (dataNode == null) {
128             dataNode = fallback.get(schemaService.getGlobalContext(), dataSchema);
129         }
130
131         DataObject appConfig = bindingSerializer.fromNormalizedNode(yangPath, dataNode).getValue();
132
133         // This shouldn't happen but need to handle it in case...
134         checkNotNull(appConfig, "%s: Could not create instance for app config binding %s", logName,
135                 bindingContext.appConfigBindingClass);
136
137         return (T) appConfig;
138     }
139
140     private static void checkNotNull(final Object reference, final String errorMessageFormat,
141             final Object... formatArgs) throws ConfigXMLReaderException {
142         checkCondition(reference != null, errorMessageFormat, formatArgs);
143     }
144
145     private static void checkCondition(final boolean expression, final String errorMessageFormat,
146             final Object... formatArgs) throws ConfigXMLReaderException {
147         if (!expression) {
148             throw new ConfigXMLReaderException(String.format(errorMessageFormat, formatArgs));
149         }
150     }
151
152     private NormalizedNode<?, ?> parsePossibleDefaultAppConfigXMLFile(final SchemaContext schemaContext,
153             final DataSchemaNode dataSchema) throws ConfigXMLReaderException {
154
155         String appConfigFileName = defaultAppConfigFileName;
156         if (Strings.isNullOrEmpty(appConfigFileName)) {
157             String moduleName = findYangModuleName(bindingContext.bindingQName, schemaContext);
158             appConfigFileName = moduleName + "_" + bindingContext.bindingQName.getLocalName() + ".xml";
159         }
160
161         Optional<URL> optionalURL;
162         try {
163             optionalURL = inputStreamProvider.getURL(appConfigFileName);
164         } catch (final IOException e) {
165             String msg = String.format("%s: Could not getURL()", logName);
166             LOG.error(msg, e);
167             throw new ConfigXMLReaderException(msg, e);
168         }
169         if (!optionalURL.isPresent()) {
170             return null;
171         }
172         URL url = optionalURL.get();
173         try (InputStream is = url.openStream()) {
174             Document root = UntrustedXML.newDocumentBuilder().parse(is);
175             NormalizedNode<?, ?> dataNode = bindingContext.parseDataElement(root.getDocumentElement(), dataSchema,
176                     schemaContext);
177
178             LOG.debug("{}: Parsed data node: {}", logName, dataNode);
179
180             return dataNode;
181         } catch (final IOException | SAXException | XMLStreamException | ParserConfigurationException
182                 | URISyntaxException e) {
183             String msg = String.format("%s: Could not read/parse app config %s", logName, url);
184             LOG.error(msg, e);
185             throw new ConfigXMLReaderException(msg, e);
186         }
187     }
188
189     private String findYangModuleName(final QName qname, final SchemaContext schemaContext)
190             throws ConfigXMLReaderException {
191         for (Module m : schemaContext.getModules()) {
192             if (qname.getModule().equals(m.getQNameModule())) {
193                 return m.getName();
194             }
195         }
196         throw new ConfigXMLReaderException(
197                 String.format("%s: Could not find yang module for QName %s", logName, qname));
198     }
199
200 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.