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