001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036: package com.sun.tools.xjc.reader;
037:
038: import java.util.StringTokenizer;
039:
040: import com.sun.tools.xjc.Options;
041: import com.sun.tools.xjc.Plugin;
042:
043: import org.xml.sax.Attributes;
044: import org.xml.sax.ErrorHandler;
045: import org.xml.sax.SAXException;
046:
047: /**
048: * This filter checks jaxb:extensionBindingPrefix and
049: * pass/filter extension bindings.
050: *
051: * <p>
052: * This filter also remembers enabled extension namespaces
053: * and filters out any extension namespaces that doesn't belong
054: * to those. The net effect is that disabled customizations
055: * will never pass through this filter.
056: *
057: * <p>
058: * Note that we can't just filter out all foreign namespaces,
059: * as we need to use user-defined tags in documentations to generate javadoc.
060: *
061: * <p>
062: * The class needs to know the list of extension binding namespaces
063: * that the RI recognizes.
064: * To add new URI, modify the isSupportedExtension method.
065: *
066: * @author
067: * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
068: */
069: public final class ExtensionBindingChecker extends
070: AbstractExtensionBindingChecker {
071:
072: /**
073: * Number of the elements encountered. Used to detect the root element.
074: */
075: private int count = 0;
076:
077: public ExtensionBindingChecker(String schemaLanguage,
078: Options options, ErrorHandler handler) {
079: super (schemaLanguage, options, handler);
080: }
081:
082: /**
083: * Returns true if the elements with the given namespace URI
084: * should be blocked by this filter.
085: */
086: private boolean needsToBePruned(String uri) {
087: if (uri.equals(schemaLanguage))
088: return false;
089: if (uri.equals(Const.JAXB_NSURI))
090: return false;
091: if (enabledExtensions.contains(uri))
092: return false;
093:
094: // we don't need to prune something unless
095: // the rest of the processor recognizes it as something special.
096: // this allows us to send the documentation and other harmless
097: // foreign XML fragments, which may be picked up as documents.
098: return isRecognizableExtension(uri);
099: }
100:
101: public void startDocument() throws SAXException {
102: super .startDocument();
103: count = 0;
104: }
105:
106: public void startElement(String namespaceURI, String localName,
107: String qName, Attributes atts) throws SAXException {
108:
109: if (!isCutting()) {
110: String v = atts.getValue(Const.JAXB_NSURI,
111: "extensionBindingPrefixes");
112: if (v != null) {
113: if (count != 0)
114: // the binding attribute is allowed only at the root level.
115: error(Messages.ERR_UNEXPECTED_EXTENSION_BINDING_PREFIXES
116: .format());
117:
118: if (!allowExtensions)
119: error(Messages.ERR_VENDOR_EXTENSION_DISALLOWED_IN_STRICT_MODE
120: .format());
121:
122: // then remember the associated namespace URIs.
123: StringTokenizer tokens = new StringTokenizer(v);
124: while (tokens.hasMoreTokens()) {
125: String prefix = tokens.nextToken();
126: String uri = nsSupport.getURI(prefix);
127: if (uri == null)
128: // undeclared prefix
129: error(Messages.ERR_UNDECLARED_PREFIX
130: .format(prefix));
131: else
132: checkAndEnable(uri);
133: }
134: }
135:
136: if (needsToBePruned(namespaceURI)) {
137: // start pruning the tree. Call the super class method directly.
138: if (isRecognizableExtension(namespaceURI)) {
139: // but this is a supported customization.
140: // isn't the user forgetting @jaxb:extensionBindingPrefixes?
141: warning(Messages.ERR_SUPPORTED_EXTENSION_IGNORED
142: .format(namespaceURI));
143: }
144: startCutting();
145: } else
146: verifyTagName(namespaceURI, localName, qName);
147: }
148:
149: count++;
150: super.startElement(namespaceURI, localName, qName, atts);
151: }
152: }
|