cziegeler 2003/02/27 01:49:13
Added: xmlutil/lib resolver-20021114.jar LICENSE.resolver.txt
xmlutil/src/java/org/apache/excalibur/xml
DefaultEntityResolver.java
Log:
Adding resolver implementation from cocoon
Revision Changes Path
1.1 avalon-excalibur/xmlutil/lib/resolver-20021114.jar
<<Binary file>>
1.1 avalon-excalibur/xmlutil/lib/LICENSE.resolver.txt
Index: LICENSE.resolver.txt
===================================================================
/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Xalan" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 2001, International
* Business Machines Corporation., http://www.ibm.com. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
1.1
avalon-excalibur/xmlutil/src/java/org/apache/excalibur/xml/DefaultEntityResolver.java
Index: DefaultEntityResolver.java
===================================================================
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software
* itself, if and wherever such third-party acknowledgments
* normally appear.
*
* 4. The names "Jakarta", "Avalon", and "Apache Software Foundation"
* must not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.excalibur.xml;
import java.io.IOException;
import org.apache.avalon.framework.activity.Disposable;
import org.apache.avalon.framework.component.ComponentException;
import org.apache.avalon.framework.component.ComponentManager;
import org.apache.avalon.framework.component.Composable;
import org.apache.avalon.framework.logger.AbstractLogEnabled;
import org.apache.avalon.framework.parameters.ParameterException;
import org.apache.avalon.framework.parameters.Parameterizable;
import org.apache.avalon.framework.parameters.Parameters;
import org.apache.avalon.framework.thread.ThreadSafe;
import org.apache.excalibur.source.Source;
import org.apache.excalibur.source.SourceResolver;
import org.apache.xml.resolver.CatalogManager;
import org.apache.xml.resolver.tools.CatalogResolver;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
/**
* 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
*
* 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>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Davanum Srinivas</a>
* @author <a href="mailto:[EMAIL PROTECTED]">David Crossley</a>
* @version CVS $Id: DefaultEntityResolver.java,v 1.1 2003/02/27 09:49:13 cziegeler
Exp $
*/
public class DefaultEntityResolver extends AbstractLogEnabled
implements EntityResolver,
Composable,
Parameterizable,
ThreadSafe,
Disposable {
/** The catalog manager */
protected CatalogManager catalogManager = new CatalogManager();
/** The catalog resolver */
protected CatalogResolver catalogResolver = new CatalogResolver(catalogManager);
/** The component manager */
protected ComponentManager manager;
/** SourceResolver */
protected SourceResolver resolver;
/**
* Set the configuration. Load the system catalog and apply any
* parameters that may have been specified in cocoon.xconf
* @param params The configuration information
* @exception ParameterException
*/
public void parameterize(Parameters params)
throws ParameterException
{
// Over-ride debug level that is set by CatalogManager.properties
String verbosity = params.getParameter("verbosity", null);
if ( null != verbosity )
{
if (this.getLogger().isDebugEnabled())
{
this.getLogger().debug("Setting Catalog resolver "
+ "verbosity level to " + verbosity);
}
int verbosityLevel = 0;
try
{
verbosityLevel = Integer.parseInt(verbosity);
catalogManager.setVerbosity(verbosityLevel);
}
catch (NumberFormatException ce1)
{
this.getLogger().warn("Trouble setting Catalog verbosity",
ce1);
}
}
// Load the built-in catalog
// FIXME - remove dependency to servlet
String catalogFile = params.getParameter("catalog",
"/WEB-INF/entities/catalog");
this.parseCatalog(catalogFile);
// Load a single additional local catalog
String localCatalogFile = params.getParameter("local-catalog", null);
if ( null != localCatalogFile )
{
this.parseCatalog( localCatalogFile );
}
}
/**
* Parse a catalog
*/
protected void parseCatalog(String file)
{
if (this.getLogger().isDebugEnabled())
{
this.getLogger().debug("Additional Catalog is " + file);
}
Source source = null;
try
{
source = this.resolver.resolveURI(file);
this.catalogResolver.getCatalog().parseCatalog(source.getURI(),
source.getInputStream());
}
catch (Exception e)
{
this.getLogger().warn("Could not get Catalog file " + file, e);
}
finally
{
this.resolver.release( source );
}
}
/**
* Set the global component manager.
* @param manager The global component manager
* @exception ComponentException
*/
public void compose(ComponentManager manager)
throws ComponentException
{
if ( null == this.manager )
{
this.manager = manager;
this.resolver = (SourceResolver) this.manager.lookup(
SourceResolver.ROLE );
}
}
/**
* Allow the application to resolve external entities.
*
* <p>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.</p>
*
* <p>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).</p>
*
* <p>If the system identifier is a URL, the SAX parser must
* resolve it fully before reporting it to the application.</p>
*
* @param publicId The public identifier of the external entity
* being referenced, or null if none was supplied.
* @param systemId The system identifier of the external entity
* being referenced.
* @return An InputSource object describing the new input source,
* or null to request that the parser open a regular
* URI connection to the system identifier.
* @exception org.xml.sax.SAXException Any SAX exception, possibly
* wrapping another exception.
* @exception java.io.IOException A Java-specific IO exception,
* possibly the result of creating a new InputStream
* or Reader for the InputSource.
* @see org.xml.sax.InputSource
*/
public InputSource resolveEntity(String publicId, String systemId)
throws SAXException, IOException
{
InputSource altInputSource = catalogResolver.resolveEntity(publicId,
systemId);
if (altInputSource != null)
{
if (this.getLogger().isDebugEnabled())
{
this.getLogger().debug("Resolved catalog entity: "
+ publicId + " " + altInputSource.getSystemId());
}
}
return altInputSource;
}
/**
* Dispose
*/
public void dispose()
{
if ( null != this.resolver )
{
this.manager.release( this.resolver );
}
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
