You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cactus-dev@jakarta.apache.org by cm...@apache.org on 2003/05/13 22:38:25 UTC
cvs commit: jakarta-cactus/integration/ant/src/java/org/apache/cactus/integration/ant/applicationxml ApplicationXmlIo.java
cmlenz 2003/05/13 13:38:25
Added: integration/ant/src/java/org/apache/cactus/integration/ant/applicationxml
ApplicationXmlIo.java
Log:
Add utility methods for parsing application.xml descriptors
Revision Changes Path
1.1 jakarta-cactus/integration/ant/src/java/org/apache/cactus/integration/ant/applicationxml/ApplicationXmlIo.java
Index: ApplicationXmlIo.java
===================================================================
/*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 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 acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Cactus" 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 apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* 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.cactus.integration.ant.applicationxml;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.jar.JarInputStream;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.apache.cactus.integration.ant.util.ResourceUtils;
import org.xml.sax.EntityResolver;
import org.xml.sax.SAXException;
/**
* Provides convenience methods for reading and writing enterprise application
* deployment descriptors (application.xml).
*
* @author <a href="mailto:cmlenz@apache.org">Christopher Lenz</a>
*
* @since Cactus 1.5
* @version $Id: ApplicationXmlIo.java,v 1.1 2003/05/13 20:38:25 cmlenz Exp $
*/
public class ApplicationXmlIo
{
// Public Methods ----------------------------------------------------------
/**
* Parses the deployment descriptor of a enterprise application archive
* (EAR).
*
* @param theEar The enterprise application archive
* @param theEntityResolver A SAX entity resolver, or <code>null</code> to
* use the default
* @return The parsed descriptor, or <code>null</code> if no descriptor was
* found in the WAR
* @throws SAXException If the descriptor could not be parsed
* @throws ParserConfigurationException If the XML parser was not correctly
* configured
* @throws IOException If an I/O error occurs
*/
public static ApplicationXml parseApplicationXmlFromEar(
JarInputStream theEar, EntityResolver theEntityResolver)
throws SAXException, ParserConfigurationException, IOException
{
InputStream in = null;
try
{
in = ResourceUtils.getResource(theEar, "META-INF/application.xml");
return parseApplicationXml(in, theEntityResolver);
}
finally
{
if (in != null)
{
try
{
in.close();
}
catch (IOException ioe)
{
// we'll pass on the original IO error, so ignore this one
}
}
}
}
/**
* Parses a deployment descriptor stored in a regular file.
*
* @param theFile The file to parse
* @param theEntityResolver A SAX entity resolver, or <code>null</code> to
* use the default
* @return The parsed descriptor
* @throws SAXException If the file could not be parsed
* @throws ParserConfigurationException If the XML parser was not correctly
* configured
* @throws IOException If an I/O error occurs
*/
public static ApplicationXml parseApplicationXmlFromFile(File theFile,
EntityResolver theEntityResolver)
throws SAXException, ParserConfigurationException, IOException
{
InputStream in = null;
try
{
in = new FileInputStream(theFile);
return parseApplicationXml(in, theEntityResolver);
}
finally
{
if (in != null)
{
try
{
in.close();
}
catch (IOException ioe)
{
// we'll pass on the original IO error, so ignore this one
}
}
}
}
/**
* Parses a deployment descriptor provided as input stream.
*
* @param theInput The input stream
* @param theEntityResolver A SAX entity resolver, or <code>null</code> to
* use the default
* @return The parsed descriptor
* @throws SAXException If the input could not be parsed
* @throws ParserConfigurationException If the XML parser was not correctly
* configured
* @throws IOException If an I/O error occurs
*/
public static ApplicationXml parseApplicationXml(InputStream theInput,
EntityResolver theEntityResolver)
throws SAXException, ParserConfigurationException, IOException
{
DocumentBuilderFactory factory =
DocumentBuilderFactory.newInstance();
factory.setValidating(false);
factory.setNamespaceAware(false);
DocumentBuilder builder = factory.newDocumentBuilder();
if (theEntityResolver != null)
{
builder.setEntityResolver(theEntityResolver);
}
return new ApplicationXml(builder.parse(theInput));
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: cactus-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: cactus-dev-help@jakarta.apache.org