org.apache.avalon.excalibur.xml
Interface EntityResolver

All Superinterfaces:
org.apache.avalon.framework.component.Component, org.xml.sax.EntityResolver

public interface EntityResolver
extends org.apache.avalon.framework.component.Component, org.xml.sax.EntityResolver

A component that uses catalogs for resolving Entities.

Version:
CVS $Revision: 1.1 $ $Date: 2001/12/27 15:00:32 $
Author:
Davanum Srinivas

Field Summary
static java.lang.String ROLE
           
 
Method Summary
 org.xml.sax.InputSource resolveEntity(java.lang.String publicId, java.lang.String systemId)
          Allow the application to resolve external entities.
 

Field Detail

ROLE

public static final java.lang.String ROLE
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


Copyright 2001 Apache Jakarta Project. All Rights Reserved.