org.codehaus.cargo.module.application
Interface EarArchive

All Superinterfaces:

JarArchive

All Known Implementing Classes:

DefaultEarArchive

public interface EarArchive
extends JarArchive

Class that encapsulates access to an EAR.

Version:

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

Method Summary

ApplicationXml	getApplicationXml() Returns the deployment descriptor of the web application.
EjbArchive	getEjbModule(java.lang.String uri) Returns the ejb archive stored in the EAR with the specified URI.
WarArchive	getWebModule(java.lang.String uri) Returns the web-app archive stored in the EAR with the specified URI.

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

containsClass, expandToPath, expandToPath, findResource, getResource, getResources

Method Detail

getApplicationXml

ApplicationXml getApplicationXml()
                                 throws java.io.IOException,
                                        org.jdom.JDOMException

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 EAR

org.jdom.JDOMException - If there is an exception reading the application xml

getWebModule

WarArchive getWebModule(java.lang.String uri)
                        throws java.io.IOException

Returns the web-app archive stored in the EAR with the specified URI.

Parameters:

uri - The URI of the web module

Returns:

The web-app archive, or null if no WAR was found at the specified URI

Throws:

java.io.IOException - If there was an errors reading from the EAR or WAR

getEjbModule

EjbArchive getEjbModule(java.lang.String uri)
                        throws java.io.IOException

Returns the ejb archive stored in the EAR with the specified URI.

Parameters:

uri - The URI of the ejb module

Returns:

The ejb archive, or null if no WAR was found at the specified URI

Throws:

java.io.IOException - If there was an errors reading from the EAR or EJB