org.codehaus.cargo.module.webapp
Interface WarArchive

All Superinterfaces:

JarArchive

All Known Implementing Classes:

DefaultWarArchive, WarArchiveMerger.MergedWarArchive

public interface WarArchive
extends JarArchive

Encapsulates access to a WAR.

Version:

$Id: WarArchive.java 1090 2006-07-15 21:25:50Z vmassol $

Method Summary

WebXml	getWebXml() Returns the deployment descriptor of the web application.
void	store(java.io.File warFile) Stores the war archive to file.

Methods inherited from interface org.codehaus.cargo.module.JarArchive

containsClass, expandToPath, findResource, getResource, getResources

Method Detail

getWebXml

WebXml getWebXml()
                 throws java.io.IOException,
                        org.xml.sax.SAXException,
                        javax.xml.parsers.ParserConfigurationException

Returns the deployment descriptor of the web application.

Returns:

The parsed deployment descriptor

Throws:

java.io.IOException - If there was a problem reading the deployment descriptor in the WAR

org.xml.sax.SAXException - If the deployment descriptor of the WAR could not be parsed

javax.xml.parsers.ParserConfigurationException - If there is an XML parser configuration problem

store

void store(java.io.File warFile)
           throws java.io.IOException,
                  org.xml.sax.SAXException,
                  javax.xml.parsers.ParserConfigurationException

Stores the war archive to file. Changes to the descriptors of the war archive will be stored as well.

Parameters:

warFile - file to store the war in.

Throws:

java.io.IOException - If there was a problem reading the deployment descriptor in the WAR

org.xml.sax.SAXException - If the deployment descriptor of the WAR could not be parsed

javax.xml.parsers.ParserConfigurationException - If there is an XML parser configuration problem