001: /*--
002:
003: $Id: JAXPParserFactory.java,v 1.5 2004/02/27 21:08:47 jhunter Exp $
004:
005: Copyright (C) 2000-2004 Jason Hunter & Brett McLaughlin.
006: All rights reserved.
007:
008: Redistribution and use in source and binary forms, with or without
009: modification, are permitted provided that the following conditions
010: are met:
011:
012: 1. Redistributions of source code must retain the above copyright
013: notice, this list of conditions, and the following disclaimer.
014:
015: 2. Redistributions in binary form must reproduce the above copyright
016: notice, this list of conditions, and the disclaimer that follows
017: these conditions in the documentation and/or other materials
018: provided with the distribution.
019:
020: 3. The name "JDOM" must not be used to endorse or promote products
021: derived from this software without prior written permission. For
022: written permission, please contact <request_AT_jdom_DOT_org>.
023:
024: 4. Products derived from this software may not be called "JDOM", nor
025: may "JDOM" appear in their name, without prior written permission
026: from the JDOM Project Management <request_AT_jdom_DOT_org>.
027:
028: In addition, we request (but do not require) that you include in the
029: end-user documentation provided with the redistribution and/or in the
030: software itself an acknowledgement equivalent to the following:
031: "This product includes software developed by the
032: JDOM Project (http://www.jdom.org/)."
033: Alternatively, the acknowledgment may be graphical using the logos
034: available at http://www.jdom.org/images/logos.
035:
036: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
040: CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: SUCH DAMAGE.
048:
049: This software consists of voluntary contributions made by many
050: individuals on behalf of the JDOM Project and was originally
051: created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
052: Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information
053: on the JDOM Project, please see <http://www.jdom.org/>.
054:
055: */
056:
057: package org.jdom.input;
058:
059: import java.util.*;
060:
061: import javax.xml.parsers.*;
062:
063: import org.jdom.*;
064: import org.xml.sax.*;
065:
066: /**
067: * A non-public utility class to allocate JAXP SAX parsers.
068: *
069: * @version $Revision: 1.5 $, $Date: 2004/02/27 21:08:47 $
070: * @author Laurent Bihanic
071: */
072: class JAXPParserFactory { // package protected
073:
074: private static final String CVS_ID = "@(#) $RCSfile: JAXPParserFactory.java,v $ $Revision: 1.5 $ $Date: 2004/02/27 21:08:47 $ $Name: jdom_1_0 $";
075:
076: /** JAXP 1.2 schema language property id. */
077: private static final String JAXP_SCHEMA_LANGUAGE_PROPERTY = "http://java.sun.com/xml/jaxp/properties/schemaLanguage";
078:
079: /** JAXP 1.2 schema location property id. */
080: private static final String JAXP_SCHEMA_LOCATION_PROPERTY = "http://java.sun.com/xml/jaxp/properties/schemaSource";
081:
082: /**
083: * Private constructor to forbid allocating instances of this utility
084: * class.
085: */
086: private JAXPParserFactory() {
087: // Never called.
088: }
089:
090: /* Implementor's note regarding createParser() design: The features and
091: properties are normally set in SAXBuilder, but we take them in
092: createParser() as well because some features or properties may need to be
093: applied during the JAXP parser construction. Today, for example, properties
094: is used as it's the only way to configure schema validation: JAXP defines
095: schema validation properties but SAX does not. This reflects in the Apache
096: Xerces implementation where the SAXParser implementation supports the JAXP
097: properties but the XMLReader does not. Hence, configuring schema validation
098: must be done on the SAXParser object which is only visible in
099: JAXParserFactory. Features is also passed in case some future JAXP release
100: defines JAXP-specific features.
101: */
102:
103: /**
104: * Creates a SAX parser allocated through the configured JAXP SAX
105: * parser factory.
106: *
107: * @param validating whether a validating parser is requested.
108: * @param features the user-defined SAX features.
109: * @param properties the user-defined SAX properties.
110: *
111: * @return a configured XMLReader.
112: *
113: * @throws JDOMException if any error occurred when allocating or
114: * configuring the JAXP SAX parser.
115: */
116: public static XMLReader createParser(boolean validating,
117: Map features, Map properties) throws JDOMException {
118: try {
119: SAXParser parser = null;
120:
121: // Allocate and configure JAXP SAX parser factory.
122: SAXParserFactory factory = SAXParserFactory.newInstance();
123: factory.setValidating(validating);
124: factory.setNamespaceAware(true);
125:
126: try {
127: // Allocate parser.
128: parser = factory.newSAXParser();
129: } catch (ParserConfigurationException e) {
130: throw new JDOMException(
131: "Could not allocate JAXP SAX Parser", e);
132: }
133:
134: // Set user-defined JAXP properties (if any)
135: setProperty(parser, properties,
136: JAXP_SCHEMA_LANGUAGE_PROPERTY);
137: setProperty(parser, properties,
138: JAXP_SCHEMA_LOCATION_PROPERTY);
139:
140: // Return configured SAX XMLReader.
141: return parser.getXMLReader();
142: } catch (SAXException e) {
143: throw new JDOMException(
144: "Could not allocate JAXP SAX Parser", e);
145: }
146: }
147:
148: /**
149: * Sets a property on a JAXP SAX parser object if and only if it
150: * is declared in the user-defined properties.
151: *
152: * @param parser the JAXP SAX parser to configure.
153: * @param properties the user-defined SAX properties.
154: * @param name the name of the property to set.
155: *
156: * @throws JDOMException if any error occurred while configuring
157: * the property.
158: */
159: private static void setProperty(SAXParser parser, Map properties,
160: String name) throws JDOMException {
161: try {
162: if (properties.containsKey(name)) {
163: parser.setProperty(name, properties.get(name));
164: }
165: } catch (SAXNotSupportedException e) {
166: throw new JDOMException(name
167: + " property not supported for JAXP parser "
168: + parser.getClass().getName());
169: } catch (SAXNotRecognizedException e) {
170: throw new JDOMException(name
171: + " property not recognized for JAXP parser "
172: + parser.getClass().getName());
173: }
174: }
175: }
|