1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
/* * The contents of this file are subject to the terms * of the Common Development and Distribution License * (the "License"). You may not use this file except * in compliance with the License. * * You can obtain a copy of the license at * https://jaxp.dev.java.net/CDDLv1.0.html. * See the License for the specific language governing * permissions and limitations under the License. * * When distributing Covered Code, include this CDDL * HEADER in each file and include the License file at * https://jaxp.dev.java.net/CDDLv1.0.html * If applicable add the following below this CDDL HEADER * with the fields enclosed by brackets "[]" replaced with * your own identifying information: Portions Copyright * [year] [name of copyright owner] */ /* * $Id: DocumentBuilderFactory.java,v 1.5 2005/11/03 19:34:14 jeffsuttor Exp $ * @(#)DocumentBuilderFactory.java 1.50 06/06/21 * * Copyright 2005 Sun Microsystems, Inc. All Rights Reserved. */ package javax.xml.parsers; import javax.xml.validation.Schema; /** * Defines a factory API that enables applications to obtain a * parser that produces DOM object trees from XML documents. * * @author <a href="mailto:Jeff.Suttor@Sun.com">Jeff Suttor</a> * @author <a href="mailto:Neeraj.Bajaj@sun.com">Neeraj Bajaj</a> * * @version $Revision: 1.5 $, $Date: 2005/11/03 19:34:14 $ */ public abstract class DocumentBuilderFactory { /** The default property name according to the JAXP spec */ private static final String DEFAULT_PROPERTY_NAME = "javax.xml.parsers.DocumentBuilderFactory"; private boolean validating = false; private boolean namespaceAware = false; private boolean whitespace = false; private boolean expandEntityRef = true; private boolean ignoreComments = false; private boolean coalescing = false; private boolean canonicalState = false; /** * <p>Protected constructor to prevent instantiation. * Use {@link #newInstance()}.</p> */ protected DocumentBuilderFactory () { } /** * Obtain a new instance of a * <code>DocumentBuilderFactory</code>. This static method creates * a new factory instance. * This method uses the following ordered lookup procedure to determine * the <code>DocumentBuilderFactory</code> implementation class to * load: * <ul> * <li> * Use the <code>javax.xml.parsers.DocumentBuilderFactory</code> system * property. * </li> * <li> * Use the properties file "lib/jaxp.properties" in the JRE directory. * This configuration file is in standard <code>java.util.Properties * </code> format and contains the fully qualified name of the * implementation class with the key being the system property defined * above. * * The jaxp.properties file is read only once by the JAXP implementation * and it's values are then cached for future use. If the file does not exist * when the first attempt is made to read from it, no further attempts are * made to check for its existence. It is not possible to change the value * of any property in jaxp.properties after it has been read for the first time. * </li> * <li> * Use the Services API (as detailed in the JAR specification), if * available, to determine the classname. The Services API will look * for a classname in the file * <code>META-INF/services/javax.xml.parsers.DocumentBuilderFactory</code> * in jars available to the runtime. * </li> * <li> * Platform default <code>DocumentBuilderFactory</code> instance. * </li> * </ul> * * Once an application has obtained a reference to a * <code>DocumentBuilderFactory</code> it can use the factory to * configure and obtain parser instances. * * * <h2>Tip for Trouble-shooting</h2> * <p>Setting the <code>jaxp.debug</code> system property will cause * this method to print a lot of debug messages * to <code>System.err</code> about what it is doing and where it is looking at.</p> * * <p> If you have problems loading {@link DocumentBuilder}s, try:</p> * <pre> * java -Djaxp.debug=1 YourProgram .... * </pre> * * @return New instance of a <code>DocumentBuilderFactory</code> * * @throws FactoryConfigurationError if the implementation is not * available or cannot be instantiated. */ public static DocumentBuilderFactory newInstance() { try { return (DocumentBuilderFactory) FactoryFinder.find( /* The default property name according to the JAXP spec */ "javax.xml.parsers.DocumentBuilderFactory", /* The fallback implementation class name */ "com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl"); } catch (FactoryFinder.ConfigurationError e) { throw new FactoryConfigurationError(e.getException(), e.getMessage()); } } /** * <p>Obtain a new instance of a <code>DocumentBuilderFactory</code> from class name. * This function is useful when there are multiple providers in the classpath. * It gives more control to the application as it can specify which provider * should be loaded.</p> * * <p>Once an application has obtained a reference to a <code>DocumentBuilderFactory</code> * it can use the factory to configure and obtain parser instances.</p> * * * <h2>Tip for Trouble-shooting</h2> * <p>Setting the <code>jaxp.debug</code> system property will cause * this method to print a lot of debug messages * to <code>System.err</code> about what it is doing and where it is looking at.</p> * * <p> If you have problems try:</p> * <pre> * java -Djaxp.debug=1 YourProgram .... * </pre> * * @param factoryClassName fully qualified factory class name that provides implementation of <code>javax.xml.parsers.DocumentBuilderFactory</code>. * * @param classLoader <code>ClassLoader</code> used to load the factory class. If <code>null</code> * current <code>Thread</code>'s context classLoader is used to load the factory class. * * @return New instance of a <code>DocumentBuilderFactory</code> * * @throws FactoryConfigurationError if <code>factoryClassName</code> is <code>null</code>, or * the factory class cannot be loaded, instantiated. * * @see #newInstance() * * @since 1.6 */ public static DocumentBuilderFactory newInstance(String factoryClassName, ClassLoader classLoader){ try { //do not fallback if given classloader can't find the class, throw exception return (DocumentBuilderFactory) FactoryFinder.newInstance(factoryClassName, classLoader, false); } catch (FactoryFinder.ConfigurationError e) { throw new FactoryConfigurationError(e.getException(), e.getMessage()); } } /** * Creates a new instance of a {@link javax.xml.parsers.DocumentBuilder} * using the currently configured parameters. * * @return A new instance of a DocumentBuilder. * * @throws ParserConfigurationException if a DocumentBuilder * cannot be created which satisfies the configuration requested. */ public abstract DocumentBuilder newDocumentBuilder() throws ParserConfigurationException; /** * Specifies that the parser produced by this code will * provide support for XML namespaces. By default the value of this is set * to <code>false</code> * * @param awareness true if the parser produced will provide support * for XML namespaces; false otherwise. */ public void setNamespaceAware(boolean awareness) { this.namespaceAware = awareness; } /** * Specifies that the parser produced by this code will * validate documents as they are parsed. By default the value of this * is set to <code>false</code>. * * <p> * Note that "the validation" here means * <a href="http://www.w3.org/TR/REC-xml#proc-types">a validating * parser</a> as defined in the XML recommendation. * In other words, it essentially just controls the DTD validation. * (except the legacy two properties defined in JAXP 1.2.) * </p> * * <p> * To use modern schema languages such as W3C XML Schema or * RELAX NG instead of DTD, you can configure your parser to be * a non-validating parser by leaving the {@link #setValidating(boolean)} * method <code>false</code>, then use the {@link #setSchema(Schema)} * method to associate a schema to a parser. * </p> * * @param validating true if the parser produced will validate documents * as they are parsed; false otherwise. */ public void setValidating(boolean validating) { this.validating = validating; } /** * Specifies that the parsers created by this factory must eliminate * whitespace in element content (sometimes known loosely as * 'ignorable whitespace') when parsing XML documents (see XML Rec * 2.10). Note that only whitespace which is directly contained within * element content that has an element only content model (see XML * Rec 3.2.1) will be eliminated. Due to reliance on the content model * this setting requires the parser to be in validating mode. By default * the value of this is set to <code>false</code>. * * @param whitespace true if the parser created must eliminate whitespace * in the element content when parsing XML documents; * false otherwise. */ public void setIgnoringElementContentWhitespace(boolean whitespace) { this.whitespace = whitespace; } /** * Specifies that the parser produced by this code will * expand entity reference nodes. By default the value of this is set to * <code>true</code> * * @param expandEntityRef true if the parser produced will expand entity * reference nodes; false otherwise. */ public void setExpandEntityReferences(boolean expandEntityRef) { this.expandEntityRef = expandEntityRef; } /** * <p>Specifies that the parser produced by this code will * ignore comments. By default the value of this is set to <code>false * </code>.</p> * * @param ignoreComments <code>boolean</code> value to ignore comments during processing */ public void setIgnoringComments(boolean ignoreComments) { this.ignoreComments = ignoreComments; } /** * Specifies that the parser produced by this code will * convert CDATA nodes to Text nodes and append it to the * adjacent (if any) text node. By default the value of this is set to * <code>false</code> * * @param coalescing true if the parser produced will convert CDATA nodes * to Text nodes and append it to the adjacent (if any) * text node; false otherwise. */ public void setCoalescing(boolean coalescing) { this.coalescing = coalescing; } /** * Indicates whether or not the factory is configured to produce * parsers which are namespace aware. * * @return true if the factory is configured to produce parsers which * are namespace aware; false otherwise. */ public boolean isNamespaceAware() { return namespaceAware; } /** * Indicates whether or not the factory is configured to produce * parsers which validate the XML content during parse. * * @return true if the factory is configured to produce parsers * which validate the XML content during parse; false otherwise. */ public boolean isValidating() { return validating; } /** * Indicates whether or not the factory is configured to produce * parsers which ignore ignorable whitespace in element content. * * @return true if the factory is configured to produce parsers * which ignore ignorable whitespace in element content; * false otherwise. */ public boolean isIgnoringElementContentWhitespace() { return whitespace; } /** * Indicates whether or not the factory is configured to produce * parsers which expand entity reference nodes. * * @return true if the factory is configured to produce parsers * which expand entity reference nodes; false otherwise. */ public boolean isExpandEntityReferences() { return expandEntityRef; } /** * Indicates whether or not the factory is configured to produce * parsers which ignores comments. * * @return true if the factory is configured to produce parsers * which ignores comments; false otherwise. */ public boolean isIgnoringComments() { return ignoreComments; } /** * Indicates whether or not the factory is configured to produce * parsers which converts CDATA nodes to Text nodes and appends it to * the adjacent (if any) Text node. * * @return true if the factory is configured to produce parsers * which converts CDATA nodes to Text nodes and appends it to * the adjacent (if any) Text node; false otherwise. */ public boolean isCoalescing() { return coalescing; } /** * Allows the user to set specific attributes on the underlying * implementation. * * @param name The name of the attribute. * @param value The value of the attribute. * * @throws IllegalArgumentException thrown if the underlying * implementation doesn't recognize the attribute. */ public abstract void setAttribute(String name, Object value) throws IllegalArgumentException; /** * Allows the user to retrieve specific attributes on the underlying * implementation. * * @param name The name of the attribute. * * @return value The value of the attribute. * * @throws IllegalArgumentException thrown if the underlying * implementation doesn't recognize the attribute. */ public abstract Object getAttribute(String name) throws IllegalArgumentException; /** * <p>Set a feature for this <code>DocumentBuilderFactory</code> and <code>DocumentBuilder</code>s created by this factory.</p> * * <p> * Feature names are fully qualified {@link java.net.URI}s. * Implementations may define their own features. * A {@link ParserConfigurationException} is thrown if this <code>DocumentBuilderFactory</code> or the * <code>DocumentBuilder</code>s it creates cannot support the feature. * It is possible for a <code>DocumentBuilderFactory</code> to expose a feature value but be unable to change its state. * </p> * * <p> * All implementations are required to support the {@link javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING} feature. * When the feature is:</p> * <ul> * <li> * <code>true</code>: the implementation will limit XML processing to conform to implementation limits. * Examples include enity expansion limits and XML Schema constructs that would consume large amounts of resources. * If XML processing is limited for security reasons, it will be reported via a call to the registered * {@link org.xml.sax.ErrorHandler#fatalError(SAXParseException exception)}. * See {@link DocumentBuilder#setErrorHandler(org.xml.sax.ErrorHandler errorHandler)}. * </li> * <li> * <code>false</code>: the implementation will processing XML according to the XML specifications without * regard to possible implementation limits. * </li> * </ul> * * @param name Feature name. * @param value Is feature state <code>true</code> or <code>false</code>. * * @throws ParserConfigurationException if this <code>DocumentBuilderFactory</code> or the <code>DocumentBuilder</code>s * it creates cannot support this feature. * @throws NullPointerException If the <code>name</code> parameter is null. */ public abstract void setFeature(String name, boolean value) throws ParserConfigurationException; /** * <p>Get the state of the named feature.</p> * * <p> * Feature names are fully qualified {@link java.net.URI}s. * Implementations may define their own features. * An {@link ParserConfigurationException} is thrown if this <code>DocumentBuilderFactory</code> or the * <code>DocumentBuilder</code>s it creates cannot support the feature. * It is possible for an <code>DocumentBuilderFactory</code> to expose a feature value but be unable to change its state. * </p> * * @param name Feature name. * * @return State of the named feature. * * @throws ParserConfigurationException if this <code>DocumentBuilderFactory</code> * or the <code>DocumentBuilder</code>s it creates cannot support this feature. */ public abstract boolean getFeature(String name) throws ParserConfigurationException; /** <p>Get current state of canonicalization.</p> * * @return current state canonicalization control */ /* public boolean getCanonicalization() { return canonicalState; } */ /** * Gets the {@link Schema} object specified through * the {@link #setSchema(Schema schema)} method. * * @return * the {@link Schema} object that was last set through * the {@link #setSchema(Schema)} method, or null * if the method was not invoked since a {@link DocumentBuilderFactory} * is created. * * @throws UnsupportedOperationException When implementation does not * override this method. * * @since 1.5 */ public Schema getSchema() { throw new UnsupportedOperationException( "This parser does not support specification \"" + this.getClass().getPackage().getSpecificationTitle() + "\" version \"" + this.getClass().getPackage().getSpecificationVersion() + "\"" ); } /* <p>Set canonicalization control to <code>true</code> or * </code>false</code>.</p> * * @param state of canonicalization */ /* public void setCanonicalization(boolean state) { canonicalState = state; } */ /** * <p>Set the {@link Schema} to be used by parsers created * from this factory. * * <p> * When a {@link Schema} is non-null, a parser will use a validator * created from it to validate documents before it passes information * down to the application. * * <p>When errors are found by the validator, the parser is responsible * to report them to the user-specified {@link org.xml.sax.ErrorHandler} * (or if the error handler is not set, ignore them or throw them), just * like any other errors found by the parser itself. * In other words, if the user-specified {@link org.xml.sax.ErrorHandler} * is set, it must receive those errors, and if not, they must be * treated according to the implementation specific * default error handling rules. * * <p> * A validator may modify the outcome of a parse (for example by * adding default values that were missing in documents), and a parser * is responsible to make sure that the application will receive * modified DOM trees. * * <p> * Initialy, null is set as the {@link Schema}. * * <p> * This processing will take effect even if * the {@link #isValidating()} method returns <code>false</code>. * * <p>It is an error to use * the <code>http://java.sun.com/xml/jaxp/properties/schemaSource</code> * property and/or the <code>http://java.sun.com/xml/jaxp/properties/schemaLanguage</code> * property in conjunction with a {@link Schema} object. * Such configuration will cause a {@link ParserConfigurationException} * exception when the {@link #newDocumentBuilder()} is invoked.</p> * * * <h4>Note for implmentors</h4> * * <p> * A parser must be able to work with any {@link Schema} * implementation. However, parsers and schemas are allowed * to use implementation-specific custom mechanisms * as long as they yield the result described in the specification. * </p> * * @param schema <code>Schema</code> to use or <code>null</code> * to remove a schema. * * @throws UnsupportedOperationException When implementation does not * override this method. * * @since 1.5 */ public void setSchema(Schema schema) { throw new UnsupportedOperationException( "This parser does not support specification \"" + this.getClass().getPackage().getSpecificationTitle() + "\" version \"" + this.getClass().getPackage().getSpecificationVersion() + "\"" ); } /** * <p>Set state of XInclude processing.</p> * * <p>If XInclude markup is found in the document instance, should it be * processed as specified in <a href="http://www.w3.org/TR/xinclude/"> * XML Inclusions (XInclude) Version 1.0</a>.</p> * * <p>XInclude processing defaults to <code>false</code>.</p> * * @param state Set XInclude processing to <code>true</code> or * <code>false</code> * * @throws UnsupportedOperationException When implementation does not * override this method. * * @since 1.5 */ public void setXIncludeAware(final boolean state) { throw new UnsupportedOperationException( "This parser does not support specification \"" + this.getClass().getPackage().getSpecificationTitle() + "\" version \"" + this.getClass().getPackage().getSpecificationVersion() + "\"" ); } /** * <p>Get state of XInclude processing.</p> * * @return current state of XInclude processing * * @throws UnsupportedOperationException When implementation does not * override this method. * * @since 1.5 */ public boolean isXIncludeAware() { throw new UnsupportedOperationException( "This parser does not support specification \"" + this.getClass().getPackage().getSpecificationTitle() + "\" version \"" + this.getClass().getPackage().getSpecificationVersion() + "\"" ); } }