KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > soap > util > xml > XMLParserUtils


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2000 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "SOAP" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 2000, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58 package org.apache.soap.util.xml;
59
60 // JAXP packages
61 import javax.xml.parsers.*;
62 import org.xml.sax.*;
63 import org.xml.sax.helpers.*;
64 import org.w3c.dom.*;
65 import org.apache.soap.Constants;
66
67 /**
68  * XML Parser Utilities
69  * Provides methods to set and use JAXP compatible XML parsers.
70  *
71  * @author Ruth Bergman (ruth@alum.mit.edu)
72  * @author Matthew J. Duftler (duftler@us.ibm.com)
73  */
74 public class XMLParserUtils {
75   private static DocumentBuilderFactory dbf = null;
76
77   static {
78     // Create a default instance.
79 refreshDocumentBuilderFactory(null, true, false);
80   }
81
82   /**
83    * Causes the private DocumentBuilderFactory reference to point
84    * to a new instance of a DocumentBuilderFactory. This method
85    * only needs to be called if you want to specify a different
86    * DocumentBuilderFactory implementation then that specified
87    * prior to this class being initialized. Or, if you want to
88    * specify different configuration options.
89    *
90    * @param factoryClassName the fully-qualified name of a class
91    * that implemements DocumentBuilderFactory. If this argument
92    * is null, the default (platform-specific) implementation is
93    * used. Basically, if this argument is not null, the
94    * javax.xml.parsers.DocumentBuilderFactory system property
95    * is set (with the specified value) before the
96    * DocumentBuilderFactory.newInstance() method is invoked.
97    * @param namespaceAware configure the new DocumentBuilderFactory
98    * to produce namespace aware parsers (i.e. DocumentBuilders)
99    * @param validating configure the new DocumentBuilderFactory to
100    * produce validating parsers (i.e. DocumentBuilders)
101    */
102   synchronized public static void refreshDocumentBuilderFactory(
103                                             String JavaDoc factoryClassName,
104                                             boolean namespaceAware,
105                                             boolean validating) {
106     if (factoryClassName != null) {
107       System.setProperty("javax.xml.parsers.DocumentBuilderFactory",
108                          factoryClassName);
109     }
110
111     // Step 1: create a DocumentBuilderFactory and configure it
112 dbf = DocumentBuilderFactory.newInstance();
113
114     // Optional: set various configuration options
115 dbf.setNamespaceAware(namespaceAware);
116     dbf.setValidating(validating);
117
118     /*
119       At this point the DocumentBuilderFactory instance can be saved
120       and reused to create any number of DocumentBuilder instances
121       with the same configuration options.
122     */
123   }
124
125   /**
126    * Use this method to get a JAXP document builder.
127    * This method creates a namespace aware, nonvalidating
128    * instance of the XML parser.
129    *
130    * @return DocumentBuilder an instance of a document builder,
131    * or null if a ParserConfigurationException was thrown.
132    */
133   synchronized public static DocumentBuilder getXMLDocBuilder()
134     throws IllegalArgumentException JavaDoc {
135     // Step 2: create a DocumentBuilder that satisfies the constraints
136 // specified by the DocumentBuilderFactory
137 try {
138       return dbf.newDocumentBuilder();
139     } catch (ParserConfigurationException pce) {
140       throw new IllegalArgumentException JavaDoc(pce.toString());
141     }
142   }
143 }
144
Popular Tags