1 /*
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.metaschema.databind.io.xml;
28
29 import gov.nist.secauto.metaschema.core.model.IFlagContainer;
30 import gov.nist.secauto.metaschema.core.model.util.XmlEventUtil;
31 import gov.nist.secauto.metaschema.databind.io.AbstractProblemHandler;
32
33 import org.apache.logging.log4j.LogManager;
34 import org.apache.logging.log4j.Logger;
35
36 import java.util.HashSet;
37 import java.util.Set;
38
39 import javax.xml.namespace.QName;
40 import javax.xml.stream.events.Attribute;
41
42 /**
43 * Handles problems identified in the parsed XML.
44 * <p>
45 * The default problem handler will report unknown attributes, and provide empty
46 * collections for multi-valued model items and default values for flags and
47 * single valued fields.
48 */
49 public class DefaultXmlProblemHandler
50 extends AbstractProblemHandler
51 implements IXmlProblemHandler {
52 private static final Logger LOGGER = LogManager.getLogger(DefaultXmlProblemHandler.class);
53
54 private static final QName XSI_SCHEMA_LOCATION
55 = new QName("http://www.w3.org/2001/XMLSchema-instance", "schemaLocation");
56 private static final Set<QName> IGNORED_QNAMES;
57
58 static {
59 IGNORED_QNAMES = new HashSet<>();
60 IGNORED_QNAMES.add(XSI_SCHEMA_LOCATION);
61 }
62
63 @Override
64 public boolean handleUnknownAttribute(
65 IFlagContainer parentDefinition,
66 Object targetObject,
67 Attribute attribute,
68 IXmlParsingContext parsingContext) {
69 QName qname = attribute.getName();
70 // check if warning is needed
71 if (LOGGER.isWarnEnabled() && !IGNORED_QNAMES.contains(qname)) {
72 LOGGER.atWarn().log("Skipping unrecognized attribute '{}'{}.",
73 qname,
74 XmlEventUtil.generateLocationMessage(attribute));
75 }
76 // always ignore
77 return true;
78 }
79 }