com.sun.tools.xjc.reader.xmlschema.parser.IncorrectNamespaceURIChecker Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2022 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.tools.xjc.reader.xmlschema.parser;
import com.sun.tools.xjc.reader.Const;
import org.xml.sax.Attributes;
import org.xml.sax.ErrorHandler;
import org.xml.sax.Locator;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
import org.xml.sax.helpers.XMLFilterImpl;
import javax.xml.XMLConstants;
/**
* This filter detects the use of incorrect JAXB namespace URI.
*
* When the binding compiler looks at a schema file, it always look
* for the namespace URI of the elements (which is correct, BTW.)
*
*
* However, one unfortunate downside of this philosophically correct
* behavior is that there is no provision or safety check when an user
* misspelled JAXB binding customization namespace.
*
*
* This checker inspects the input document and look for the use of the
* prefix "jaxb". If the document doesn't associate any prefix to the
* JAXB customization URI and if it does associate the jaxb prefix,
* this checker will issue a warning.
*
*
* This warning can happen to completely correct schema (because
* nothing prevents you from using the prefix "jaxb" for other purpose
* while using a JAXB compiler on the same schema) but in practice
* this would be quite unlikely.
*
*
* This justifies the use of this filter.
*
* @author
* Kohsuke Kawaguchi ([email protected])
*/
public class IncorrectNamespaceURIChecker extends XMLFilterImpl {
public IncorrectNamespaceURIChecker( ErrorHandler handler ) {
this.errorHandler = handler;
}
private ErrorHandler errorHandler;
private Locator locator = null;
/** Sets to true once we see the jaxb prefix in use. */
private boolean isJAXBPrefixUsed = false;
/** Sets to true once we see the JAXB customization namespace URI. */
private boolean isCustomizationUsed = false;
@Override
public void endDocument() throws SAXException {
if( isJAXBPrefixUsed && !isCustomizationUsed ) {
SAXParseException e = new SAXParseException(
Messages.format(Messages.WARN_INCORRECT_URI, Const.JAXB_NSURI),
locator );
errorHandler.warning(e);
}
super.endDocument();
}
@Override
public void startPrefixMapping(String prefix, String uri) throws SAXException {
if (XMLConstants.XML_NS_URI.equals(uri)) return; //xml prefix shall not be declared based on jdk api javadoc
if( "jaxb".equals(prefix) )
isJAXBPrefixUsed = true;
if( Const.JAXB_NSURI.equals(uri) )
isCustomizationUsed = true;
super.startPrefixMapping(prefix, uri);
}
@Override
public void endPrefixMapping(String prefix) throws SAXException {
if ("xml".equals(prefix)) return; //xml prefix shall not be declared based on jdk api javadoc
super.endPrefixMapping(prefix);
}
@Override
public void startElement(String namespaceURI, String localName, String qName, Attributes atts)
throws SAXException {
super.startElement(namespaceURI, localName, qName, atts);
// I'm not sure if this is necessary (SAX might report the change of the default prefix
// through the startPrefixMapping method, and I think it does indeed.)
//
// but better safe than sorry.
if( Const.JAXB_NSURI.equals(namespaceURI) )
isCustomizationUsed = true;
}
@Override
public void setDocumentLocator( Locator locator ) {
super.setDocumentLocator( locator );
this.locator = locator;
}
}