org.apache.excalibur.xml
Class DefaultEntityResolver

java.lang.Object
  extended byorg.apache.avalon.framework.logger.AbstractLogEnabled
      extended byorg.apache.excalibur.xml.DefaultEntityResolver
All Implemented Interfaces:
Component, Disposable, EntityResolver, org.xml.sax.EntityResolver, LogEnabled, Parameterizable, Serviceable, ThreadSafe

public class DefaultEntityResolver
extends AbstractLogEnabled
implements EntityResolver, Serviceable, Parameterizable, ThreadSafe, Disposable, Component

A component that uses catalogs for resolving entities. This implementation uses the XML Entity and URI Resolvers from http://xml.apache.org/commons/ published by Norman Walsh. More information on the catalogs can be found at http://xml.apache.org/cocoon/userdocs/concepts/catalog.html

Version:
CVS $Id: DefaultEntityResolver.java,v 1.4 2004/02/28 11:47:36 cziegeler Exp $
Author:
Avalon Development Team

Field Summary
protected  org.apache.xml.resolver.CatalogManager catalogManager
          The catalog manager
protected  org.apache.xml.resolver.tools.CatalogResolver catalogResolver
          The catalog resolver
protected  ServiceManager manager
          The component manager
protected  SourceResolver resolver
          SourceResolver
 
Fields inherited from interface org.apache.excalibur.xml.EntityResolver
ROLE
 
Constructor Summary
DefaultEntityResolver()
           
 
Method Summary
protected  java.lang.String defaultCatalog()
          Default catalog path
 void dispose()
          Dispose
 void parameterize(Parameters params)
          Set the configuration.
protected  void parseCatalog(java.lang.String file)
          Parse a catalog
 org.xml.sax.InputSource resolveEntity(java.lang.String publicId, java.lang.String systemId)
          Allow the application to resolve external entities.
 void service(ServiceManager manager)
          Set the global component manager.
 
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

catalogManager

protected org.apache.xml.resolver.CatalogManager catalogManager
The catalog manager


catalogResolver

protected org.apache.xml.resolver.tools.CatalogResolver catalogResolver
The catalog resolver


manager

protected ServiceManager manager
The component manager


resolver

protected SourceResolver resolver
SourceResolver

Constructor Detail

DefaultEntityResolver

public DefaultEntityResolver()
Method Detail

parameterize

public void parameterize(Parameters params)
                  throws ParameterException
Set the configuration. Load the system catalog and apply any parameters that may have been specified in cocoon.xconf

Specified by:
parameterize in interface Parameterizable
Parameters:
params - The configuration information
Throws:
ParameterException

parseCatalog

protected void parseCatalog(java.lang.String file)
Parse a catalog


defaultCatalog

protected java.lang.String defaultCatalog()
Default catalog path


service

public void service(ServiceManager manager)
             throws ServiceException
Set the global component manager.

Specified by:
service in interface Serviceable
Parameters:
manager - The global component manager
Throws:
ServiceException

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

dispose

public void dispose()
Dispose

Specified by:
dispose in interface Disposable


Copyright © 1997-2005 The Apache Software Foundation. All Rights Reserved.