1 /*
2 * Copyright (c) 2003, 2017, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package javax.xml.bind;
27
28 import org.w3c.dom.Node;
29
30 import java.io.IOException;
31 import java.io.InputStream;
32 import java.util.Collections;
33 import java.util.Map;
34 import java.util.Properties;
35
36 /**
37 * The {@code JAXBContext} class provides the client's entry point to the
38 * JAXB API. It provides an abstraction for managing the XML/Java binding
39 * information necessary to implement the JAXB binding framework operations:
40 * unmarshal, marshal and validate.
41 *
42 * <p>A client application normally obtains new instances of this class using
43 * one of these two styles for newInstance methods, although there are other
44 * specialized forms of the method available:
45 *
46 * <ul>
47 * <li>{@link #newInstance(String, ClassLoader) JAXBContext.newInstance( "com.acme.foo:com.acme.bar" )} <br>
48 * The JAXBContext instance is initialized from a list of colon
49 * separated Java package names. Each java package contains
50 * JAXB mapped classes, schema-derived classes and/or user annotated
51 * classes. Additionally, the java package may contain JAXB package annotations
52 * that must be processed. (see JLS, Section 7.4.1 "Named Packages").
53 * </li>
54 * <li>{@link #newInstance(Class...) JAXBContext.newInstance( com.acme.foo.Foo.class )} <br>
55 * The JAXBContext instance is initialized with class(es)
56 * passed as parameter(s) and classes that are statically reachable from
57 * these class(es). See {@link #newInstance(Class...)} for details.
58 * </li>
59 * </ul>
60 *
61 * <p><i>
62 * The following JAXB 1.0 requirement is only required for schema to
63 * java interface/implementation binding. It does not apply to JAXB annotated
64 * classes. JAXB Providers must generate a {@code jaxb.properties} file in
65 * each package containing schema derived classes. The property file must
66 * contain a property named {@code javax.xml.bind.context.factory} whose
67 * value is the name of the class that implements the {@code createContext}
68 * APIs.</i>
69 *
70 * <p><i>
71 * The class supplied by the provider does not have to be assignable to
72 * {@code javax.xml.bind.JAXBContext}, it simply has to provide a class that
73 * implements the {@code createContext} APIs.</i>
74 *
75 * <p><i>
76 * In addition, the provider must call the
77 * {@link DatatypeConverter#setDatatypeConverter(DatatypeConverterInterface)
78 * DatatypeConverter.setDatatypeConverter} api prior to any client
79 * invocations of the marshal and unmarshal methods. This is necessary to
80 * configure the datatype converter that will be used during these operations.</i>
81 *
82 * <a name="Unmarshalling"></a>
83 * <h3>Unmarshalling</h3>
84 * <p>
85 * The {@link Unmarshaller} class provides the client application the ability
86 * to convert XML data into a tree of Java content objects.
87 * The unmarshal method allows for
88 * any global XML element declared in the schema to be unmarshalled as
89 * the root of an instance document.
90 * Additionally, the unmarshal method allows for an unrecognized root element that
91 * has an xsi:type attribute's value that references a type definition declared in
92 * the schema to be unmarshalled as the root of an instance document.
93 * The {@code JAXBContext} object
94 * allows the merging of global elements and type definitions across a set of schemas (listed
95 * in the {@code contextPath}). Since each schema in the schema set can belong
96 * to distinct namespaces, the unification of schemas to an unmarshalling
97 * context must be namespace independent. This means that a client
98 * application is able to unmarshal XML documents that are instances of
99 * any of the schemas listed in the {@code contextPath}. For example:
100 *
101 * <pre>
102 * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo:com.acme.bar" );
103 * Unmarshaller u = jc.createUnmarshaller();
104 * FooObject fooObj = (FooObject)u.unmarshal( new File( "foo.xml" ) ); // ok
105 * BarObject barObj = (BarObject)u.unmarshal( new File( "bar.xml" ) ); // ok
106 * BazObject bazObj = (BazObject)u.unmarshal( new File( "baz.xml" ) ); // error, "com.acme.baz" not in contextPath
107 * </pre>
108 *
109 * <p>
110 * The client application may also generate Java content trees explicitly rather
111 * than unmarshalling existing XML data. For all JAXB-annotated value classes,
112 * an application can create content using constructors.
113 * For schema-derived interface/implementation classes and for the
114 * creation of elements that are not bound to a JAXB-annotated
115 * class, an application needs to have access and knowledge about each of
116 * the schema derived {@code ObjectFactory} classes that exist in each of
117 * java packages contained in the {@code contextPath}. For each schema
118 * derived java class, there is a static factory method that produces objects
119 * of that type. For example,
120 * assume that after compiling a schema, you have a package {@code com.acme.foo}
121 * that contains a schema derived interface named {@code PurchaseOrder}. In
122 * order to create objects of that type, the client application would use the
123 * factory method like this:
124 *
125 * <pre>
126 * com.acme.foo.PurchaseOrder po =
127 * com.acme.foo.ObjectFactory.createPurchaseOrder();
128 * </pre>
129 *
130 * <p>
131 * Once the client application has an instance of the the schema derived object,
132 * it can use the mutator methods to set content on it.
133 *
134 * <p>
135 * For more information on the generated {@code ObjectFactory} classes, see
136 * Section 4.2 <i>Java Package</i> of the specification.
137 *
138 * <p>
139 * <i>The provider must generate a class in each
140 * package that contains all of the necessary object factory methods for that
141 * package named ObjectFactory as well as the static
142 * {@code newInstance( javaContentInterface )} method</i>
143 *
144 * <h3>Marshalling</h3>
145 * <p>
146 * The {@link Marshaller} class provides the client application the ability
147 * to convert a Java content tree back into XML data. There is no difference
148 * between marshalling a content tree that is created manually using the factory
149 * methods and marshalling a content tree that is the result an {@code unmarshal}
150 * operation. Clients can marshal a java content tree back to XML data
151 * to a {@code java.io.OutputStream} or a {@code java.io.Writer}. The
152 * marshalling process can alternatively produce SAX2 event streams to a
153 * registered {@code ContentHandler} or produce a DOM Node object.
154 * Client applications have control over the output encoding as well as
155 * whether or not to marshal the XML data as a complete document or
156 * as a fragment.
157 *
158 * <p>
159 * Here is a simple example that unmarshals an XML document and then marshals
160 * it back out:
161 *
162 * <pre>
163 * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
164 *
165 * // unmarshal from foo.xml
166 * Unmarshaller u = jc.createUnmarshaller();
167 * FooObject fooObj = (FooObject)u.unmarshal( new File( "foo.xml" ) );
168 *
169 * // marshal to System.out
170 * Marshaller m = jc.createMarshaller();
171 * m.marshal( fooObj, System.out );
172 * </pre>
173 *
174 *
175 * <h3>Validation</h3>
176 * <p>
177 * Validation has been changed significantly since JAXB 1.0. The {@link Validator}
178 * class has been deprecated and made optional. This means that you are advised
179 * not to use this class and, in fact, it may not even be available depending on
180 * your JAXB provider. JAXB 1.0 client applications that rely on {@code Validator}
181 * will still work properly when deployed with the JAXB 1.0 runtime system.
182 *
183 * In JAXB 2.0, the {@link Unmarshaller} has included convenince methods that expose
184 * the JAXP 1.3 {@link javax.xml.validation} framework. Please refer to the
185 * {@link Unmarshaller#setSchema(javax.xml.validation.Schema)} API for more
186 * information.
187 *
188 *
189 * <h3>JAXB Runtime Binding Framework Compatibility</h3>
190 * <p>
191 * The following JAXB 1.0 restriction only applies to binding schema to
192 * interfaces/implementation classes.
193 * Since this binding does not require a common runtime system, a JAXB
194 * client application must not attempt to mix runtime objects ({@code JAXBContext,
195 * Marshaller}, etc. ) from different providers. This does not
196 * mean that the client application isn't portable, it simply means that a
197 * client has to use a runtime system provided by the same provider that was
198 * used to compile the schema.
199 *
200 *
201 * <h3>Discovery of JAXB implementation</h3>
202 * <p>
203 * To create an instance of {@link JAXBContext}, one of {@code JAXBContext.newInstance(...)} methods is invoked. After
204 * JAX-B implementation is discovered, call is delegated to appropriate provider's method {@code createContext(...)}
205 * passing parameters from the original call.
206 * <p>
207 * JAX-B implementation discovery happens each time {@code JAXBContext.newInstance} is invoked. If there is no user
208 * specific configuration provided, default JAX-B provider must be returned.
209 * <p>
210 * Implementation discovery consists of following steps:
211 *
212 * <ol>
213 *
214 * <li>
215 * Packages/classes explicitly passed in to the {@link #newInstance} method are processed in the order they are
216 * specified, until {@code jaxb.properties} file is looked up in its package, by using the associated classloader —
217 * this is {@link Class#getClassLoader() the owner class loader} for a {@link Class} argument, and for a package
218 * the specified {@link ClassLoader}.
219 *
220 * <p>
221 * If such a resource is discovered, it is {@link Properties#load(InputStream) loaded} as a property file, and
222 * the value of the {@link #JAXB_CONTEXT_FACTORY} key will be assumed to be the provider factory class. If no value
223 * found, {@code "javax.xml.bind.context.factory"} is used as a key for backwards compatibility reasons. This class is
224 * then loaded by the associated class loader discussed above.
225 *
226 * <p>
227 * This phase of the look up allows some packages to force the use of a certain JAXB implementation.
228 * (For example, perhaps the schema compiler has generated some vendor extension in the code.)
229 *
230 * <li>
231 * If the system property {@link #JAXB_CONTEXT_FACTORY} exists, then its value is assumed to be the provider
232 * factory class. If no such property exists, properties {@code "javax.xml.bind.context.factory"} and
233 * {@code "javax.xml.bind.JAXBContext"} are checked too (in this order), for backwards compatibility reasons. This phase
234 * of the look up enables per-JVM override of the JAXB implementation.
235 *
236 * <li>
237 * Provider of {@link javax.xml.bind.JAXBContextFactory} is loaded using the service-provider loading
238 * facilities, defined by the {@link java.util.ServiceLoader} class, to attempt
239 * to locate and load an implementation of the service using the {@linkplain
240 * java.util.ServiceLoader#load(java.lang.Class) default loading mechanism}: the service-provider loading facility
241 * will use the {@linkplain java.lang.Thread#getContextClassLoader() current thread's context class loader}
242 * to attempt to load the context factory. If the context class loader is null, the
243 * {@linkplain ClassLoader#getSystemClassLoader() system class loader} will be used.
244 * <br>
245 * In case of {@link java.util.ServiceConfigurationError service
246 * configuration error} a {@link javax.xml.bind.JAXBException} will be thrown.
247 *
248 * <li>
249 * Look for resource {@code /META-INF/services/javax.xml.bind.JAXBContext} using provided class loader.
250 * Methods without class loader parameter use {@code Thread.currentThread().getContextClassLoader()}.
251 * If such a resource exists, its content is assumed to be the provider factory class.
252 *
253 * This configuration method is deprecated.
254 *
255 * <li>
256 * Finally, if all the steps above fail, then the rest of the look up is unspecified. That said,
257 * the recommended behavior is to simply look for some hard-coded platform default JAXB implementation.
258 * This phase of the look up is so that Java SE can have its own JAXB implementation as the last resort.
259 * </ol>
260 *
261 * <p>
262 * Once the provider factory class is discovered, context creation is delegated to one of its
263 * {@code createContext(...)} methods.
264 *
265 * For backward compatibility reasons, there are two ways how to implement provider factory class:
266 * <ol>
267 * <li>the class is implementation of {@link javax.xml.bind.JAXBContextFactory}. It must also implement no-arg
268 * constructor. If discovered in other step then 3, new instance using no-arg constructor is created first.
269 * After that, appropriate instance method is invoked on this instance.
270 * <li>the class is not implementation of interface above and then it is mandated to implement the following
271 * static method signatures:
272 * <pre>
273 *
274 * public static JAXBContext createContext(
275 * String contextPath,
276 * ClassLoader classLoader,
277 * Map<String,Object> properties ) throws JAXBException
278 *
279 * public static JAXBContext createContext(
280 * Class[] classes,
281 * Map<String,Object> properties ) throws JAXBException
282 * </pre>
283 * In this scenario, appropriate static method is used instead of instance method. This approach is incompatible
284 * with {@link java.util.ServiceLoader} so it can't be used with step 3.
285 * </ol>
286 * <p>
287 * There is no difference in behavior of given method {@code createContext(...)} regardless of whether it uses approach
288 * 1 (JAXBContextFactory) or 2 (no interface, static methods).
289 *
290 * @apiNote
291 * Service discovery method using resource {@code /META-INF/services/javax.xml.bind.JAXBContext} (described in step 4)
292 * is supported only to allow backwards compatibility, it is strongly recommended to migrate to standard
293 * {@link java.util.ServiceLoader} mechanism (described in step 3). The difference here is the resource name, which
294 * doesn't match service's type name.
295 * <p>
296 * Also using providers implementing interface {@link JAXBContextFactory} is preferred over using ones defining
297 * static methods, same as {@link JAXBContext#JAXB_CONTEXT_FACTORY} property is preferred over property
298 * {@code "javax.xml.bind.context.factory"}
299 *
300 * @implNote
301 * Within the last step, if Glassfish AS environment detected, its specific service loader is used to find factory class.
302 *
303 * @author <ul><li>Ryan Shoemaker, Sun Microsystems, Inc.</li>
304 * <li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li>
305 * <li>Joe Fialli, Sun Microsystems, Inc.</li></ul>
306 *
307 * @see Marshaller
308 * @see Unmarshaller
309 * @see <a href="http://docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1">S 7.4.1 "Named Packages"
310 * in Java Language Specification</a>
311 *
312 * @since 1.6, JAXB 1.0
313 */
314 public abstract class JAXBContext {
315
316 /**
317 * The name of the property that contains the name of the class capable
318 * of creating new {@code JAXBContext} objects.
319 */
320 public static final String JAXB_CONTEXT_FACTORY = "javax.xml.bind.JAXBContextFactory";
321
322 protected JAXBContext() {
323 }
324
325
326 /**
327 * Create a new instance of a {@code JAXBContext} class.
328 *
329 * <p>
330 * This is a convenience method to invoke the
331 * {@link #newInstance(String,ClassLoader)} method with
332 * the context class loader of the current thread.
333 *
334 * @throws JAXBException if an error was encountered while creating the
335 * {@code JAXBContext} such as
336 * <ol>
337 * <li>failure to locate either ObjectFactory.class or jaxb.index in the packages</li>
338 * <li>an ambiguity among global elements contained in the contextPath</li>
339 * <li>failure to locate a value for the context factory provider property</li>
340 * <li>mixing schema derived packages from different providers on the same contextPath</li>
341 * <li>packages are not open to {@code java.xml.bind} module</li>
342 * </ol>
343 */
344 public static JAXBContext newInstance( String contextPath )
345 throws JAXBException {
346
347 //return newInstance( contextPath, JAXBContext.class.getClassLoader() );
348 return newInstance( contextPath, getContextClassLoader());
349 }
350
351 /**
352 * Create a new instance of a {@code JAXBContext} class.
353 *
354 * <p>
355 * The client application must supply a context path which is a list of
356 * colon (':', \u005Cu003A) separated java package names that contain
357 * schema-derived classes and/or fully qualified JAXB-annotated classes.
358 * Schema-derived
359 * code is registered with the JAXBContext by the
360 * ObjectFactory.class generated per package.
361 * Alternatively than being listed in the context path, programmer
362 * annotated JAXB mapped classes can be listed in a
363 * {@code jaxb.index} resource file, format described below.
364 * Note that a java package can contain both schema-derived classes and
365 * user annotated JAXB classes. Additionally, the java package may
366 * contain JAXB package annotations that must be processed. (see JLS,
367 * Section 7.4.1 "Named Packages").
368 * </p>
369 *
370 * <p>
371 * Every package listed on the contextPath must meet <b>one or both</b> of the
372 * following conditions otherwise a {@code JAXBException} will be thrown:
373 * </p>
374 * <ol>
375 * <li>it must contain ObjectFactory.class</li>
376 * <li>it must contain jaxb.index</li>
377 * </ol>
378 *
379 * <p>
380 * <b>Format for jaxb.index</b>
381 * <p>
382 * The file contains a newline-separated list of class names.
383 * Space and tab characters, as well as blank
384 * lines, are ignored. The comment character
385 * is '#' (0x23); on each line all characters following the first comment
386 * character are ignored. The file must be encoded in UTF-8. Classes that
387 * are reachable, as defined in {@link #newInstance(Class...)}, from the
388 * listed classes are also registered with JAXBContext.
389 * <p>
390 * Constraints on class name occuring in a {@code jaxb.index} file are:
391 * <ul>
392 * <li>Must not end with ".class".</li>
393 * <li>Class names are resolved relative to package containing
394 * {@code jaxb.index} file. Only classes occuring directly in package
395 * containing {@code jaxb.index} file are allowed.</li>
396 * <li>Fully qualified class names are not allowed.
397 * A qualified class name,relative to current package,
398 * is only allowed to specify a nested or inner class.</li>
399 * </ul>
400 *
401 * <p>
402 * To maintain compatibility with JAXB 1.0 schema to java
403 * interface/implementation binding, enabled by schema customization
404 * {@code <jaxb:globalBindings valueClass="false">},
405 * the JAXB provider will ensure that each package on the context path
406 * has a {@code jaxb.properties} file which contains a value for the
407 * {@code javax.xml.bind.context.factory} property and that all values
408 * resolve to the same provider. This requirement does not apply to
409 * JAXB annotated classes.
410 *
411 * <p>
412 * If there are any global XML element name collisions across the various
413 * packages listed on the {@code contextPath}, a {@code JAXBException}
414 * will be thrown.
415 *
416 * <p>
417 * Mixing generated interface/impl bindings from multiple JAXB Providers
418 * in the same context path may result in a {@code JAXBException}
419 * being thrown.
420 *
421 * <p>
422 * The steps involved in discovering the JAXB implementation is discussed in the class javadoc.
423 *
424 * @param contextPath
425 * List of java package names that contain schema
426 * derived class and/or java to schema (JAXB-annotated)
427 * mapped classes.
428 * Packages in {@code contextPath} that are in named modules must be
429 * {@linkplain java.lang.reflect.Module#isOpen open} to at least the {@code java.xml.bind} module.
430 * @param classLoader
431 * This class loader will be used to locate the implementation
432 * classes.
433 *
434 * @return a new instance of a {@code JAXBContext}
435 * @throws JAXBException if an error was encountered while creating the
436 * {@code JAXBContext} such as
437 * <ol>
438 * <li>failure to locate either ObjectFactory.class or jaxb.index in the packages</li>
439 * <li>an ambiguity among global elements contained in the contextPath</li>
440 * <li>failure to locate a value for the context factory provider property</li>
441 * <li>mixing schema derived packages from different providers on the same contextPath</li>
442 * <li>packages are not open to {@code java.xml.bind} module</li>
443 * </ol>
444 */
445 public static JAXBContext newInstance( String contextPath, ClassLoader classLoader ) throws JAXBException {
446
447 return newInstance(contextPath,classLoader,Collections.<String,Object>emptyMap());
448 }
449
450 /**
451 * Create a new instance of a {@code JAXBContext} class.
452 *
453 * <p>
454 * This is mostly the same as {@link JAXBContext#newInstance(String, ClassLoader)},
455 * but this version allows you to pass in provider-specific properties to configure
456 * the instantiation of {@link JAXBContext}.
457 *
458 * <p>
459 * The interpretation of properties is up to implementations. Implementations must
460 * throw {@code JAXBException} if it finds properties that it doesn't understand.
461 *
462 * @param contextPath
463 * List of java package names that contain schema
464 * derived class and/or java to schema (JAXB-annotated)
465 * mapped classes.
466 * Packages in {@code contextPath} that are in named modules must be
467 * {@linkplain java.lang.reflect.Module#isOpen open} to at least the {@code java.xml.bind} module.
468 * @param classLoader
469 * This class loader will be used to locate the implementation classes.
470 * @param properties
471 * provider-specific properties. Can be null, which means the same thing as passing
472 * in an empty map.
473 *
474 * @return a new instance of a {@code JAXBContext}
475 * @throws JAXBException if an error was encountered while creating the
476 * {@code JAXBContext} such as
477 * <ol>
478 * <li>failure to locate either ObjectFactory.class or jaxb.index in the packages</li>
479 * <li>an ambiguity among global elements contained in the contextPath</li>
480 * <li>failure to locate a value for the context factory provider property</li>
481 * <li>mixing schema derived packages from different providers on the same contextPath</li>
482 * <li>packages are not open to {@code java.xml.bind} module</li>
483 * </ol>
484 * @since 1.6, JAXB 2.0
485 */
486 public static JAXBContext newInstance( String contextPath,
487 ClassLoader classLoader,
488 Map<String,?> properties ) throws JAXBException {
489
490 return ContextFinder.find(
491 /* The default property name according to the JAXB spec */
492 JAXB_CONTEXT_FACTORY,
493
494 /* the context path supplied by the client app */
495 contextPath,
496
497 /* class loader to be used */
498 classLoader,
499 properties );
500 }
501
502 // TODO: resurrect this once we introduce external annotations
503 // /**
504 // * Create a new instance of a {@code JAXBContext} class.
505 // *
506 // * <p>
507 // * The client application must supply a list of classes that the new
508 // * context object needs to recognize.
509 // *
510 // * Not only the new context will recognize all the classes specified,
511 // * but it will also recognize any classes that are directly/indirectly
512 // * referenced statically from the specified classes.
513 // *
514 // * For example, in the following Java code, if you do
515 // * {@code newInstance(Foo.class)}, the newly created {@link JAXBContext}
516 // * will recognize both {@code Foo} and {@code Bar}, but not {@code Zot}:
517 // * <pre>
518 // * class Foo {
519 // * Bar b;
520 // * }
521 // * class Bar { int x; }
522 // * class Zot extends Bar { int y; }
523 // * </pre>
524 // *
525 // * Therefore, a typical client application only needs to specify the
526 // * top-level classes, but it needs to be careful.
527 // *
528 // * TODO: if we are to define other mechanisms, refer to them.
529 // *
530 // * @param externalBindings
531 // * list of external binding files. Can be null or empty if none is used.
532 // * when specified, those files determine how the classes are bound.
533 // *
534 // * @param classesToBeBound
535 // * list of java classes to be recognized by the new {@link JAXBContext}.
536 // * Can be empty, in which case a {@link JAXBContext} that only knows about
537 // * spec-defined classes will be returned.
538 // *
539 // * @return
540 // * A new instance of a {@code JAXBContext}.
541 // *
542 // * @throws JAXBException
543 // * if an error was encountered while creating the
544 // * {@code JAXBContext}, such as (but not limited to):
545 // * <ol>
546 // * <li>No JAXB implementation was discovered
547 // * <li>Classes use JAXB annotations incorrectly
548 // * <li>Classes have colliding annotations (i.e., two classes with the same type name)
549 // * <li>Specified external bindings are incorrect
550 // * <li>The JAXB implementation was unable to locate
551 // * provider-specific out-of-band information (such as additional
552 // * files generated at the development time.)
553 // * </ol>
554 // *
555 // * @throws IllegalArgumentException
556 // * if the parameter contains {@code null} (i.e., {@code newInstance(null);})
557 // *
558 // * @since JAXB 2.0
559 // */
560 // public static JAXBContext newInstance( Source[] externalBindings, Class... classesToBeBound )
561 // throws JAXBException {
562 //
563 // // empty class list is not an error, because the context will still include
564 // // spec-specified classes like String and Integer.
565 // // if(classesToBeBound.length==0)
566 // // throw new IllegalArgumentException();
567 //
568 // // but it is an error to have nulls in it.
569 // for( int i=classesToBeBound.length-1; i>=0; i-- )
570 // if(classesToBeBound[i]==null)
571 // throw new IllegalArgumentException();
572 //
573 // return ContextFinder.find(externalBindings,classesToBeBound);
574 // }
575
576 /**
577 * Create a new instance of a {@code JAXBContext} class.
578 *
579 * <p>
580 * The client application must supply a list of classes that the new
581 * context object needs to recognize.
582 *
583 * Not only the new context will recognize all the classes specified,
584 * but it will also recognize any classes that are directly/indirectly
585 * referenced statically from the specified classes. Subclasses of
586 * referenced classes nor {@code @XmlTransient} referenced classes
587 * are not registered with JAXBContext.
588 *
589 * For example, in the following Java code, if you do
590 * {@code newInstance(Foo.class)}, the newly created {@link JAXBContext}
591 * will recognize both {@code Foo} and {@code Bar}, but not {@code Zot} or {@code FooBar}:
592 * <pre>
593 * class Foo {
594 * @XmlTransient FooBar c;
595 * Bar b;
596 * }
597 * class Bar { int x; }
598 * class Zot extends Bar { int y; }
599 * class FooBar { }
600 * </pre>
601 *
602 * Therefore, a typical client application only needs to specify the
603 * top-level classes, but it needs to be careful.
604 *
605 * <p>
606 * Note that for each java package registered with JAXBContext,
607 * when the optional package annotations exist, they must be processed.
608 * (see JLS, Section 7.4.1 "Named Packages").
609 *
610 * <p>
611 * The steps involved in discovering the JAXB implementation is discussed in the class javadoc.
612 *
613 * @param classesToBeBound
614 * List of java classes to be recognized by the new {@link JAXBContext}.
615 * Classes in {@code classesToBeBound} that are in named modules must be in a package
616 * that is {@linkplain java.lang.reflect.Module#isOpen open} to at least the {@code java.xml.bind} module.
617 * Can be empty, in which case a {@link JAXBContext} that only knows about
618 * spec-defined classes will be returned.
619 *
620 * @return
621 * A new instance of a {@code JAXBContext}.
622 *
623 * @throws JAXBException
624 * if an error was encountered while creating the
625 * {@code JAXBContext}, such as (but not limited to):
626 * <ol>
627 * <li>No JAXB implementation was discovered
628 * <li>Classes use JAXB annotations incorrectly
629 * <li>Classes have colliding annotations (i.e., two classes with the same type name)
630 * <li>The JAXB implementation was unable to locate
631 * provider-specific out-of-band information (such as additional
632 * files generated at the development time.)
633 * <li>{@code classesToBeBound} are not open to {@code java.xml.bind} module
634 * </ol>
635 *
636 * @throws IllegalArgumentException
637 * if the parameter contains {@code null} (i.e., {@code newInstance(null);})
638 *
639 * @since 1.6, JAXB 2.0
640 */
641 public static JAXBContext newInstance( Class<?> ... classesToBeBound )
642 throws JAXBException {
643
644 return newInstance(classesToBeBound,Collections.<String,Object>emptyMap());
645 }
646
647 /**
648 * Create a new instance of a {@code JAXBContext} class.
649 *
650 * <p>
651 * An overloading of {@link JAXBContext#newInstance(Class...)}
652 * to configure 'properties' for this instantiation of {@link JAXBContext}.
653 *
654 * <p>
655 * The interpretation of properties is up to implementations. Implementations must
656 * throw {@code JAXBException} if it finds properties that it doesn't understand.
657 *
658 * @param classesToBeBound
659 * List of java classes to be recognized by the new {@link JAXBContext}.
660 * Classes in {@code classesToBeBound} that are in named modules must be in a package
661 * that is {@linkplain java.lang.reflect.Module#isOpen open} to at least the {@code java.xml.bind} module.
662 * Can be empty, in which case a {@link JAXBContext} that only knows about
663 * spec-defined classes will be returned.
664 * @param properties
665 * provider-specific properties. Can be null, which means the same thing as passing
666 * in an empty map.
667 *
668 * @return
669 * A new instance of a {@code JAXBContext}.
670 *
671 * @throws JAXBException
672 * if an error was encountered while creating the
673 * {@code JAXBContext}, such as (but not limited to):
674 * <ol>
675 * <li>No JAXB implementation was discovered
676 * <li>Classes use JAXB annotations incorrectly
677 * <li>Classes have colliding annotations (i.e., two classes with the same type name)
678 * <li>The JAXB implementation was unable to locate
679 * provider-specific out-of-band information (such as additional
680 * files generated at the development time.)
681 * <li>{@code classesToBeBound} are not open to {@code java.xml.bind} module
682 * </ol>
683 *
684 * @throws IllegalArgumentException
685 * if the parameter contains {@code null} (i.e., {@code newInstance(null,someMap);})
686 *
687 * @since 1.6, JAXB 2.0
688 */
689 public static JAXBContext newInstance( Class<?>[] classesToBeBound, Map<String,?> properties )
690 throws JAXBException {
691
692 if (classesToBeBound == null) {
693 throw new IllegalArgumentException();
694 }
695
696 // but it is an error to have nulls in it.
697 for (int i = classesToBeBound.length - 1; i >= 0; i--) {
698 if (classesToBeBound[i] == null) {
699 throw new IllegalArgumentException();
700 }
701 }
702
703 return ContextFinder.find(classesToBeBound,properties);
704 }
705
706 /**
707 * Create an {@code Unmarshaller} object that can be used to convert XML
708 * data into a java content tree.
709 *
710 * @return an {@code Unmarshaller} object
711 *
712 * @throws JAXBException if an error was encountered while creating the
713 * {@code Unmarshaller} object
714 */
715 public abstract Unmarshaller createUnmarshaller() throws JAXBException;
716
717
718 /**
719 * Create a {@code Marshaller} object that can be used to convert a
720 * java content tree into XML data.
721 *
722 * @return a {@code Marshaller} object
723 *
724 * @throws JAXBException if an error was encountered while creating the
725 * {@code Marshaller} object
726 */
727 public abstract Marshaller createMarshaller() throws JAXBException;
728
729
730 /**
731 * {@link Validator} has been made optional and deprecated in JAXB 2.0. Please
732 * refer to the javadoc for {@link Validator} for more detail.
733 * <p>
734 * Create a {@code Validator} object that can be used to validate a
735 * java content tree against its source schema.
736 *
737 * @return a {@code Validator} object
738 *
739 * @throws JAXBException if an error was encountered while creating the
740 * {@code Validator} object
741 * @deprecated since JAXB2.0
742 */
743 public abstract Validator createValidator() throws JAXBException;
744
745 /**
746 * Creates a {@code Binder} object that can be used for
747 * associative/in-place unmarshalling/marshalling.
748 *
749 * @param domType select the DOM API to use by passing in its DOM Node class.
750 *
751 * @return always a new valid {@code Binder} object.
752 *
753 * @throws UnsupportedOperationException
754 * if DOM API corresponding to {@code domType} is not supported by
755 * the implementation.
756 *
757 * @since 1.6, JAXB 2.0
758 */
759 public <T> Binder<T> createBinder(Class<T> domType) {
760 // to make JAXB 1.0 implementations work, this method must not be
761 // abstract
762 throw new UnsupportedOperationException();
763 }
764
765 /**
766 * Creates a {@code Binder} for W3C DOM.
767 *
768 * @return always a new valid {@code Binder} object.
769 *
770 * @since 1.6, JAXB 2.0
771 */
772 public Binder<Node> createBinder() {
773 return createBinder(Node.class);
774 }
775
776 /**
777 * Creates a {@code JAXBIntrospector} object that can be used to
778 * introspect JAXB objects.
779 *
780 * @return
781 * always return a non-null valid {@code JAXBIntrospector} object.
782 *
783 * @throws UnsupportedOperationException
784 * Calling this method on JAXB 1.0 implementations will throw
785 * an UnsupportedOperationException.
786 *
787 * @since 1.6, JAXB 2.0
788 */
789 public JAXBIntrospector createJAXBIntrospector() {
790 // to make JAXB 1.0 implementations work, this method must not be
791 // abstract
792 throw new UnsupportedOperationException();
793 }
794
795 /**
796 * Generates the schema documents for this context.
797 *
798 * @param outputResolver
799 * this object controls the output to which schemas
800 * will be sent.
801 *
802 * @throws IOException
803 * if {@link SchemaOutputResolver} throws an {@link IOException}.
804 *
805 * @throws UnsupportedOperationException
806 * Calling this method on JAXB 1.0 implementations will throw
807 * an UnsupportedOperationException.
808 *
809 * @since 1.6, JAXB 2.0
810 */
811 public void generateSchema(SchemaOutputResolver outputResolver) throws IOException {
812 // to make JAXB 1.0 implementations work, this method must not be
813 // abstract
814 throw new UnsupportedOperationException();
815 }
816
817 private static ClassLoader getContextClassLoader() {
818 if (System.getSecurityManager() == null) {
819 return Thread.currentThread().getContextClassLoader();
820 } else {
821 return java.security.AccessController.doPrivileged(
822 new java.security.PrivilegedAction<ClassLoader>() {
823 public ClassLoader run() {
824 return Thread.currentThread().getContextClassLoader();
825 }
826 });
827 }
828 }
829
830 }