Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/tools/internal/xjc/reader/xmlschema/parser/IncorrectNamespaceURIChecker.java@0989ad8c0860 (annotated)
src/share/jaxws_classes/com/sun/tools/internal/xjc/reader/xmlschema/parser/IncorrectNamespaceURIChecker.java
Tue, 09 Apr 2013 14:51:13 +0100
- author
- alanb
- date
- Tue, 09 Apr 2013 14:51:13 +0100
- changeset 368
- 0989ad8c0860
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.tools.internal.xjc.reader.xmlschema.parser; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import com.sun.tools.internal.xjc.reader.Const; |
| aoqi@0 | 29 | import com.sun.xml.internal.bind.v2.WellKnownNamespace; |
| aoqi@0 | 30 | import org.xml.sax.Attributes; |
| aoqi@0 | 31 | import org.xml.sax.ErrorHandler; |
| aoqi@0 | 32 | import org.xml.sax.Locator; |
| aoqi@0 | 33 | import org.xml.sax.SAXException; |
| aoqi@0 | 34 | import org.xml.sax.SAXParseException; |
| aoqi@0 | 35 | import org.xml.sax.helpers.XMLFilterImpl; |
| aoqi@0 | 36 | |
| aoqi@0 | 37 | /** |
| aoqi@0 | 38 | * This filter detects the use of incorrect JAXB namespace URI. |
| aoqi@0 | 39 | * |
| aoqi@0 | 40 | * When the binding compiler looks at a schema file, it always look |
| aoqi@0 | 41 | * for the namespace URI of the elements (which is correct, BTW.) |
| aoqi@0 | 42 | * |
| aoqi@0 | 43 | * <p> |
| aoqi@0 | 44 | * However, one unfortunate downside of this philosophically correct |
| aoqi@0 | 45 | * behavior is that there is no provision or safety check when an user |
| aoqi@0 | 46 | * misspelled JAXB binding customization namespace. |
| aoqi@0 | 47 | * |
| aoqi@0 | 48 | * <p> |
| aoqi@0 | 49 | * This checker inspects the input document and look for the use of the |
| aoqi@0 | 50 | * prefix "jaxb". If the document doesn't associate any prefix to the |
| aoqi@0 | 51 | * JAXB customization URI and if it does associate the jaxb prefix, |
| aoqi@0 | 52 | * this checker will issue a warning. |
| aoqi@0 | 53 | * |
| aoqi@0 | 54 | * <p> |
| aoqi@0 | 55 | * This warning can happen to completely correct schema (because |
| aoqi@0 | 56 | * nothing prevents you from using the prefix "jaxb" for other purpose |
| aoqi@0 | 57 | * while using a JAXB compiler on the same schema) but in practice |
| aoqi@0 | 58 | * this would be quite unlikely. |
| aoqi@0 | 59 | * |
| aoqi@0 | 60 | * <p> |
| aoqi@0 | 61 | * This justifies the use of this filter. |
| aoqi@0 | 62 | * |
| aoqi@0 | 63 | * @author |
| aoqi@0 | 64 | * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) |
| aoqi@0 | 65 | */ |
| aoqi@0 | 66 | public class IncorrectNamespaceURIChecker extends XMLFilterImpl { |
| aoqi@0 | 67 | |
| aoqi@0 | 68 | public IncorrectNamespaceURIChecker( ErrorHandler handler ) { |
| aoqi@0 | 69 | this.errorHandler = handler; |
| aoqi@0 | 70 | } |
| aoqi@0 | 71 | |
| aoqi@0 | 72 | private ErrorHandler errorHandler; |
| aoqi@0 | 73 | |
| aoqi@0 | 74 | private Locator locator = null; |
| aoqi@0 | 75 | |
| aoqi@0 | 76 | /** Sets to true once we see the jaxb prefix in use. */ |
| aoqi@0 | 77 | private boolean isJAXBPrefixUsed = false; |
| aoqi@0 | 78 | /** Sets to true once we see the JAXB customization namespace URI. */ |
| aoqi@0 | 79 | private boolean isCustomizationUsed = false; |
| aoqi@0 | 80 | |
| aoqi@0 | 81 | @Override |
| aoqi@0 | 82 | public void endDocument() throws SAXException { |
| aoqi@0 | 83 | if( isJAXBPrefixUsed && !isCustomizationUsed ) { |
| aoqi@0 | 84 | SAXParseException e = new SAXParseException( |
| aoqi@0 | 85 | Messages.format(Messages.WARN_INCORRECT_URI, Const.JAXB_NSURI), |
| aoqi@0 | 86 | locator ); |
| aoqi@0 | 87 | errorHandler.warning(e); |
| aoqi@0 | 88 | } |
| aoqi@0 | 89 | |
| aoqi@0 | 90 | super.endDocument(); |
| aoqi@0 | 91 | } |
| aoqi@0 | 92 | |
| aoqi@0 | 93 | @Override |
| aoqi@0 | 94 | public void startPrefixMapping(String prefix, String uri) throws SAXException { |
| aoqi@0 | 95 | if (WellKnownNamespace.XML_NAMESPACE_URI.equals(uri)) return; //xml prefix shall not be declared based on jdk api javadoc |
| aoqi@0 | 96 | if( prefix.equals("jaxb") ) |
| aoqi@0 | 97 | isJAXBPrefixUsed = true; |
| aoqi@0 | 98 | if( uri.equals(Const.JAXB_NSURI) ) |
| aoqi@0 | 99 | isCustomizationUsed = true; |
| aoqi@0 | 100 | |
| aoqi@0 | 101 | super.startPrefixMapping(prefix, uri); |
| aoqi@0 | 102 | } |
| aoqi@0 | 103 | |
| aoqi@0 | 104 | @Override |
| aoqi@0 | 105 | public void endPrefixMapping(String prefix) throws SAXException { |
| aoqi@0 | 106 | if ("xml".equals(prefix)) return; //xml prefix shall not be declared based on jdk api javadoc |
| aoqi@0 | 107 | super.endPrefixMapping(prefix); |
| aoqi@0 | 108 | } |
| aoqi@0 | 109 | |
| aoqi@0 | 110 | @Override |
| aoqi@0 | 111 | public void startElement(String namespaceURI, String localName, String qName, Attributes atts) |
| aoqi@0 | 112 | throws SAXException { |
| aoqi@0 | 113 | super.startElement(namespaceURI, localName, qName, atts); |
| aoqi@0 | 114 | |
| aoqi@0 | 115 | // I'm not sure if this is necessary (SAX might report the change of the default prefix |
| aoqi@0 | 116 | // through the startPrefixMapping method, and I think it does indeed.) |
| aoqi@0 | 117 | // |
| aoqi@0 | 118 | // but better safe than sorry. |
| aoqi@0 | 119 | |
| aoqi@0 | 120 | if( namespaceURI.equals(Const.JAXB_NSURI) ) |
| aoqi@0 | 121 | isCustomizationUsed = true; |
| aoqi@0 | 122 | } |
| aoqi@0 | 123 | |
| aoqi@0 | 124 | @Override |
| aoqi@0 | 125 | public void setDocumentLocator( Locator locator ) { |
| aoqi@0 | 126 | super.setDocumentLocator( locator ); |
| aoqi@0 | 127 | this.locator = locator; |
| aoqi@0 | 128 | } |
| aoqi@0 | 129 | } |
