This class implements a SAX Parser that performs entity resolution * using the CatalogResolver. The actual, underlying parser is obtained * from a SAXParserFactory.
* * * @deprecated This interface has been replaced by the * {@link org.apache.xml.resolver.tools.ResolvingXMLReader} for SAX2. * @see CatalogResolver * @see org.xml.sax.Parser * * @author Norman Walsh * Norman.Walsh@Sun.COM * * @version 1.0 */ public class ResolvingParser implements Parser, DTDHandler, DocumentHandler, EntityResolver { /** Make the parser Namespace aware? */ public static boolean namespaceAware = true; /** Make the parser validating? */ public static boolean validating = false; /** Suppress explanatory message? * * @see #parse(InputSource) */ public static boolean suppressExplanation = false; /** The underlying parser. */ private SAXParser saxParser = null; /** The underlying reader. */ private Parser parser = null; /** The underlying DocumentHandler. */ private DocumentHandler documentHandler = null; /** The underlying DTDHandler. */ private DTDHandler dtdHandler = null; /** The manager for the underlying resolver. */ private CatalogManager catalogManager = CatalogManager.getStaticManager(); /** The underlying catalog resolver. */ private CatalogResolver catalogResolver = null; /** A separate resolver for oasis-xml-pi catalogs. */ private CatalogResolver piCatalogResolver = null; /** Are we in the prolog? Is an oasis-xml-catalog PI valid now? */ private boolean allowXMLCatalogPI = false; /** Has an oasis-xml-catalog PI been seen? */ private boolean oasisXMLCatalogPI = false; /** The base URI of the input document, if known. */ private URL baseURL = null; /** Constructor. */ public ResolvingParser() { initParser(); } /** Constructor. */ public ResolvingParser(CatalogManager manager) { catalogManager = manager; initParser(); } /** Initialize the parser. */ private void initParser() { catalogResolver = new CatalogResolver(catalogManager); SAXParserFactory spf = SAXParserFactory.newInstance(); spf.setNamespaceAware(namespaceAware); spf.setValidating(validating); try { saxParser = spf.newSAXParser(); parser = saxParser.getParser(); documentHandler = null; dtdHandler = null; } catch (Exception ex) { ex.printStackTrace(); } } /** Return the Catalog being used. */ public Catalog getCatalog() { return catalogResolver.getCatalog(); } /** * SAX Parser API. * *Note that the JAXP 1.1ea2 parser crashes with an InternalError if * it encounters a system identifier that appears to be a relative URI * that begins with a slash. For example, the declaration:
* ** <!DOCTYPE book SYSTEM "/path/to/dtd/on/my/system/docbookx.dtd"> ** *
would cause such an error. As a convenience, this method catches * that error and prints an explanation. (Unfortunately, it's not possible * to identify the particular system identifier that causes the problem.) *
* *The underlying error is forwarded after printing the explanatory
* message. The message is only every printed once and if
* suppressExplanation is set to false before
* parsing, it will never be printed.
The purpose of this class is to implement an entity resolver. * Attempting to set a different one is pointless (and ignored).
*/ public void setEntityResolver(EntityResolver resolver) { // nop } /** SAX Parser API. */ public void setErrorHandler(ErrorHandler handler) { parser.setErrorHandler(handler); } /** SAX Parser API. */ public void setLocale(Locale locale) throws SAXException { parser.setLocale(locale); } /** SAX DocumentHandler API. */ public void characters(char[] ch, int start, int length) throws SAXException { if (documentHandler != null) { documentHandler.characters(ch,start,length); } } /** SAX DocumentHandler API. */ public void endDocument() throws SAXException { if (documentHandler != null) { documentHandler.endDocument(); } } /** SAX DocumentHandler API. */ public void endElement(String name) throws SAXException { if (documentHandler != null) { documentHandler.endElement(name); } } /** SAX DocumentHandler API. */ public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException { if (documentHandler != null) { documentHandler.ignorableWhitespace(ch,start,length); } } /** SAX DocumentHandler API. */ public void processingInstruction(String target, String pidata) throws SAXException { if (target.equals("oasis-xml-catalog")) { URL catalog = null; String data = pidata; int pos = data.indexOf("catalog="); if (pos >= 0) { data = data.substring(pos+8); if (data.length() > 1) { String quote = data.substring(0,1); data = data.substring(1); pos = data.indexOf(quote); if (pos >= 0) { data = data.substring(0, pos); try { if (baseURL != null) { catalog = new URL(baseURL, data); } else { catalog = new URL(data); } } catch (MalformedURLException mue) { // nevermind } } } } if (allowXMLCatalogPI) { if (catalogManager.allowOasisXMLCatalogPI()) { catalogManager.debug.message(4,"oasis-xml-catalog PI", pidata); if (catalog != null) { try { catalogManager.debug.message(4,"oasis-xml-catalog", catalog.toString()); oasisXMLCatalogPI = true; if (piCatalogResolver == null) { piCatalogResolver = new CatalogResolver(true); } piCatalogResolver.getCatalog().parseCatalog(catalog.toString()); } catch (Exception e) { catalogManager.debug.message(3, "Exception parsing oasis-xml-catalog: " + catalog.toString()); } } else { catalogManager.debug.message(3, "PI oasis-xml-catalog unparseable: " + pidata); } } else { catalogManager.debug.message(4,"PI oasis-xml-catalog ignored: " + pidata); } } else { catalogManager.debug.message(3, "PI oasis-xml-catalog occurred in an invalid place: " + pidata); } } else { if (documentHandler != null) { documentHandler.processingInstruction(target, pidata); } } } /** SAX DocumentHandler API. */ public void setDocumentLocator(Locator locator) { if (documentHandler != null) { documentHandler.setDocumentLocator(locator); } } /** SAX DocumentHandler API. */ public void startDocument() throws SAXException { if (documentHandler != null) { documentHandler.startDocument(); } } /** SAX DocumentHandler API. */ public void startElement(String name, AttributeList atts) throws SAXException { allowXMLCatalogPI = false; if (documentHandler != null) { documentHandler.startElement(name,atts); } } /** SAX DTDHandler API. */ public void notationDecl (String name, String publicId, String systemId) throws SAXException { allowXMLCatalogPI = false; if (dtdHandler != null) { dtdHandler.notationDecl(name,publicId,systemId); } } /** SAX DTDHandler API. */ public void unparsedEntityDecl (String name, String publicId, String systemId, String notationName) throws SAXException { allowXMLCatalogPI = false; if (dtdHandler != null) { dtdHandler.unparsedEntityDecl (name, publicId, systemId, notationName); } } /** * Implements theresolveEntity method
* for the SAX interface, using an underlying CatalogResolver
* to do the real work.
*/
public InputSource resolveEntity (String publicId, String systemId) {
allowXMLCatalogPI = false;
String resolved = catalogResolver.getResolvedEntity(publicId, systemId);
if (resolved == null && piCatalogResolver != null) {
resolved = piCatalogResolver.getResolvedEntity(publicId, systemId);
}
if (resolved != null) {
try {
InputSource iSource = new InputSource(resolved);
iSource.setPublicId(publicId);
// Ideally this method would not attempt to open the
// InputStream, but there is a bug (in Xerces, at least)
// that causes the parser to mistakenly open the wrong
// system identifier if the returned InputSource does
// not have a byteStream.
//
// It could be argued that we still shouldn't do this here,
// but since the purpose of calling the entityResolver is
// almost certainly to open the input stream, it seems to
// do little harm.
//
URL url = new URL(resolved);
InputStream iStream = url.openStream();
iSource.setByteStream(iStream);
return iSource;
} catch (Exception e) {
catalogManager.debug.message(1, "Failed to create InputSource", resolved);
return null;
}
} else {
return null;
}
}
/** Setup for parsing. */
private void setupParse(String systemId) {
allowXMLCatalogPI = true;
parser.setEntityResolver(this);
parser.setDocumentHandler(this);
parser.setDTDHandler(this);
String userdir = System.getProperty("user.dir");
URL cwd = null;
userdir.replace('\\', '/');
try {
cwd = new URL("file:///" + userdir + "/basename");
} catch (MalformedURLException mue) {
cwd = null;
}
try {
baseURL = new URL(systemId);
} catch (MalformedURLException mue) {
if (cwd != null) {
try {
baseURL = new URL(cwd, systemId);
} catch (MalformedURLException mue2) {
// give up
baseURL = null;
}
} else {
// give up
baseURL = null;
}
}
}
/** Provide one possible explanation for an InternalError. */
private void explain(String systemId) {
if (!suppressExplanation) {
System.out.println("Parser probably encountered bad URI in " + systemId);
System.out.println("For example, replace '/some/uri' with 'file:/some/uri'.");
}
}
}