com.sun.tools.xjc.reader.internalizer.VersionChecker Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.tools.xjc.reader.internalizer;
import java.util.Set;
import java.util.HashSet;
import java.util.Arrays;
import com.sun.tools.xjc.reader.Const;
import org.xml.sax.Attributes;
import org.xml.sax.ContentHandler;
import org.xml.sax.EntityResolver;
import org.xml.sax.ErrorHandler;
import org.xml.sax.Locator;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
import org.xml.sax.XMLReader;
import org.xml.sax.helpers.LocatorImpl;
import org.xml.sax.helpers.XMLFilterImpl;
/**
* Checks the jaxb:version attribute on a XML Schema document.
*
* jaxb:version is optional if no binding customization is used,
* but if present, its value must be "1.0".
*
* @author
* Kohsuke Kawaguchi ([email protected])
*/
public class VersionChecker extends XMLFilterImpl {
/**
* We store the value of the version attribute in this variable
* when we hit the root element.
*/
private String version = null ;
/** Will be set to true once we hit the root element. */
private boolean seenRoot = false;
/** Will be set to true once we hit a binding declaration. */
private boolean seenBindings = false;
private Locator locator;
/**
* Stores the location of the start tag of the root tag.
*/
private Locator rootTagStart;
public VersionChecker( XMLReader parent ) {
setParent(parent);
}
public VersionChecker( ContentHandler handler,ErrorHandler eh,EntityResolver er ) {
setContentHandler(handler);
if(eh!=null) setErrorHandler(eh);
if(er!=null) setEntityResolver(er);
}
public void startElement(String namespaceURI, String localName, String qName, Attributes atts)
throws SAXException {
super.startElement(namespaceURI, localName, qName, atts);
if(!seenRoot) {
// if this is the root element
seenRoot = true;
rootTagStart = new LocatorImpl(locator);
version = atts.getValue(Const.JAXB_NSURI,"version");
if( namespaceURI.equals(Const.JAXB_NSURI) ) {
String version2 = atts.getValue("","version");
if( version!=null && version2!=null ) {
// we have both @version and @jaxb:version. error.
SAXParseException e = new SAXParseException(
Messages.format( Messages.TWO_VERSION_ATTRIBUTES ), locator );
getErrorHandler().error(e);
}
if( version==null )
version = version2;
}
}
if( Const.JAXB_NSURI.equals(namespaceURI) )
seenBindings = true;
}
public void endDocument() throws SAXException {
super.endDocument();
if( seenBindings && version==null ) {
// if we see a binding declaration but not version attribute
SAXParseException e = new SAXParseException(
Messages.format(Messages.ERR_VERSION_NOT_FOUND),rootTagStart);
getErrorHandler().error(e);
}
// if present, the value must be either 1.0 or 2.0
if( version!=null && !VERSIONS.contains(version) ) {
SAXParseException e = new SAXParseException(
Messages.format(Messages.ERR_INCORRECT_VERSION),rootTagStart);
getErrorHandler().error(e);
}
}
public void setDocumentLocator(Locator locator) {
super.setDocumentLocator(locator);
this.locator = locator;
}
private static final Set VERSIONS = new HashSet(Arrays.asList("1.0","2.0","2.1"));
}