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 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 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 * Create a new instance of the factory.
148 * Same as {@link #newFactory()}.
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 * </p>
164 * <ul>
165 * <li>
166 * Use the javax.xml.stream.XMLInputFactory system property.
167 * </li>
168 * <li>
169 * Use the properties file "lib/stax.properties" in the JRE directory,
170 * if present, otherwise, use the properties file "lib/jaxp.properties"
171 * in the JRE directory.
172 * These configuration files are in standard java.util.Properties format
173 * and contain the fully qualified name of the implementation class
174 * with the key being the system property defined above.
175 * </li>
176 * <li>
177 * Use the service-provider loading facilities, defined by the
178 * {@link java.util.ServiceLoader} class, to attempt to locate and load an
179 * implementation of the service.
180 * </li>
181 * <li>
182 * Otherwise, the system-default implementation is returned.
183 * </li>
184 * </ul>
185 * <p>
186 * Once an application has obtained a reference to a XMLInputFactory it
187 * can use the factory to configure and obtain stream instances.
188 * </p>
189 * <p>
190 * Note that this is a new method that replaces the deprecated newInstance() method.
191 * No changes in behavior are defined by this replacement method relative to
192 * the deprecated method.
193 * </p>
194 * @throws FactoryConfigurationError in case of {@linkplain
195 * java.util.ServiceConfigurationError service configuration error} or if
196 * the implementation is not available or cannot be instantiated.
197 */
198 public static XMLInputFactory newFactory()
199 throws FactoryConfigurationError
200 {
201 return FactoryFinder.find(XMLInputFactory.class, DEFAULIMPL);
202 }
203
204 /**
205 * Create a new instance of the factory
206 *
207 * @param factoryId Name of the factory to find, same as
208 * a property name
209 * @param classLoader classLoader to use
210 * @return the factory implementation
211 * @throws FactoryConfigurationError if an instance of this factory cannot be loaded
212 *
213 * @deprecated This method has been deprecated to maintain API consistency.
214 * All newInstance methods have been replaced with corresponding
215 * newFactory methods. The replacement {@link
216 * #newFactory(java.lang.String, java.lang.ClassLoader)} method
217 * defines no changes in behavior.
218 */
219 public static XMLInputFactory newInstance(String factoryId,
220 ClassLoader classLoader)
221 throws FactoryConfigurationError {
222 //do not fallback if given classloader can't find the class, throw exception
223 return FactoryFinder.find(XMLInputFactory.class, factoryId, classLoader, null);
224 }
225
226 /**
227 * Create a new instance of the factory.
228 * If the classLoader argument is null, then the ContextClassLoader is used.
229 * <p>
230 * This method uses the following ordered lookup procedure to determine
231 * the XMLInputFactory implementation class to load:
232 * </p>
233 * <ul>
234 * <li>
235 * Use the value of the system property identified by {@code factoryId}.
236 * </li>
237 * <li>
238 * Use the properties file "lib/stax.properties" in the JRE directory,
239 * if present, otherwise, use the properties file "lib/jaxp.properties"
240 * in the JRE directory.
241 * These configuration files are in standard java.util.Properties format
242 * and contain the fully qualified name of the implementation class
243 * with the key being the given {@code factoryId}.
244 * </li>
245 * <li>
246 * If {@code factoryId} is the base service class name,
247 * use the service-provider loading facilities, defined by the
248 * {@link java.util.ServiceLoader} class, to attempt to locate and load an
249 * implementation of the service.
250 * </li>
251 * <li>
252 * Otherwise, throws a {@link FactoryConfigurationError}.
253 * </li>
254 * </ul>
255 *
256 * <p>
257 * Note that this is a new method that replaces the deprecated
258 * {@link #newInstance(java.lang.String, java.lang.ClassLoader)
259 * newInstance(String factoryId, ClassLoader classLoader)} method.
260 * No changes in behavior are defined by this replacement method relative
261 * to the deprecated method.
262 * </p>
263 *
264 * @param factoryId Name of the factory to find, same as
265 * a property name
266 * @param classLoader classLoader to use
267 * @return the factory implementation
268 * @throws FactoryConfigurationError in case of {@linkplain
269 * java.util.ServiceConfigurationError service configuration error} or if
270 * the implementation is not available or cannot be instantiated.
271 * @throws FactoryConfigurationError if an instance of this factory cannot be loaded
272 */
273 public static XMLInputFactory newFactory(String factoryId,
274 ClassLoader classLoader)
275 throws FactoryConfigurationError {
276 //do not fallback if given classloader can't find the class, throw exception
277 return FactoryFinder.find(XMLInputFactory.class, factoryId, classLoader, null);
278 }
279
280 /**
281 * Create a new XMLStreamReader from a reader
282 * @param reader the XML data to read from
283 * @throws XMLStreamException
284 */
285 public abstract XMLStreamReader createXMLStreamReader(java.io.Reader reader)
286 throws XMLStreamException;
287
288 /**
289 * Create a new XMLStreamReader from a JAXP source. This method is optional.
290 * @param source the source to read from
291 * @throws UnsupportedOperationException if this method is not
292 * supported by this XMLInputFactory
293 * @throws XMLStreamException
294 */
295 public abstract XMLStreamReader createXMLStreamReader(Source source)
296 throws XMLStreamException;
297
298 /**
299 * Create a new XMLStreamReader from a java.io.InputStream
300 * @param stream the InputStream to read from
301 * @throws XMLStreamException
302 */
303 public abstract XMLStreamReader createXMLStreamReader(java.io.InputStream stream)
304 throws XMLStreamException;
305
306 /**
307 * Create a new XMLStreamReader from a java.io.InputStream
308 * @param stream the InputStream to read from
309 * @param encoding the character encoding of the stream
310 * @throws XMLStreamException
311 */
312 public abstract XMLStreamReader createXMLStreamReader(java.io.InputStream stream, String encoding)
313 throws XMLStreamException;
314
315 /**
316 * Create a new XMLStreamReader from a java.io.InputStream
317 * @param systemId the system ID of the stream
318 * @param stream the InputStream to read from
319 */
320 public abstract XMLStreamReader createXMLStreamReader(String systemId, java.io.InputStream stream)
321 throws XMLStreamException;
322
323 /**
324 * Create a new XMLStreamReader from a java.io.InputStream
325 * @param systemId the system ID of the stream
326 * @param reader the InputStream to read from
327 */
328 public abstract XMLStreamReader createXMLStreamReader(String systemId, java.io.Reader reader)
329 throws XMLStreamException;
330
331 /**
332 * Create a new XMLEventReader from a reader
333 * @param reader the XML data to read from
334 * @throws XMLStreamException
335 */
336 public abstract XMLEventReader createXMLEventReader(java.io.Reader reader)
337 throws XMLStreamException;
338
339 /**
340 * Create a new XMLEventReader from a reader
341 * @param systemId the system ID of the input
342 * @param reader the XML data to read from
343 * @throws XMLStreamException
344 */
345 public abstract XMLEventReader createXMLEventReader(String systemId, java.io.Reader reader)
346 throws XMLStreamException;
347
348 /**
349 * Create a new XMLEventReader from an XMLStreamReader. After being used
350 * to construct the XMLEventReader instance returned from this method
351 * the XMLStreamReader must not be used.
352 * @param reader the XMLStreamReader to read from (may not be modified)
353 * @return a new XMLEventReader
354 * @throws XMLStreamException
355 */
356 public abstract XMLEventReader createXMLEventReader(XMLStreamReader reader)
357 throws XMLStreamException;
358
359 /**
360 * Create a new XMLEventReader from a JAXP source.
361 * Support of this method is optional.
362 * @param source the source to read from
363 * @throws UnsupportedOperationException if this method is not
364 * supported by this XMLInputFactory
365 */
366 public abstract XMLEventReader createXMLEventReader(Source source)
367 throws XMLStreamException;
368
369 /**
370 * Create a new XMLEventReader from a java.io.InputStream
371 * @param stream the InputStream to read from
372 * @throws XMLStreamException
373 */
374 public abstract XMLEventReader createXMLEventReader(java.io.InputStream stream)
375 throws XMLStreamException;
376
377 /**
378 * Create a new XMLEventReader from a java.io.InputStream
379 * @param stream the InputStream to read from
380 * @param encoding the character encoding of the stream
381 * @throws XMLStreamException
382 */
383 public abstract XMLEventReader createXMLEventReader(java.io.InputStream stream, String encoding)
384 throws XMLStreamException;
385
386 /**
387 * Create a new XMLEventReader from a java.io.InputStream
388 * @param systemId the system ID of the stream
389 * @param stream the InputStream to read from
390 * @throws XMLStreamException
391 */
392 public abstract XMLEventReader createXMLEventReader(String systemId, java.io.InputStream stream)
393 throws XMLStreamException;
394
395 /**
396 * Create a filtered reader that wraps the filter around the reader
397 * @param reader the reader to filter
398 * @param filter the filter to apply to the reader
399 * @throws XMLStreamException
400 */
401 public abstract XMLStreamReader createFilteredReader(XMLStreamReader reader, StreamFilter filter)
402 throws XMLStreamException;
403
404 /**
405 * Create a filtered event reader that wraps the filter around the event reader
406 * @param reader the event reader to wrap
407 * @param filter the filter to apply to the event reader
408 * @throws XMLStreamException
409 */
410 public abstract XMLEventReader createFilteredReader(XMLEventReader reader, EventFilter filter)
411 throws XMLStreamException;
412
413 /**
414 * The resolver that will be set on any XMLStreamReader or XMLEventReader created
415 * by this factory instance.
416 */
417 public abstract XMLResolver getXMLResolver();
418
419 /**
420 * The resolver that will be set on any XMLStreamReader or XMLEventReader created
421 * by this factory instance.
422 * @param resolver the resolver to use to resolve references
423 */
424 public abstract void setXMLResolver(XMLResolver resolver);
425
426 /**
427 * The reporter that will be set on any XMLStreamReader or XMLEventReader created
428 * by this factory instance.
429 */
430 public abstract XMLReporter getXMLReporter();
431
432 /**
433 * The reporter that will be set on any XMLStreamReader or XMLEventReader created
434 * by this factory instance.
435 * @param reporter the resolver to use to report non fatal errors
436 */
437 public abstract void setXMLReporter(XMLReporter reporter);
438
439 /**
440 * Allows the user to set specific feature/property on the underlying implementation. The underlying implementation
441 * is not required to support every setting of every property in the specification and may use IllegalArgumentException
442 * to signal that an unsupported property may not be set with the specified value.
443 * @param name The name of the property (may not be null)
444 * @param value The value of the property
445 * @throws java.lang.IllegalArgumentException if the property is not supported
446 */
447 public abstract void setProperty(java.lang.String name, Object value)
448 throws java.lang.IllegalArgumentException;
449
450 /**
451 * Get the value of a feature/property from the underlying implementation
452 * @param name The name of the property (may not be null)
453 * @return The value of the property
454 * @throws IllegalArgumentException if the property is not supported
455 */
456 public abstract Object getProperty(java.lang.String name)
457 throws java.lang.IllegalArgumentException;
458
459
460 /**
461 * Query the set of properties that this factory supports.
462 *
463 * @param name The name of the property (may not be null)
464 * @return true if the property is supported and false otherwise
465 */
466 public abstract boolean isPropertySupported(String name);
467
468 /**
469 * Set a user defined event allocator for events
470 * @param allocator the user defined allocator
471 */
472 public abstract void setEventAllocator(XMLEventAllocator allocator);
473
474 /**
475 * Gets the allocator used by streams created with this factory
476 */
477 public abstract XMLEventAllocator getEventAllocator();
478
479 }