org.codehaus.cargo.module.webapp

Interface WarArchive

All Superinterfaces:

JarArchive

All Known Implementing Classes:

DefaultWarArchive, MergedWarArchive

public interface WarArchive
extends JarArchive

Encapsulates access to a WAR.

Version:

$Id: WarArchive.java 1705 2008-09-02 13:14:55Z adriana $

Method Summary

Methods

Modifier and Type	Method and Description
WebXml	getWebXml() Returns the deployment descriptor of the web application.
void	store(File warFile) Stores the war archive to file.

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

containsClass, expandToPath, expandToPath, findResource, getResource, getResources

Method Detail

getWebXml

WebXml getWebXml()
                 throws IOException,
                        org.jdom.JDOMException

Returns the deployment descriptor of the web application.

Returns:

The parsed deployment descriptor

Throws:

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

org.jdom.JDOMException - If the deployment descriptor of the WAR could not be parsed

store

void store(File warFile)
           throws IOException,
                  org.jdom.JDOMException

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:

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

org.jdom.JDOMException - If the deployment descriptor of the WAR could not be parsed