1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 *
4 * This code is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 only, as
6 * published by the Free Software Foundation. Oracle designates this
7 * particular file as subject to the "Classpath" exception as provided
8 * by Oracle in the LICENSE file that accompanied this code.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * questions.
23 */
24
25 /*
26 * Copyright (c) 2009, 2013, by Oracle Corporation. All Rights Reserved.
27 */
28
29 package javax.xml.stream;
30
31 import javax.xml.stream.util.XMLEventAllocator;
32 import javax.xml.transform.Source;
33
34 /**
35 * Defines an abstract implementation of a factory for getting streams.
36 *
37 * The following table defines the standard properties of this specification.
38 * Each property varies in the level of support required by each implementation.
39 * The level of support required is described in the 'Required' column.
40 *
41 * <table border="2" rules="all" cellpadding="4">
42 * <thead>
43 * <tr>
44 * <th align="center" colspan="5">
45 * Configuration parameters
46 * </th>
47 * </tr>
48 * </thead>
49 * <tbody>
50 * <tr>
51 * <th>Property Name</th>
52 * <th>Behavior</th>
53 * <th>Return type</th>
54 * <th>Default Value</th>
55 * <th>Required</th>
56 * </tr>
57 * <tr><td>javax.xml.stream.isValidating</td><td>Turns on/off implementation specific DTD validation</td><td>Boolean</td><td>False</td><td>No</td></tr>
58 * <tr><td>javax.xml.stream.isNamespaceAware</td><td>Turns on/off namespace processing for XML 1.0 support</td><td>Boolean</td><td>True</td><td>True (required) / False (optional)</td></tr>
59 * <tr><td>javax.xml.stream.isCoalescing</td><td>Requires the processor to coalesce adjacent character data</td><td>Boolean</td><td>False</td><td>Yes</td></tr>
60 * <tr><td>javax.xml.stream.isReplacingEntityReferences</td><td>replace internal entity references with their replacement text and report them as characters</td><td>Boolean</td><td>True</td><td>Yes</td></tr>
61 *<tr><td>javax.xml.stream.isSupportingExternalEntities</td><td>Resolve external parsed entities</td><td>Boolean</td><td>Unspecified</td><td>Yes</td></tr>
62 *<tr><td>javax.xml.stream.supportDTD</td><td>Use this property to request processors that do not support DTDs</td><td>Boolean</td><td>True</td><td>Yes</td></tr>
63 *<tr><td>javax.xml.stream.reporter</td><td>sets/gets the impl of the XMLReporter </td><td>javax.xml.stream.XMLReporter</td><td>Null</td><td>Yes</td></tr>
64 *<tr><td>javax.xml.stream.resolver</td><td>sets/gets the impl of the XMLResolver interface</td><td>javax.xml.stream.XMLResolver</td><td>Null</td><td>Yes</td></tr>
65 *<tr><td>javax.xml.stream.allocator</td><td>sets/gets the impl of the XMLEventAllocator interface</td><td>javax.xml.stream.util.XMLEventAllocator</td><td>Null</td><td>Yes</td></tr>
66 * </tbody>
67 * </table>
68 *
69 *
70 * @version 1.2
71 * @author Copyright (c) 2009, 2015 by Oracle Corporation. All Rights Reserved.
72 * @see XMLOutputFactory
73 * @see XMLEventReader
74 * @see XMLStreamReader
75 * @see EventFilter
76 * @see XMLReporter
77 * @see XMLResolver
78 * @see javax.xml.stream.util.XMLEventAllocator
79 * @since 1.6
80 */
81
82 public abstract class XMLInputFactory {
83 /**
84 * The property used to turn on/off namespace support,
85 * this is to support XML 1.0 documents,
86 * only the true setting must be supported
87 */
88 public static final String IS_NAMESPACE_AWARE=
89 "javax.xml.stream.isNamespaceAware";
90
91 /**
92 * The property used to turn on/off implementation specific validation
93 */
94 public static final String IS_VALIDATING=
95 "javax.xml.stream.isValidating";
96
97 /**
98 * The property that requires the parser to coalesce adjacent character data sections
99 */
100 public static final String IS_COALESCING=
101 "javax.xml.stream.isCoalescing";
102
103 /**
104 * Requires the parser to replace internal
105 * entity references with their replacement
106 * text and report them as characters
107 */
108 public static final String IS_REPLACING_ENTITY_REFERENCES=
109 "javax.xml.stream.isReplacingEntityReferences";
110
111 /**
112 * The property that requires the parser to resolve external parsed entities
113 */
114 public static final String IS_SUPPORTING_EXTERNAL_ENTITIES=
115 "javax.xml.stream.isSupportingExternalEntities";
116
117 /**
118 * The property that requires the parser to support DTDs
119 */
120 public static final String SUPPORT_DTD=
121 "javax.xml.stream.supportDTD";
122
123 /**
124 * The property used to
125 * set/get the implementation of the XMLReporter interface
126 */
127 public static final String REPORTER=
128 "javax.xml.stream.reporter";
129
130 /**
131 * The property used to set/get the implementation of the XMLResolver
132 */
133 public static final String RESOLVER=
134 "javax.xml.stream.resolver";
135
136 /**
137 * The property used to set/get the implementation of the allocator
138 */
139 public static final String ALLOCATOR=
140 "javax.xml.stream.allocator";
141
142 static final String DEFAULIMPL = "com.sun.xml.internal.stream.XMLInputFactoryImpl";
143
144 protected XMLInputFactory(){}
145
146 /**
147 * Creates a new instance of the factory in exactly the same manner as the
148 * {@link #newFactory()} method.
149 * @throws FactoryConfigurationError if an instance of this factory cannot be loaded
150 */
151 public static XMLInputFactory newInstance()
152 throws FactoryConfigurationError
153 {
154 return FactoryFinder.find(XMLInputFactory.class, DEFAULIMPL);
155 }
156
157 /**
158 * Create a new instance of the factory.
159 * <p>
160 * This static method creates a new factory instance.
161 * This method uses the following ordered lookup procedure to determine
162 * the XMLInputFactory implementation class to load:
163 *
164 * <ul>
165 * <li>
166 * <p>Use the javax.xml.stream.XMLInputFactory system property.
167 * </li>
168 * <li>
169 * <p>Use the configuration file "stax.properties". The file is in standard
170 * {@link java.util.Properties} format and typically located in the
171 * {@code conf} directory of the Java installation. It contains the fully qualified
172 * name of the implementation class with the key being the system property
173 * defined above.
174 *
175 * <p>The stax.properties file is read only once by the implementation
176 * and its values are then cached for future use. If the file does not exist
177 * when the first attempt is made to read from it, no further attempts are
178 * made to check for its existence. It is not possible to change the value
179 * of any property in stax.properties after it has been read for the first time.
180 *
181 * <p>
182 * Use the jaxp configuration file "jaxp.properties". The file is in the same
183 * format as stax.properties and will only be read if stax.properties does
184 * not exist.
185 * </li>
186 * <li>
187 * <p>Use the service-provider loading facility, defined by the
188 * {@link java.util.ServiceLoader} class, to attempt to locate and load an
189 * implementation of the service using the {@linkplain
190 * java.util.ServiceLoader#load(java.lang.Class) default loading mechanism}:
191 * the service-provider loading facility will use the {@linkplain
192 * java.lang.Thread#getContextClassLoader() current thread's context class loader}
193 * to attempt to load the service. If the context class
194 * loader is null, the {@linkplain
195 * ClassLoader#getSystemClassLoader() system class loader} will be used.
196 * </li>
197 * <li>
198 * <p>Otherwise, the system-default implementation is returned.
199 * </li>
200 * </ul>
201 * <p>
202 * Once an application has obtained a reference to a XMLInputFactory it
203 * can use the factory to configure and obtain stream instances.
204 * <p>
205 * Note that this is a new method that replaces the deprecated newInstance() method.
206 * No changes in behavior are defined by this replacement method relative to
207 * the deprecated method.
208 *
209 * @throws FactoryConfigurationError in case of {@linkplain
210 * java.util.ServiceConfigurationError service configuration error} or if
211 * the implementation is not available or cannot be instantiated.
212 */
213 public static XMLInputFactory newFactory()
214 throws FactoryConfigurationError
215 {
216 return FactoryFinder.find(XMLInputFactory.class, DEFAULIMPL);
217 }
218
219 /**
220 * Create a new instance of the factory
221 *
222 * @param factoryId Name of the factory to find, same as
223 * a property name
224 * @param classLoader classLoader to use
225 * @return the factory implementation
226 * @throws FactoryConfigurationError if an instance of this factory cannot be loaded
227 *
228 * @deprecated This method has been deprecated to maintain API consistency.
229 * All newInstance methods have been replaced with corresponding
230 * newFactory methods. The replacement {@link
231 * #newFactory(java.lang.String, java.lang.ClassLoader)} method
232 * defines no changes in behavior.
233 */
234 public static XMLInputFactory newInstance(String factoryId,
235 ClassLoader classLoader)
236 throws FactoryConfigurationError {
237 //do not fallback if given classloader can't find the class, throw exception
238 return FactoryFinder.find(XMLInputFactory.class, factoryId, classLoader, null);
239 }
240
241 /**
242 * Create a new instance of the factory.
243 * If the classLoader argument is null, then the ContextClassLoader is used.
244 * <p>
245 * This method uses the following ordered lookup procedure to determine
246 * the XMLInputFactory implementation class to load:
247 * <ul>
248 * <li>
249 * <p>
250 * Use the value of the system property identified by {@code factoryId}.
251 * </li>
252 * <li>
253 * <p>
254 * Use the configuration file "stax.properties". The file is in standard
255 * {@link java.util.Properties} format and typically located in the
256 * {@code conf} directory of the Java installation. It contains the fully qualified
257 * name of the implementation class with the key being the system property
258 * defined above.
259 *
260 * <p>
261 * The stax.properties file is read only once by the implementation
262 * and its values are then cached for future use. If the file does not exist
263 * when the first attempt is made to read from it, no further attempts are
264 * made to check for its existence. It is not possible to change the value
265 * of any property in stax.properties after it has been read for the first time.
266 *
267 * <p>
268 * Use the jaxp configuration file "jaxp.properties". The file is in the same
269 * format as stax.properties and will only be read if stax.properties does
270 * not exist.
271 * </li>
272 * <li>
273 * <p>
274 * If {@code factoryId} is "javax.xml.stream.XMLInputFactory",
275 * use the service-provider loading facility, defined by the
276 * {@link java.util.ServiceLoader} class, to attempt to {@linkplain
277 * java.util.ServiceLoader#load(java.lang.Class, java.lang.ClassLoader) locate and load}
278 * an implementation of the service using the specified {@code ClassLoader}.
279 * If {@code classLoader} is null, the {@linkplain
280 * java.util.ServiceLoader#load(java.lang.Class) default loading mechanism} will apply:
281 * That is, the service-provider loading facility will use the {@linkplain
282 * java.lang.Thread#getContextClassLoader() current thread's context class loader}
283 * to attempt to load the service. If the context class
284 * loader is null, the {@linkplain
285 * ClassLoader#getSystemClassLoader() system class loader} will be used.
286 * </li>
287 * <li>
288 * <p>
289 * Otherwise, throws a {@link FactoryConfigurationError}.
290 * </li>
291 * </ul>
292 *
293 * <p>
294 * Note that this is a new method that replaces the deprecated
295 * {@link #newInstance(java.lang.String, java.lang.ClassLoader)
296 * newInstance(String factoryId, ClassLoader classLoader)} method.
297 * No changes in behavior are defined by this replacement method relative
298 * to the deprecated method.
299 *
300 *
301 * @apiNote The parameter factoryId defined here is inconsistent with that
302 * of other JAXP factories where the first parameter is fully qualified
303 * factory class name that provides implementation of the factory.
304 *
305 * @param factoryId Name of the factory to find, same as
306 * a property name
307 * @param classLoader classLoader to use
308 * @return the factory implementation
309 * @throws FactoryConfigurationError in case of {@linkplain
310 * java.util.ServiceConfigurationError service configuration error} or if
311 * the implementation is not available or cannot be instantiated.
312 * @throws FactoryConfigurationError if an instance of this factory cannot be loaded
313 */
314 public static XMLInputFactory newFactory(String factoryId,
315 ClassLoader classLoader)
316 throws FactoryConfigurationError {
317 //do not fallback if given classloader can't find the class, throw exception
318 return FactoryFinder.find(XMLInputFactory.class, factoryId, classLoader, null);
319 }
320
321 /**
322 * Create a new XMLStreamReader from a reader
323 * @param reader the XML data to read from
324 * @throws XMLStreamException
325 */
326 public abstract XMLStreamReader createXMLStreamReader(java.io.Reader reader)
327 throws XMLStreamException;
328
329 /**
330 * Create a new XMLStreamReader from a JAXP source. This method is optional.
331 * @param source the source to read from
332 * @throws UnsupportedOperationException if this method is not
333 * supported by this XMLInputFactory
334 * @throws XMLStreamException
335 */
336 public abstract XMLStreamReader createXMLStreamReader(Source source)
337 throws XMLStreamException;
338
339 /**
340 * Create a new XMLStreamReader from a java.io.InputStream
341 * @param stream the InputStream to read from
342 * @throws XMLStreamException
343 */
344 public abstract XMLStreamReader createXMLStreamReader(java.io.InputStream stream)
345 throws XMLStreamException;
346
347 /**
348 * Create a new XMLStreamReader from a java.io.InputStream
349 * @param stream the InputStream to read from
350 * @param encoding the character encoding of the stream
351 * @throws XMLStreamException
352 */
353 public abstract XMLStreamReader createXMLStreamReader(java.io.InputStream stream, String encoding)
354 throws XMLStreamException;
355
356 /**
357 * Create a new XMLStreamReader from a java.io.InputStream
358 * @param systemId the system ID of the stream
359 * @param stream the InputStream to read from
360 */
361 public abstract XMLStreamReader createXMLStreamReader(String systemId, java.io.InputStream stream)
362 throws XMLStreamException;
363
364 /**
365 * Create a new XMLStreamReader from a java.io.InputStream
366 * @param systemId the system ID of the stream
367 * @param reader the InputStream to read from
368 */
369 public abstract XMLStreamReader createXMLStreamReader(String systemId, java.io.Reader reader)
370 throws XMLStreamException;
371
372 /**
373 * Create a new XMLEventReader from a reader
374 * @param reader the XML data to read from
375 * @throws XMLStreamException
376 */
377 public abstract XMLEventReader createXMLEventReader(java.io.Reader reader)
378 throws XMLStreamException;
379
380 /**
381 * Create a new XMLEventReader from a reader
382 * @param systemId the system ID of the input
383 * @param reader the XML data to read from
384 * @throws XMLStreamException
385 */
386 public abstract XMLEventReader createXMLEventReader(String systemId, java.io.Reader reader)
387 throws XMLStreamException;
388
389 /**
390 * Create a new XMLEventReader from an XMLStreamReader. After being used
391 * to construct the XMLEventReader instance returned from this method
392 * the XMLStreamReader must not be used.
393 * @param reader the XMLStreamReader to read from (may not be modified)
394 * @return a new XMLEventReader
395 * @throws XMLStreamException
396 */
397 public abstract XMLEventReader createXMLEventReader(XMLStreamReader reader)
398 throws XMLStreamException;
399
400 /**
401 * Create a new XMLEventReader from a JAXP source.
402 * Support of this method is optional.
403 * @param source the source to read from
404 * @throws UnsupportedOperationException if this method is not
405 * supported by this XMLInputFactory
406 */
407 public abstract XMLEventReader createXMLEventReader(Source source)
408 throws XMLStreamException;
409
410 /**
411 * Create a new XMLEventReader from a java.io.InputStream
412 * @param stream the InputStream to read from
413 * @throws XMLStreamException
414 */
415 public abstract XMLEventReader createXMLEventReader(java.io.InputStream stream)
416 throws XMLStreamException;
417
418 /**
419 * Create a new XMLEventReader from a java.io.InputStream
420 * @param stream the InputStream to read from
421 * @param encoding the character encoding of the stream
422 * @throws XMLStreamException
423 */
424 public abstract XMLEventReader createXMLEventReader(java.io.InputStream stream, String encoding)
425 throws XMLStreamException;
426
427 /**
428 * Create a new XMLEventReader from a java.io.InputStream
429 * @param systemId the system ID of the stream
430 * @param stream the InputStream to read from
431 * @throws XMLStreamException
432 */
433 public abstract XMLEventReader createXMLEventReader(String systemId, java.io.InputStream stream)
434 throws XMLStreamException;
435
436 /**
437 * Create a filtered reader that wraps the filter around the reader
438 * @param reader the reader to filter
439 * @param filter the filter to apply to the reader
440 * @throws XMLStreamException
441 */
442 public abstract XMLStreamReader createFilteredReader(XMLStreamReader reader, StreamFilter filter)
443 throws XMLStreamException;
444
445 /**
446 * Create a filtered event reader that wraps the filter around the event reader
447 * @param reader the event reader to wrap
448 * @param filter the filter to apply to the event reader
449 * @throws XMLStreamException
450 */
451 public abstract XMLEventReader createFilteredReader(XMLEventReader reader, EventFilter filter)
452 throws XMLStreamException;
453
454 /**
455 * The resolver that will be set on any XMLStreamReader or XMLEventReader created
456 * by this factory instance.
457 */
458 public abstract XMLResolver getXMLResolver();
459
460 /**
461 * The resolver that will be set on any XMLStreamReader or XMLEventReader created
462 * by this factory instance.
463 * @param resolver the resolver to use to resolve references
464 */
465 public abstract void setXMLResolver(XMLResolver resolver);
466
467 /**
468 * The reporter that will be set on any XMLStreamReader or XMLEventReader created
469 * by this factory instance.
470 */
471 public abstract XMLReporter getXMLReporter();
472
473 /**
474 * The reporter that will be set on any XMLStreamReader or XMLEventReader created
475 * by this factory instance.
476 * @param reporter the resolver to use to report non fatal errors
477 */
478 public abstract void setXMLReporter(XMLReporter reporter);
479
480 /**
481 * Allows the user to set specific feature/property on the underlying
482 * implementation. The underlying implementation is not required to support
483 * every setting of every property in the specification and may use
484 * IllegalArgumentException to signal that an unsupported property may not be
485 * set with the specified value.
486 * <p>
487 * All implementations that implement JAXP 1.5 or newer are required to
488 * support the {@link javax.xml.XMLConstants#ACCESS_EXTERNAL_DTD} property.
489 * <ul>
490 * <li>
491 * <p>
492 * Access to external DTDs, external Entity References is restricted to the
493 * protocols specified by the property. If access is denied during parsing
494 * due to the restriction of this property, {@link javax.xml.stream.XMLStreamException}
495 * will be thrown by the {@link javax.xml.stream.XMLStreamReader#next()} or
496 * {@link javax.xml.stream.XMLEventReader#nextEvent()} method.
497 *
498 * </li>
499 * </ul>
500 * @param name The name of the property (may not be null)
501 * @param value The value of the property
502 * @throws java.lang.IllegalArgumentException if the property is not supported
503 */
504 public abstract void setProperty(java.lang.String name, Object value)
505 throws java.lang.IllegalArgumentException;
506
507 /**
508 * Get the value of a feature/property from the underlying implementation
509 * @param name The name of the property (may not be null)
510 * @return The value of the property
511 * @throws IllegalArgumentException if the property is not supported
512 */
513 public abstract Object getProperty(java.lang.String name)
514 throws java.lang.IllegalArgumentException;
515
516
517 /**
518 * Query the set of properties that this factory supports.
519 *
520 * @param name The name of the property (may not be null)
521 * @return true if the property is supported and false otherwise
522 */
523 public abstract boolean isPropertySupported(String name);
524
525 /**
526 * Set a user defined event allocator for events
527 * @param allocator the user defined allocator
528 */
529 public abstract void setEventAllocator(XMLEventAllocator allocator);
530
531 /**
532 * Gets the allocator used by streams created with this factory
533 */
534 public abstract XMLEventAllocator getEventAllocator();
535
536 }