org.xwiki.xml.internal
Class LocalEntityResolver

java.lang.Object
  org.xwiki.xml.internal.LocalEntityResolver

All Implemented Interfaces:

org.xml.sax.EntityResolver

@Component
@Singleton
public class LocalEntityResolver
extends java.lang.Object
implements EntityResolver

Entity resolver that resolves entities using entity files (like xhtml-symbol.ent, xhtml-special.ent, xhtml-lat1.ent) located on the file system (in the classpath). This allows an XML parser that uses this entity resolver to work even when there's no internet connection. It also speeds up the entity resolution.

Version:

$Id$

Constructor Summary

LocalEntityResolver()

Method Summary

org.xml.sax.InputSource

resolveEntity(java.lang.String publicId, java.lang.String systemId) Allow the application to resolve external entities.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocalEntityResolver

public LocalEntityResolver()

Method Detail

resolveEntity

public org.xml.sax.InputSource resolveEntity(java.lang.String publicId,
                                             java.lang.String systemId)
                                      throws org.xml.sax.SAXException,
                                             java.io.IOException

Allow the application to resolve external entities.

The Parser will call this method before opening any external entity except the top-level document entity including the external DTD subset, external entities referenced within the DTD, and external entities referenced within the document element): the application may request that the parser resolve the entity itself, that it use an alternative URI, or that it use an entirely different input source.

Application writers can use this method to redirect external system identifiers to secure and/or local URIs, to look up public identifiers in a catalogue, or to read an entity from a database or other input source (including, for example, a dialog box).

If the system identifier is a URL, the SAX parser must resolve it fully before reporting it to the application.

Specified by:

resolveEntity in interface org.xml.sax.EntityResolver

Parameters:

publicId - The public identifier of the external entity being referenced, or null if none was supplied.

systemId - The system identifier of the external entity being referenced.

Returns:

An InputSource object describing the new input source, or null to request that the parser open a regular URI connection to the system identifier.

Throws:

org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.

java.io.IOException - A Java-specific IO exception, possibly the result of creating a new InputStream or Reader for the InputSource.

See Also:

InputSource