aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.internal.xjc.reader.xmlschema.parser;
aoqi@0: 
aoqi@0: import java.util.HashSet;
aoqi@0: import java.util.Set;
aoqi@0: import java.util.Stack;
aoqi@0: 
aoqi@0: import javax.xml.namespace.QName;
aoqi@0: 
aoqi@0: import com.sun.tools.internal.xjc.reader.Const;
aoqi@0: import com.sun.xml.internal.bind.v2.WellKnownNamespace;
aoqi@0: 
aoqi@0: import org.xml.sax.Attributes;
aoqi@0: import org.xml.sax.ErrorHandler;
aoqi@0: import org.xml.sax.Locator;
aoqi@0: import org.xml.sax.SAXException;
aoqi@0: import org.xml.sax.SAXParseException;
aoqi@0: import org.xml.sax.helpers.XMLFilterImpl;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Checks if binding declarations are placed where they are allowed.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * For example, if a &lt;jaxb:property> customization is given under
aoqi@0:  * the &lt;xs:simpleContent> element, this class raises an error.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * our main checkpoint of misplaced customizations are in BGMBuilder.
aoqi@0:  * There, we mark a customization whenever we use it. At the end of the
aoqi@0:  * day, we look for unmarked customizations and raise errors for them.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * Between this approach and the JAXB spec 1.0 is a problem that
aoqi@0:  * the spec allows/prohibits customizations at schema element level,
aoqi@0:  * while BGMBuilder and XSOM works on schema component levels.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * For example, a property customization is allowed on a complex type
aoqi@0:  * schema component, but it's only allowed on the &lt;complexType>
aoqi@0:  * element. The spec team informed us that they would consider resolving
aoqi@0:  * this discrepancy in favor of RI, but meanwhile we need to detect
aoqi@0:  * errors correctly.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * This filter is implemented for this purpose.
aoqi@0:  *
aoqi@0:  *
aoqi@0:  * <h2>Customization and allowed locations</h2>
aoqi@0:  *
aoqi@0:  * - globalBinding/schemaBinding
aoqi@0:  *     schema
aoqi@0:  *
aoqi@0:  * - class
aoqi@0:  *     complexType(*), modelGroupDecl, modelGroup, element
aoqi@0:  *
aoqi@0:  * - property
aoqi@0:  *     attribute, element, any, modelGroup, modelGroupRef, complexType(*)
aoqi@0:  *
aoqi@0:  * - javaType
aoqi@0:  *     simpleType(*)
aoqi@0:  *
aoqi@0:  * - typesafeEnumClass
aoqi@0:  *     simpleType(*)
aoqi@0:  *
aoqi@0:  * - typesafeEnumMember
aoqi@0:  *     simpleType(*), enumeration
aoqi@0:  *
aoqi@0:  * Components marked with '*' needs a check by this component
aoqi@0:  * since more than one schema element corresponds to one schema component
aoqi@0:  * of that type.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * For simple types, customizations are allowed only under the &lt;xs:simpleType>
aoqi@0:  * element, and for complex types they are allowed only under the
aoqi@0:  * &lt;xs:cimplexType> element.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * So the bottom line is that it would be suffice if we just make sure
aoqi@0:  * that no customization will be attached under other elements of
aoqi@0:  * simple types and complex types. Those are:
aoqi@0:  *
aoqi@0:  * - simpleType/restriction
aoqi@0:  * - list
aoqi@0:  * - union
aoqi@0:  * - complexType/(simple or complex)Content
aoqi@0:  * - complexType/(simple or complex)Content/(restriction of extension)
aoqi@0:  *
aoqi@0:  * @author
aoqi@0:  *     Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
aoqi@0:  */
aoqi@0: public class CustomizationContextChecker extends XMLFilterImpl {
aoqi@0: 
aoqi@0:     /** Keep names of all the ancestor elements. */
aoqi@0:     private final Stack<QName> elementNames = new Stack<QName>();
aoqi@0: 
aoqi@0:     private final ErrorHandler errorHandler;
aoqi@0: 
aoqi@0:     private Locator locator;
aoqi@0: 
aoqi@0:     /** Set of element names that cannot have JAXB customizations. */
aoqi@0:     private static final Set<String> prohibitedSchemaElementNames = new HashSet<String>();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * @param _errorHandler
aoqi@0:      *      Detected errors will be sent to this object.
aoqi@0:      */
aoqi@0:     public CustomizationContextChecker( ErrorHandler _errorHandler ) {
aoqi@0:         this.errorHandler = _errorHandler;
aoqi@0:     }
aoqi@0: 
aoqi@0:     static {
aoqi@0:         prohibitedSchemaElementNames.add("restriction");
aoqi@0:         prohibitedSchemaElementNames.add("extension");
aoqi@0:         prohibitedSchemaElementNames.add("simpleContent");
aoqi@0:         prohibitedSchemaElementNames.add("complexContent");
aoqi@0:         prohibitedSchemaElementNames.add("list");
aoqi@0:         prohibitedSchemaElementNames.add("union");
aoqi@0:     }
aoqi@0: 
aoqi@0: 
aoqi@0: 
aoqi@0: 
aoqi@0:     /** Gets the stack top. */
aoqi@0:     private QName top() {
aoqi@0:         return elementNames.peek();
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void startElement(String namespaceURI, String localName, String qName, Attributes atts) throws SAXException {
aoqi@0:         QName newElement = new QName(namespaceURI,localName);
aoqi@0: 
aoqi@0:         if( newElement.getNamespaceURI().equals(Const.JAXB_NSURI)
aoqi@0:          && top().getNamespaceURI().equals(WellKnownNamespace.XML_SCHEMA) ) {
aoqi@0:             // we hit a JAXB customization. the stack top should be
aoqi@0:             // <xs:appinfo>
aoqi@0:             if( elementNames.size()>=3 ) {
aoqi@0:                 // the above statement checks if the following statement doesn't
aoqi@0:                 // cause an exception.
aoqi@0:                 QName schemaElement = elementNames.get( elementNames.size()-3 );
aoqi@0:                 if( prohibitedSchemaElementNames.contains(schemaElement.getLocalPart()) ) {
aoqi@0:                     // the owner schema element is in the wanted list.
aoqi@0:                     errorHandler.error( new SAXParseException(
aoqi@0:                         Messages.format(
aoqi@0:                             Messages.ERR_UNACKNOWLEDGED_CUSTOMIZATION,
aoqi@0:                             localName ),
aoqi@0:                         locator ) );
aoqi@0:                 }
aoqi@0:             }
aoqi@0: 
aoqi@0: 
aoqi@0:         }
aoqi@0: 
aoqi@0:         elementNames.push(newElement);
aoqi@0: 
aoqi@0:         super.startElement(namespaceURI, localName, qName, atts );
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void endElement(String namespaceURI, String localName, String qName)
aoqi@0:         throws SAXException {
aoqi@0: 
aoqi@0:         super.endElement(namespaceURI, localName, qName);
aoqi@0: 
aoqi@0:         elementNames.pop();
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void setDocumentLocator(Locator locator) {
aoqi@0:         super.setDocumentLocator(locator);
aoqi@0:         this.locator = locator;
aoqi@0:     }
aoqi@0: 
aoqi@0: }