org.apache.cocoon.components.resolver
Class ResolverImpl

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.components.resolver.ResolverImpl

All Implemented Interfaces:

Disposable, Component, Composable, Contextualizable, LogEnabled, Parameterizable, ThreadSafe, Resolver, EntityResolver

public class ResolverImpl
extends AbstractLogEnabled
implements EntityResolver, Resolver, Contextualizable, Composable, Parameterizable, ThreadSafe, Disposable

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://cocoon.apache.org/userdocs/concepts/catalog.html The catalog is by default loaded from "WEB-INF/entities/catalog". This can be configured by the "catalog" parameter in the cocoon.xconf: <entity-resolver> <parameter name="catalog" value="mycatalog"/> </entity-resolver>

Since:

2.0rc1

Version:

CVS $Id: ResolverImpl.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Davanum Srinivas, David Crossley

Field Summary

protected org.apache.xml.resolver.CatalogManager	catalogManager The catalog manager
protected org.apache.xml.resolver.tools.CatalogResolver	catalogResolver The catalog resolver
protected Context	context The context
protected ComponentManager	manager The component manager

Fields inherited from interface org.apache.excalibur.xml.EntityResolver

ROLE

Fields inherited from interface org.apache.cocoon.components.resolver.Resolver

ROLE

Constructor Summary

ResolverImpl()

Method Summary

void	compose(ComponentManager manager) Set the global component manager.
void	contextualize(Context context) Contextualize this class
void	dispose() Dispose
void	parameterize(Parameters params) Set the configuration.
InputSource	resolveEntity(String publicId, String systemId) Allow the application to resolve external entities.

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 ComponentManager manager

The component manager

context

protected Context context

The context

Constructor Detail

ResolverImpl

public ResolverImpl()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Contextualize this class

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

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

compose

public void compose(ComponentManager manager)
             throws ComponentException

Set the global component manager.

Specified by:

compose in interface Composable

Parameters:

manager - The global component manager

Throws:

ComponentException

resolveEntity

public InputSource resolveEntity(String publicId,
                                 String systemId)
                          throws SAXException,
                                 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 Resolver

Specified by:

resolveEntity in interface 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:

SAXException - Any SAX exception, possibly wrapping another exception.

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