Wed, 27 Apr 2016 01:27:09 +0800
Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/jaxws/
changeset: 657:d47a47f961ee
tag: jdk8u25-b17
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.xml.internal.bind.marshaller; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import java.io.OutputStream; |
aoqi@0 | 29 | |
aoqi@0 | 30 | import javax.xml.bind.JAXBContext; |
aoqi@0 | 31 | import javax.xml.stream.XMLEventWriter; |
aoqi@0 | 32 | import javax.xml.stream.XMLStreamWriter; |
aoqi@0 | 33 | import javax.xml.transform.dom.DOMResult; |
aoqi@0 | 34 | |
aoqi@0 | 35 | import org.w3c.dom.Node; |
aoqi@0 | 36 | |
aoqi@0 | 37 | // be careful about changing this class. this class is supposed to be |
aoqi@0 | 38 | // extended by users and therefore we are not allowed to break |
aoqi@0 | 39 | // those user code. |
aoqi@0 | 40 | // |
aoqi@0 | 41 | // this means: |
aoqi@0 | 42 | // - don't add any abstract method |
aoqi@0 | 43 | // - don't change any existing method signature |
aoqi@0 | 44 | // - don't remove any existing method. |
aoqi@0 | 45 | |
aoqi@0 | 46 | /** |
aoqi@0 | 47 | * Implemented by the user application to determine URI -> prefix |
aoqi@0 | 48 | * mapping. |
aoqi@0 | 49 | * |
aoqi@0 | 50 | * This is considered as an interface, though it's implemented |
aoqi@0 | 51 | * as an abstract class to make it easy to add new methods in |
aoqi@0 | 52 | * a future. |
aoqi@0 | 53 | * |
aoqi@0 | 54 | * @author |
aoqi@0 | 55 | * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) |
aoqi@0 | 56 | */ |
aoqi@0 | 57 | public abstract class NamespacePrefixMapper { |
aoqi@0 | 58 | |
aoqi@0 | 59 | private static final String[] EMPTY_STRING = new String[0]; |
aoqi@0 | 60 | |
aoqi@0 | 61 | /** |
aoqi@0 | 62 | * Returns a preferred prefix for the given namespace URI. |
aoqi@0 | 63 | * |
aoqi@0 | 64 | * This method is intended to be overrided by a derived class. |
aoqi@0 | 65 | * |
aoqi@0 | 66 | * <p> |
aoqi@0 | 67 | * As noted in the return value portion of the javadoc, there |
aoqi@0 | 68 | * are several cases where the preference cannot be honored. |
aoqi@0 | 69 | * Specifically, as of JAXB RI 2.0 and onward: |
aoqi@0 | 70 | * |
aoqi@0 | 71 | * <ol> |
aoqi@0 | 72 | * <li> |
aoqi@0 | 73 | * If the prefix returned is already in use as one of the in-scope |
aoqi@0 | 74 | * namespace bindings. This is partly necessary for correctness |
aoqi@0 | 75 | * (so that we don't unexpectedly change the meaning of QNames |
aoqi@0 | 76 | * bound to {@link String}), partly to simplify the marshaller. |
aoqi@0 | 77 | * <li> |
aoqi@0 | 78 | * If the prefix returned is "" yet the current {@link JAXBContext} |
aoqi@0 | 79 | * includes classes that use the empty namespace URI. This allows |
aoqi@0 | 80 | * the JAXB RI to reserve the "" prefix for the empty namespace URI, |
aoqi@0 | 81 | * which is the only possible prefix for the URI. |
aoqi@0 | 82 | * This restriction is also to simplify the marshaller. |
aoqi@0 | 83 | * </ol> |
aoqi@0 | 84 | * |
aoqi@0 | 85 | * @param namespaceUri |
aoqi@0 | 86 | * The namespace URI for which the prefix needs to be found. |
aoqi@0 | 87 | * Never be null. "" is used to denote the default namespace. |
aoqi@0 | 88 | * @param suggestion |
aoqi@0 | 89 | * When the content tree has a suggestion for the prefix |
aoqi@0 | 90 | * to the given namespaceUri, that suggestion is passed as a |
aoqi@0 | 91 | * parameter. Typicall this value comes from the QName.getPrefix |
aoqi@0 | 92 | * to show the preference of the content tree. This parameter |
aoqi@0 | 93 | * may be null, and this parameter may represent an already |
aoqi@0 | 94 | * occupied prefix. |
aoqi@0 | 95 | * @param requirePrefix |
aoqi@0 | 96 | * If this method is expected to return non-empty prefix. |
aoqi@0 | 97 | * When this flag is true, it means that the given namespace URI |
aoqi@0 | 98 | * cannot be set as the default namespace. |
aoqi@0 | 99 | * |
aoqi@0 | 100 | * @return |
aoqi@0 | 101 | * null if there's no prefered prefix for the namespace URI. |
aoqi@0 | 102 | * In this case, the system will generate a prefix for you. |
aoqi@0 | 103 | * |
aoqi@0 | 104 | * Otherwise the system will try to use the returned prefix, |
aoqi@0 | 105 | * but generally there's no guarantee if the prefix will be |
aoqi@0 | 106 | * actually used or not. |
aoqi@0 | 107 | * |
aoqi@0 | 108 | * return "" to map this namespace URI to the default namespace. |
aoqi@0 | 109 | * Again, there's no guarantee that this preference will be |
aoqi@0 | 110 | * honored. |
aoqi@0 | 111 | * |
aoqi@0 | 112 | * If this method returns "" when requirePrefix=true, the return |
aoqi@0 | 113 | * value will be ignored and the system will generate one. |
aoqi@0 | 114 | * |
aoqi@0 | 115 | * @since JAXB 1.0.1 |
aoqi@0 | 116 | */ |
aoqi@0 | 117 | public abstract String getPreferredPrefix(String namespaceUri, String suggestion, boolean requirePrefix); |
aoqi@0 | 118 | |
aoqi@0 | 119 | /** |
aoqi@0 | 120 | * Returns a list of namespace URIs that should be declared |
aoqi@0 | 121 | * at the root element. |
aoqi@0 | 122 | * |
aoqi@0 | 123 | * <p> |
aoqi@0 | 124 | * By default, the JAXB RI 1.0.x produces namespace declarations only when |
aoqi@0 | 125 | * they are necessary, only at where they are used. Because of this |
aoqi@0 | 126 | * lack of look-ahead, sometimes the marshaller produces a lot of |
aoqi@0 | 127 | * namespace declarations that look redundant to human eyes. For example, |
aoqi@0 | 128 | * <pre><xmp> |
aoqi@0 | 129 | * <?xml version="1.0"?> |
aoqi@0 | 130 | * <root> |
aoqi@0 | 131 | * <ns1:child xmlns:ns1="urn:foo"> ... </ns1:child> |
aoqi@0 | 132 | * <ns2:child xmlns:ns2="urn:foo"> ... </ns2:child> |
aoqi@0 | 133 | * <ns3:child xmlns:ns3="urn:foo"> ... </ns3:child> |
aoqi@0 | 134 | * ... |
aoqi@0 | 135 | * </root> |
aoqi@0 | 136 | * </xmp></pre> |
aoqi@0 | 137 | * |
aoqi@0 | 138 | * <p> |
aoqi@0 | 139 | * The JAXB RI 2.x mostly doesn't exhibit this behavior any more, |
aoqi@0 | 140 | * as it declares all statically known namespace URIs (those URIs |
aoqi@0 | 141 | * that are used as element/attribute names in JAXB annotations), |
aoqi@0 | 142 | * but it may still declare additional namespaces in the middle of |
aoqi@0 | 143 | * a document, for example when (i) a QName as an attribute/element value |
aoqi@0 | 144 | * requires a new namespace URI, or (ii) DOM nodes as a portion of an object |
aoqi@0 | 145 | * tree requires a new namespace URI. |
aoqi@0 | 146 | * |
aoqi@0 | 147 | * <p> |
aoqi@0 | 148 | * If you know in advance that you are going to use a certain set of |
aoqi@0 | 149 | * namespace URIs, you can override this method and have the marshaller |
aoqi@0 | 150 | * declare those namespace URIs at the root element. |
aoqi@0 | 151 | * |
aoqi@0 | 152 | * <p> |
aoqi@0 | 153 | * For example, by returning <code>new String[]{"urn:foo"}</code>, |
aoqi@0 | 154 | * the marshaller will produce: |
aoqi@0 | 155 | * <pre><xmp> |
aoqi@0 | 156 | * <?xml version="1.0"?> |
aoqi@0 | 157 | * <root xmlns:ns1="urn:foo"> |
aoqi@0 | 158 | * <ns1:child> ... </ns1:child> |
aoqi@0 | 159 | * <ns1:child> ... </ns1:child> |
aoqi@0 | 160 | * <ns1:child> ... </ns1:child> |
aoqi@0 | 161 | * ... |
aoqi@0 | 162 | * </root> |
aoqi@0 | 163 | * </xmp></pre> |
aoqi@0 | 164 | * <p> |
aoqi@0 | 165 | * To control prefixes assigned to those namespace URIs, use the |
aoqi@0 | 166 | * {@link #getPreferredPrefix(String, String, boolean)} method. |
aoqi@0 | 167 | * |
aoqi@0 | 168 | * @return |
aoqi@0 | 169 | * A list of namespace URIs as an array of {@link String}s. |
aoqi@0 | 170 | * This method can return a length-zero array but not null. |
aoqi@0 | 171 | * None of the array component can be null. To represent |
aoqi@0 | 172 | * the empty namespace, use the empty string <code>""</code>. |
aoqi@0 | 173 | * |
aoqi@0 | 174 | * @since |
aoqi@0 | 175 | * JAXB RI 1.0.2 |
aoqi@0 | 176 | */ |
aoqi@0 | 177 | public String[] getPreDeclaredNamespaceUris() { |
aoqi@0 | 178 | return EMPTY_STRING; |
aoqi@0 | 179 | } |
aoqi@0 | 180 | |
aoqi@0 | 181 | /** |
aoqi@0 | 182 | * Similar to {@link #getPreDeclaredNamespaceUris()} but allows the |
aoqi@0 | 183 | * (prefix,nsUri) pairs to be returned. |
aoqi@0 | 184 | * |
aoqi@0 | 185 | * <p> |
aoqi@0 | 186 | * With {@link #getPreDeclaredNamespaceUris()}, applications who wish to control |
aoqi@0 | 187 | * the prefixes as well as the namespaces needed to implement both |
aoqi@0 | 188 | * {@link #getPreDeclaredNamespaceUris()} and {@link #getPreferredPrefix(String, String, boolean)}. |
aoqi@0 | 189 | * |
aoqi@0 | 190 | * <p> |
aoqi@0 | 191 | * This version eliminates the needs by returning an array of pairs. |
aoqi@0 | 192 | * |
aoqi@0 | 193 | * @return |
aoqi@0 | 194 | * always return a non-null (but possibly empty) array. The array stores |
aoqi@0 | 195 | * data like (prefix1,nsUri1,prefix2,nsUri2,...) Use an empty string to represent |
aoqi@0 | 196 | * the empty namespace URI and the default prefix. Null is not allowed as a value |
aoqi@0 | 197 | * in the array. |
aoqi@0 | 198 | * |
aoqi@0 | 199 | * @since |
aoqi@0 | 200 | * JAXB RI 2.0 beta |
aoqi@0 | 201 | */ |
aoqi@0 | 202 | public String[] getPreDeclaredNamespaceUris2() { |
aoqi@0 | 203 | return EMPTY_STRING; |
aoqi@0 | 204 | } |
aoqi@0 | 205 | |
aoqi@0 | 206 | /** |
aoqi@0 | 207 | * Returns a list of (prefix,namespace URI) pairs that represents |
aoqi@0 | 208 | * namespace bindings available on ancestor elements (that need not be repeated |
aoqi@0 | 209 | * by the JAXB RI.) |
aoqi@0 | 210 | * |
aoqi@0 | 211 | * <p> |
aoqi@0 | 212 | * Sometimes JAXB is used to marshal an XML document, which will be |
aoqi@0 | 213 | * used as a subtree of a bigger document. When this happens, it's nice |
aoqi@0 | 214 | * for a JAXB marshaller to be able to use in-scope namespace bindings |
aoqi@0 | 215 | * of the larger document and avoid declaring redundant namespace URIs. |
aoqi@0 | 216 | * |
aoqi@0 | 217 | * <p> |
aoqi@0 | 218 | * This is automatically done when you are marshalling to {@link XMLStreamWriter}, |
aoqi@0 | 219 | * {@link XMLEventWriter}, {@link DOMResult}, or {@link Node}, because |
aoqi@0 | 220 | * those output format allows us to inspect what's currently available |
aoqi@0 | 221 | * as in-scope namespace binding. However, with other output format, |
aoqi@0 | 222 | * such as {@link OutputStream}, the JAXB RI cannot do this automatically. |
aoqi@0 | 223 | * That's when this method comes into play. |
aoqi@0 | 224 | * |
aoqi@0 | 225 | * <p> |
aoqi@0 | 226 | * Namespace bindings returned by this method will be used by the JAXB RI, |
aoqi@0 | 227 | * but will not be re-declared. They are assumed to be available when you insert |
aoqi@0 | 228 | * this subtree into a bigger document. |
aoqi@0 | 229 | * |
aoqi@0 | 230 | * <p> |
aoqi@0 | 231 | * It is <b>NOT</b> OK to return the same binding, or give |
aoqi@0 | 232 | * the receiver a conflicting binding information. |
aoqi@0 | 233 | * It's a responsibility of the caller to make sure that this doesn't happen |
aoqi@0 | 234 | * even if the ancestor elements look like: |
aoqi@0 | 235 | * <pre><xmp> |
aoqi@0 | 236 | * <foo:abc xmlns:foo="abc"> |
aoqi@0 | 237 | * <foo:abc xmlns:foo="def"> |
aoqi@0 | 238 | * <foo:abc xmlns:foo="abc"> |
aoqi@0 | 239 | * ... JAXB marshalling into here. |
aoqi@0 | 240 | * </foo:abc> |
aoqi@0 | 241 | * </foo:abc> |
aoqi@0 | 242 | * </foo:abc> |
aoqi@0 | 243 | * </xmp></pre> |
aoqi@0 | 244 | * |
aoqi@0 | 245 | * @return |
aoqi@0 | 246 | * always return a non-null (but possibly empty) array. The array stores |
aoqi@0 | 247 | * data like (prefix1,nsUri1,prefix2,nsUri2,...) Use an empty string to represent |
aoqi@0 | 248 | * the empty namespace URI and the default prefix. Null is not allowed as a value |
aoqi@0 | 249 | * in the array. |
aoqi@0 | 250 | * |
aoqi@0 | 251 | * @since JAXB RI 2.0 beta |
aoqi@0 | 252 | */ |
aoqi@0 | 253 | public String[] getContextualNamespaceDecls() { |
aoqi@0 | 254 | return EMPTY_STRING; |
aoqi@0 | 255 | } |
aoqi@0 | 256 | } |