001/*
002 * Portions of this software was developed by employees of the National Institute
003 * of Standards and Technology (NIST), an agency of the Federal Government and is
004 * being made available as a public service. Pursuant to title 17 United States
005 * Code Section 105, works of NIST employees are not subject to copyright
006 * protection in the United States. This software may be subject to foreign
007 * copyright. Permission in the United States and in foreign countries, to the
008 * extent that NIST may hold copyright, to use, copy, modify, create derivative
009 * works, and distribute this software and its documentation without fee is hereby
010 * granted on a non-exclusive basis, provided that this notice and disclaimer
011 * of warranty appears in all copies.
012 *
013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
025 */
026
027package gov.nist.secauto.metaschema.databind.io.xml;
028
029import gov.nist.secauto.metaschema.core.model.IFlagContainer;
030import gov.nist.secauto.metaschema.core.model.util.XmlEventUtil;
031import gov.nist.secauto.metaschema.databind.io.AbstractProblemHandler;
032
033import org.apache.logging.log4j.LogManager;
034import org.apache.logging.log4j.Logger;
035
036import java.util.HashSet;
037import java.util.Set;
038
039import javax.xml.namespace.QName;
040import javax.xml.stream.events.Attribute;
041
042/**
043 * Handles problems identified in the parsed XML.
044 * <p>
045 * The default problem handler will report unknown attributes, and provide empty
046 * collections for multi-valued model items and default values for flags and
047 * single valued fields.
048 */
049public class DefaultXmlProblemHandler
050    extends AbstractProblemHandler
051    implements IXmlProblemHandler {
052  private static final Logger LOGGER = LogManager.getLogger(DefaultXmlProblemHandler.class);
053
054  private static final QName XSI_SCHEMA_LOCATION
055      = new QName("http://www.w3.org/2001/XMLSchema-instance", "schemaLocation");
056  private static final Set<QName> IGNORED_QNAMES;
057
058  static {
059    IGNORED_QNAMES = new HashSet<>();
060    IGNORED_QNAMES.add(XSI_SCHEMA_LOCATION);
061  }
062
063  @Override
064  public boolean handleUnknownAttribute(
065      IFlagContainer parentDefinition,
066      Object targetObject,
067      Attribute attribute,
068      IXmlParsingContext parsingContext) {
069    QName qname = attribute.getName();
070    // check if warning is needed
071    if (LOGGER.isWarnEnabled() && !IGNORED_QNAMES.contains(qname)) {
072      LOGGER.atWarn().log("Skipping unrecognized attribute '{}'{}.",
073          qname,
074          XmlEventUtil.generateLocationMessage(attribute));
075    }
076    // always ignore
077    return true;
078  }
079}