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.parsers;
27
28 import javax.xml.validation.Schema;
29
30 import org.xml.sax.SAXException;
31 import org.xml.sax.SAXNotRecognizedException;
32 import org.xml.sax.SAXNotSupportedException;
33
34 /**
35 * Defines a factory API that enables applications to configure and
36 * obtain a SAX based parser to parse XML documents.
37 *
38 * @author <a href="mailto:Jeff.Suttor@Sun.com">Jeff Suttor</a>
39 * @author <a href="mailto:Neeraj.Bajaj@sun.com">Neeraj Bajaj</a>
40 *
41 * @version $Revision: 1.9 $, $Date: 2010/05/25 16:19:44 $
42 *
43 */
44 public abstract class SAXParserFactory {
45 /** The default property name according to the JAXP spec */
46 private static final String DEFAULT_PROPERTY_NAME = "javax.xml.parsers.SAXParserFactory";
47
48 /**
49 * <p>Should Parsers be validating?</p>
50 */
51 private boolean validating = false;
52
53 /**
54 * <p>Should Parsers be namespace aware?</p>
55 */
56 private boolean namespaceAware = false;
57
58 /**
59 * <p>Protected constructor to force use of {@link #newInstance()}.</p>
60 */
61 protected SAXParserFactory () {
62
63 }
64
65 /**
66 * Obtain a new instance of a <code>SAXParserFactory</code>. This
70 * load:
71 * <ul>
72 * <li>
73 * Use the <code>javax.xml.parsers.SAXParserFactory</code> system
74 * property.
75 * </li>
76 * <li>
77 * Use the properties file "lib/jaxp.properties" in the JRE directory.
78 * This configuration file is in standard <code>java.util.Properties
79 * </code> format and contains the fully qualified name of the
80 * implementation class with the key being the system property defined
81 * above.
82 *
83 * The jaxp.properties file is read only once by the JAXP implementation
84 * and it's values are then cached for future use. If the file does not exist
85 * when the first attempt is made to read from it, no further attempts are
86 * made to check for its existence. It is not possible to change the value
87 * of any property in jaxp.properties after it has been read for the first time.
88 * </li>
89 * <li>
90 * Use the Services API (as detailed in the JAR specification), if
91 * available, to determine the classname. The Services API will look
92 * for a classname in the file
93 * <code>META-INF/services/javax.xml.parsers.SAXParserFactory</code>
94 * in jars available to the runtime.
95 * </li>
96 * <li>
97 * Platform default <code>SAXParserFactory</code> instance.
98 * </li>
99 * </ul>
100 *
101 * Once an application has obtained a reference to a
102 * <code>SAXParserFactory</code> it can use the factory to
103 * configure and obtain parser instances.
104 *
105 *
106 *
107 * <h2>Tip for Trouble-shooting</h2>
108 * <p>Setting the <code>jaxp.debug</code> system property will cause
109 * this method to print a lot of debug messages
110 * to <code>System.err</code> about what it is doing and where it is looking at.</p>
111 *
112 * <p> If you have problems loading {@link DocumentBuilder}s, try:</p>
113 * <pre>
114 * java -Djaxp.debug=1 YourProgram ....
115 * </pre>
116 *
117 *
118 * @return A new instance of a SAXParserFactory.
119 *
120 * @throws FactoryConfigurationError if the implementation is
121 * not available or cannot be instantiated.
122 */
123
124 public static SAXParserFactory newInstance() {
125 try {
126 return (SAXParserFactory) FactoryFinder.find(
127 /* The default property name according to the JAXP spec */
128 "javax.xml.parsers.SAXParserFactory",
129 /* The fallback implementation class name */
130 "com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl");
131 } catch (FactoryFinder.ConfigurationError e) {
132 throw new FactoryConfigurationError(e.getException(),
133 e.getMessage());
134 }
135 }
136
137 /**
138 * <p>Obtain a new instance of a <code>SAXParserFactory</code> from class name.
139 * This function is useful when there are multiple providers in the classpath.
140 * It gives more control to the application as it can specify which provider
141 * should be loaded.</p>
142 *
143 * <p>Once an application has obtained a reference to a <code>SAXParserFactory</code>
144 * it can use the factory to configure and obtain parser instances.</p>
145 *
146 *
147 * <h2>Tip for Trouble-shooting</h2>
148 * <p>Setting the <code>jaxp.debug</code> system property will cause
149 * this method to print a lot of debug messages
150 * to <code>System.err</code> about what it is doing and where it is looking at.</p>
151 *
152 * <p> If you have problems, try:</p>
153 * <pre>
154 * java -Djaxp.debug=1 YourProgram ....
155 * </pre>
156 *
157 * @param factoryClassName fully qualified factory class name that provides implementation of <code>javax.xml.parsers.SAXParserFactory</code>.
158 *
159 * @param classLoader <code>ClassLoader</code> used to load the factory class. If <code>null</code>
160 * current <code>Thread</code>'s context classLoader is used to load the factory class.
161 *
162 * @return New instance of a <code>SAXParserFactory</code>
163 *
164 * @throws FactoryConfigurationError if <code>factoryClassName</code> is <code>null</code>, or
165 * the factory class cannot be loaded, instantiated.
166 *
167 * @see #newInstance()
168 *
169 * @since 1.6
170 */
171 public static SAXParserFactory newInstance(String factoryClassName, ClassLoader classLoader){
172 try {
173 //do not fallback if given classloader can't find the class, throw exception
174 return (SAXParserFactory) FactoryFinder.newInstance(factoryClassName, classLoader, false);
175 } catch (FactoryFinder.ConfigurationError e) {
176 throw new FactoryConfigurationError(e.getException(),
177 e.getMessage());
178 }
179 }
180
181 /**
182 * <p>Creates a new instance of a SAXParser using the currently
183 * configured factory parameters.</p>
184 *
185 * @return A new instance of a SAXParser.
186 *
187 * @throws ParserConfigurationException if a parser cannot
188 * be created which satisfies the requested configuration.
189 * @throws SAXException for SAX errors.
190 */
191
192 public abstract SAXParser newSAXParser()
193 throws ParserConfigurationException, SAXException;
194
195
196 /**
197 * Specifies that the parser produced by this code will
198 * provide support for XML namespaces. By default the value of this is set
254 * @return true if the factory is configured to produce parsers which validate
255 * the XML content during parse; false otherwise.
256 */
257
258 public boolean isValidating() {
259 return validating;
260 }
261
262 /**
263 *
264 * <p>Sets the particular feature in the underlying implementation of
265 * org.xml.sax.XMLReader.
266 * A list of the core features and properties can be found at
267 * <a href="http://www.saxproject.org/">http://www.saxproject.org/</a></p>
268 *
269 * <p>All implementations are required to support the {@link javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING} feature.
270 * When the feature is</p>
271 * <ul>
272 * <li>
273 * <code>true</code>: the implementation will limit XML processing to conform to implementation limits.
274 * Examples include enity expansion limits and XML Schema constructs that would consume large amounts of resources.
275 * If XML processing is limited for security reasons, it will be reported via a call to the registered
276 * {@link org.xml.sax.ErrorHandler#fatalError(SAXParseException exception)}.
277 * See {@link SAXParser} <code>parse</code> methods for handler specification.
278 * </li>
279 * <li>
280 * When the feature is <code>false</code>, the implementation will processing XML according to the XML specifications without
281 * regard to possible implementation limits.
282 * </li>
283 * </ul>
284 *
285 * @param name The name of the feature to be set.
286 * @param value The value of the feature to be set.
287 *
288 * @throws ParserConfigurationException if a parser cannot
289 * be created which satisfies the requested configuration.
290 * @throws SAXNotRecognizedException When the underlying XMLReader does
291 * not recognize the property name.
292 * @throws SAXNotSupportedException When the underlying XMLReader
293 * recognizes the property name but doesn't support the
294 * property.
303 /**
304 *
305 * <p>Returns the particular property requested for in the underlying
306 * implementation of org.xml.sax.XMLReader.</p>
307 *
308 * @param name The name of the property to be retrieved.
309 *
310 * @return Value of the requested property.
311 *
312 * @throws ParserConfigurationException if a parser cannot be created which satisfies the requested configuration.
313 * @throws SAXNotRecognizedException When the underlying XMLReader does not recognize the property name.
314 * @throws SAXNotSupportedException When the underlying XMLReader recognizes the property name but doesn't support the property.
315 *
316 * @see org.xml.sax.XMLReader#getProperty
317 */
318 public abstract boolean getFeature(String name)
319 throws ParserConfigurationException, SAXNotRecognizedException,
320 SAXNotSupportedException;
321
322
323
324 /* <p>Get current state of canonicalization.</p>
325 *
326 * @return current state canonicalization control
327 */
328 /*
329 public boolean getCanonicalization() {
330 return canonicalState;
331 }
332 */
333
334 /**
335 * Gets the {@link Schema} object specified through
336 * the {@link #setSchema(Schema schema)} method.
337 *
338 *
339 * @throws UnsupportedOperationException When implementation does not
340 * override this method
341 *
342 * @return
343 * the {@link Schema} object that was last set through
344 * the {@link #setSchema(Schema)} method, or null
345 * if the method was not invoked since a {@link SAXParserFactory}
346 * is created.
347 *
348 * @since 1.5
349 */
350 public Schema getSchema() {
351 throw new UnsupportedOperationException(
352 "This parser does not support specification \""
353 + this.getClass().getPackage().getSpecificationTitle()
354 + "\" version \""
355 + this.getClass().getPackage().getSpecificationVersion()
356 + "\""
357 );
358 }
359
360 /** <p>Set canonicalization control to <code>true</code> or
361 * </code>false</code>.</p>
362 *
363 * @param state of canonicalization
364 */
365 /*
366 public void setCanonicalization(boolean state) {
367 canonicalState = state;
368 }
369 */
370
371 /**
372 * <p>Set the {@link Schema} to be used by parsers created
373 * from this factory.</p>
374 *
375 * <p>When a {@link Schema} is non-null, a parser will use a validator
376 * created from it to validate documents before it passes information
377 * down to the application.</p>
378 *
379 * <p>When warnings/errors/fatal errors are found by the validator, the parser must
380 * handle them as if those errors were found by the parser itself.
381 * In other words, if the user-specified {@link org.xml.sax.ErrorHandler}
382 * is set, it must receive those errors, and if not, they must be
383 * treated according to the implementation specific
384 * default error handling rules.
385 *
386 * <p>A validator may modify the SAX event stream (for example by
387 * adding default values that were missing in documents), and a parser
388 * is responsible to make sure that the application will receive
389 * those modified event stream.</p>
390 *
391 * <p>Initialy, <code>null</code> is set as the {@link Schema}.</p>
392 *
393 * <p>This processing will take effect even if
394 * the {@link #isValidating()} method returns <code>false</code>.
395 *
396 * <p>It is an error to use
397 * the <code>http://java.sun.com/xml/jaxp/properties/schemaSource</code>
398 * property and/or the <code>http://java.sun.com/xml/jaxp/properties/schemaLanguage</code>
399 * property in conjunction with a non-null {@link Schema} object.
400 * Such configuration will cause a {@link SAXException}
401 * exception when those properties are set on a {@link SAXParser}.</p>
402 *
403 * <h4>Note for implmentors</h4>
404 * <p>
405 * A parser must be able to work with any {@link Schema}
406 * implementation. However, parsers and schemas are allowed
407 * to use implementation-specific custom mechanisms
408 * as long as they yield the result described in the specification.
409 * </p>
410 *
411 * @param schema <code>Schema</code> to use, <code>null</code> to remove a schema.
412 *
413 * @throws UnsupportedOperationException When implementation does not
414 * override this method
415 *
416 * @since 1.5
417 */
418 public void setSchema(Schema schema) {
419 throw new UnsupportedOperationException(
420 "This parser does not support specification \""
421 + this.getClass().getPackage().getSpecificationTitle()
422 + "\" version \""
423 + this.getClass().getPackage().getSpecificationVersion()
|
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.parsers;
27
28 import javax.xml.validation.Schema;
29 import org.xml.sax.SAXException;
30 import org.xml.sax.SAXNotRecognizedException;
31 import org.xml.sax.SAXNotSupportedException;
32
33 /**
34 * Defines a factory API that enables applications to configure and
35 * obtain a SAX based parser to parse XML documents.
36 *
37 * @author <a href="mailto:Jeff.Suttor@Sun.com">Jeff Suttor</a>
38 * @author <a href="mailto:Neeraj.Bajaj@sun.com">Neeraj Bajaj</a>
39 *
40 * @version $Revision: 1.9 $, $Date: 2010/05/25 16:19:44 $
41 *
42 */
43 public abstract class SAXParserFactory {
44
45 /**
46 * <p>Should Parsers be validating?</p>
47 */
48 private boolean validating = false;
49
50 /**
51 * <p>Should Parsers be namespace aware?</p>
52 */
53 private boolean namespaceAware = false;
54
55 /**
56 * <p>Protected constructor to force use of {@link #newInstance()}.</p>
57 */
58 protected SAXParserFactory () {
59
60 }
61
62 /**
63 * Obtain a new instance of a <code>SAXParserFactory</code>. This
67 * load:
68 * <ul>
69 * <li>
70 * Use the <code>javax.xml.parsers.SAXParserFactory</code> system
71 * property.
72 * </li>
73 * <li>
74 * Use the properties file "lib/jaxp.properties" in the JRE directory.
75 * This configuration file is in standard <code>java.util.Properties
76 * </code> format and contains the fully qualified name of the
77 * implementation class with the key being the system property defined
78 * above.
79 *
80 * The jaxp.properties file is read only once by the JAXP implementation
81 * and it's values are then cached for future use. If the file does not exist
82 * when the first attempt is made to read from it, no further attempts are
83 * made to check for its existence. It is not possible to change the value
84 * of any property in jaxp.properties after it has been read for the first time.
85 * </li>
86 * <li>
87 * Use the service-provider loading facilities, defined by the
88 * {@link java.util.ServiceLoader} class, to attempt to locate and load an
89 * implementation of the service.
90 * </li>
91 * <li>
92 * Otherwise the system-default implementation is returned.
93 * </li>
94 * </ul>
95 *
96 * Once an application has obtained a reference to a
97 * <code>SAXParserFactory</code> it can use the factory to
98 * configure and obtain parser instances.
99 *
100 *
101 *
102 * <h2>Tip for Trouble-shooting</h2>
103 * <p>Setting the <code>jaxp.debug</code> system property will cause
104 * this method to print a lot of debug messages
105 * to <code>System.err</code> about what it is doing and where it is looking at.</p>
106 *
107 * <p> If you have problems loading {@link SAXParser}s, try:</p>
108 * <pre>
109 * java -Djaxp.debug=1 YourProgram ....
110 * </pre>
111 *
112 *
113 * @return A new instance of a SAXParserFactory.
114 *
115 * @throws FactoryConfigurationError in case of {@linkplain
116 * java.util.ServiceConfigurationError service configuration error} or if
117 * the implementation is not available or cannot be instantiated.
118 */
119
120 public static SAXParserFactory newInstance() {
121 return FactoryFinder.find(
122 /* The default property name according to the JAXP spec */
123 SAXParserFactory.class,
124 /* The fallback implementation class name */
125 "com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl");
126 }
127
128 /**
129 * <p>Obtain a new instance of a <code>SAXParserFactory</code> from class name.
130 * This function is useful when there are multiple providers in the classpath.
131 * It gives more control to the application as it can specify which provider
132 * should be loaded.</p>
133 *
134 * <p>Once an application has obtained a reference to a <code>SAXParserFactory</code>
135 * it can use the factory to configure and obtain parser instances.</p>
136 *
137 *
138 * <h2>Tip for Trouble-shooting</h2>
139 * <p>Setting the <code>jaxp.debug</code> system property will cause
140 * this method to print a lot of debug messages
141 * to <code>System.err</code> about what it is doing and where it is looking at.</p>
142 *
143 * <p> If you have problems, try:</p>
144 * <pre>
145 * java -Djaxp.debug=1 YourProgram ....
146 * </pre>
147 *
148 * @param factoryClassName fully qualified factory class name that provides implementation of <code>javax.xml.parsers.SAXParserFactory</code>.
149 *
150 * @param classLoader <code>ClassLoader</code> used to load the factory class. If <code>null</code>
151 * current <code>Thread</code>'s context classLoader is used to load the factory class.
152 *
153 * @return New instance of a <code>SAXParserFactory</code>
154 *
155 * @throws FactoryConfigurationError if <code>factoryClassName</code> is <code>null</code>, or
156 * the factory class cannot be loaded, instantiated.
157 *
158 * @see #newInstance()
159 *
160 * @since 1.6
161 */
162 public static SAXParserFactory newInstance(String factoryClassName, ClassLoader classLoader){
163 //do not fallback if given classloader can't find the class, throw exception
164 return FactoryFinder.newInstance(SAXParserFactory.class,
165 factoryClassName, classLoader, false);
166 }
167
168 /**
169 * <p>Creates a new instance of a SAXParser using the currently
170 * configured factory parameters.</p>
171 *
172 * @return A new instance of a SAXParser.
173 *
174 * @throws ParserConfigurationException if a parser cannot
175 * be created which satisfies the requested configuration.
176 * @throws SAXException for SAX errors.
177 */
178
179 public abstract SAXParser newSAXParser()
180 throws ParserConfigurationException, SAXException;
181
182
183 /**
184 * Specifies that the parser produced by this code will
185 * provide support for XML namespaces. By default the value of this is set
241 * @return true if the factory is configured to produce parsers which validate
242 * the XML content during parse; false otherwise.
243 */
244
245 public boolean isValidating() {
246 return validating;
247 }
248
249 /**
250 *
251 * <p>Sets the particular feature in the underlying implementation of
252 * org.xml.sax.XMLReader.
253 * A list of the core features and properties can be found at
254 * <a href="http://www.saxproject.org/">http://www.saxproject.org/</a></p>
255 *
256 * <p>All implementations are required to support the {@link javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING} feature.
257 * When the feature is</p>
258 * <ul>
259 * <li>
260 * <code>true</code>: the implementation will limit XML processing to conform to implementation limits.
261 * Examples include entity expansion limits and XML Schema constructs that would consume large amounts of resources.
262 * If XML processing is limited for security reasons, it will be reported via a call to the registered
263 * {@link org.xml.sax.ErrorHandler#fatalError(SAXParseException exception)}.
264 * See {@link SAXParser} <code>parse</code> methods for handler specification.
265 * </li>
266 * <li>
267 * When the feature is <code>false</code>, the implementation will processing XML according to the XML specifications without
268 * regard to possible implementation limits.
269 * </li>
270 * </ul>
271 *
272 * @param name The name of the feature to be set.
273 * @param value The value of the feature to be set.
274 *
275 * @throws ParserConfigurationException if a parser cannot
276 * be created which satisfies the requested configuration.
277 * @throws SAXNotRecognizedException When the underlying XMLReader does
278 * not recognize the property name.
279 * @throws SAXNotSupportedException When the underlying XMLReader
280 * recognizes the property name but doesn't support the
281 * property.
290 /**
291 *
292 * <p>Returns the particular property requested for in the underlying
293 * implementation of org.xml.sax.XMLReader.</p>
294 *
295 * @param name The name of the property to be retrieved.
296 *
297 * @return Value of the requested property.
298 *
299 * @throws ParserConfigurationException if a parser cannot be created which satisfies the requested configuration.
300 * @throws SAXNotRecognizedException When the underlying XMLReader does not recognize the property name.
301 * @throws SAXNotSupportedException When the underlying XMLReader recognizes the property name but doesn't support the property.
302 *
303 * @see org.xml.sax.XMLReader#getProperty
304 */
305 public abstract boolean getFeature(String name)
306 throws ParserConfigurationException, SAXNotRecognizedException,
307 SAXNotSupportedException;
308
309
310 /**
311 * Gets the {@link Schema} object specified through
312 * the {@link #setSchema(Schema schema)} method.
313 *
314 *
315 * @throws UnsupportedOperationException When implementation does not
316 * override this method
317 *
318 * @return
319 * the {@link Schema} object that was last set through
320 * the {@link #setSchema(Schema)} method, or null
321 * if the method was not invoked since a {@link SAXParserFactory}
322 * is created.
323 *
324 * @since 1.5
325 */
326 public Schema getSchema() {
327 throw new UnsupportedOperationException(
328 "This parser does not support specification \""
329 + this.getClass().getPackage().getSpecificationTitle()
330 + "\" version \""
331 + this.getClass().getPackage().getSpecificationVersion()
332 + "\""
333 );
334 }
335
336 /**
337 * <p>Set the {@link Schema} to be used by parsers created
338 * from this factory.</p>
339 *
340 * <p>When a {@link Schema} is non-null, a parser will use a validator
341 * created from it to validate documents before it passes information
342 * down to the application.</p>
343 *
344 * <p>When warnings/errors/fatal errors are found by the validator, the parser must
345 * handle them as if those errors were found by the parser itself.
346 * In other words, if the user-specified {@link org.xml.sax.ErrorHandler}
347 * is set, it must receive those errors, and if not, they must be
348 * treated according to the implementation specific
349 * default error handling rules.
350 *
351 * <p>A validator may modify the SAX event stream (for example by
352 * adding default values that were missing in documents), and a parser
353 * is responsible to make sure that the application will receive
354 * those modified event stream.</p>
355 *
356 * <p>Initialy, <code>null</code> is set as the {@link Schema}.</p>
357 *
358 * <p>This processing will take effect even if
359 * the {@link #isValidating()} method returns <code>false</code>.
360 *
361 * <p>It is an error to use
362 * the <code>http://java.sun.com/xml/jaxp/properties/schemaSource</code>
363 * property and/or the <code>http://java.sun.com/xml/jaxp/properties/schemaLanguage</code>
364 * property in conjunction with a non-null {@link Schema} object.
365 * Such configuration will cause a {@link SAXException}
366 * exception when those properties are set on a {@link SAXParser}.</p>
367 *
368 * <h4>Note for implementors</h4>
369 * <p>
370 * A parser must be able to work with any {@link Schema}
371 * implementation. However, parsers and schemas are allowed
372 * to use implementation-specific custom mechanisms
373 * as long as they yield the result described in the specification.
374 * </p>
375 *
376 * @param schema <code>Schema</code> to use, <code>null</code> to remove a schema.
377 *
378 * @throws UnsupportedOperationException When implementation does not
379 * override this method
380 *
381 * @since 1.5
382 */
383 public void setSchema(Schema schema) {
384 throw new UnsupportedOperationException(
385 "This parser does not support specification \""
386 + this.getClass().getPackage().getSpecificationTitle()
387 + "\" version \""
388 + this.getClass().getPackage().getSpecificationVersion()
|