org.apache.cactus.integration.ant.deployment
Class JarArchive

java.lang.Object
  extended byorg.apache.cactus.integration.ant.deployment.JarArchive
Direct Known Subclasses:
EarArchive, WarArchive

public class JarArchive
extends java.lang.Object

Abstract base class for classes that provide convenient access to the contents of a J2EE deployment archive (EAR or WAR, for example).

Since:
Cactus 1.5
Version:
$Id: JarArchive.java,v 1.5 2003/06/11 16:18:33 cmlenz Exp $
Author:
Christopher Lenz

Constructor Summary
JarArchive(java.io.File theFile)
          Constructor.
JarArchive(java.io.InputStream theInputStream)
          Constructor.
 
Method Summary
 boolean containsClass(java.lang.String theClassName)
          Returns whether a class of the specified name is contained in the archive.
 java.lang.String findResource(java.lang.String theName)
          Returns the full path of a named resource in the archive.
 java.io.InputStream getResource(java.lang.String thePath)
          Returns a resource from the archive as input stream.
 java.util.List getResources(java.lang.String thePath)
          Returns the list of resources in the specified directory.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JarArchive

public JarArchive(java.io.File theFile)
           throws java.io.IOException
Constructor.

Parameters:
theFile - The archive file
Throws:
java.io.IOException - If there was a problem reading the WAR

JarArchive

public JarArchive(java.io.InputStream theInputStream)
           throws java.io.IOException
Constructor.

Parameters:
theInputStream - The input stream for the archive (it will be closed after the constructor returns)
Throws:
java.io.IOException - If there was a problem reading the WAR
Method Detail

containsClass

public boolean containsClass(java.lang.String theClassName)
                      throws java.io.IOException
Returns whether a class of the specified name is contained in the archive.

Parameters:
theClassName - The name of the class to search for
Returns:
Whether the class was found
Throws:
java.io.IOException - If an I/O error occurred reading the archive

findResource

public final java.lang.String findResource(java.lang.String theName)
                                    throws java.io.IOException
Returns the full path of a named resource in the archive.

Parameters:
theName - The name of the resource
Returns:
The full path to the resource inside the archive
Throws:
java.io.IOException - If an I/O error occurred reading the archive

getResource

public final java.io.InputStream getResource(java.lang.String thePath)
                                      throws java.io.IOException
Returns a resource from the archive as input stream.

Parameters:
thePath - The path to the resource in the archive
Returns:
An input stream containing the specified resource, or null if the resource was not found in the JAR
Throws:
java.io.IOException - If an I/O error occurs

getResources

public final java.util.List getResources(java.lang.String thePath)
                                  throws java.io.IOException
Returns the list of resources in the specified directory.

Parameters:
thePath - The directory
Returns:
The list of resources
Throws:
java.io.IOException - If an I/O error occurs


Copyright © 2000-2003 Apache Software Foundation. All Rights Reserved.