org.eclipse.osgi.baseadaptor.bundlefile
Class ZipBundleFile

java.lang.Object
  org.eclipse.osgi.baseadaptor.bundlefile.BundleFile
      org.eclipse.osgi.baseadaptor.bundlefile.ZipBundleFile

public class ZipBundleFile
extends BundleFile

A BundleFile that uses a ZipFile as it base file.

Since:

3.2

Field Summary

protected BaseData	bundledata The bundle data
protected boolean	closed The closed flag
protected ZipFile	zipFile The zip file

Fields inherited from class org.eclipse.osgi.baseadaptor.bundlefile.BundleFile

basefile, PROP_SETPERMS_CMD

Constructor Summary

ZipBundleFile(File basefile, BaseData bundledata)
Constructs a ZipBundle File

ZipBundleFile(File basefile, BaseData bundledata, MRUBundleFileList mruList)

Method Summary

protected ZipFile	basicOpen() Opens the ZipFile for this bundle file
protected boolean	checkedOpen() Checks if the zip file is open
void	close() Closes the BundleFile.
boolean	containsDir(String dir) Determines if any BundleEntries exist in the given directory path.
protected File	extractDirectory(String dirName) Extracts a directory and all sub content to disk
BundleEntry	getEntry(String path) Locates a file name in this bundle and returns a BundleEntry object
Enumeration<String>	getEntryPaths(String path) Allows to access the entries of the bundle.
protected File	getExtractFile(String entryName)
File	getFile(String entry, boolean nativeCode) Returns a File for the bundle entry specified by the path.
protected ZipEntry	getZipEntry(String path) Returns a ZipEntry for the bundle file.
protected ZipFile	getZipFile() Returns an open ZipFile for this bundle file.
void	open() Opens the BundleFiles.

Methods inherited from class org.eclipse.osgi.baseadaptor.bundlefile.BundleFile

fixTrailingSlash, getBaseFile, getResourceURL, getResourceURL, getResourceURL, setPermissions, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

bundledata

protected BaseData bundledata

The bundle data

zipFile

protected volatile ZipFile zipFile

The zip file

closed

protected volatile boolean closed

The closed flag

Constructor Detail

ZipBundleFile

public ZipBundleFile(File basefile,
                     BaseData bundledata)
              throws IOException

Constructs a ZipBundle File

Parameters:

basefile - the base file

bundledata - the bundle data

Throws:

IOException

ZipBundleFile

public ZipBundleFile(File basefile,
                     BaseData bundledata,
                     MRUBundleFileList mruList)
              throws IOException

Throws:

IOException

Method Detail

checkedOpen

protected boolean checkedOpen()

Checks if the zip file is open

Returns:

true if the zip file is open

basicOpen

protected ZipFile basicOpen()
                     throws IOException

Opens the ZipFile for this bundle file

Returns:

an open ZipFile for this bundle file

Throws:

IOException

getZipFile

protected ZipFile getZipFile()
                      throws IOException

Returns an open ZipFile for this bundle file. If an open ZipFile does not exist then a new one is created and returned.

Returns:

an open ZipFile for this bundle

Throws:

IOException

getZipEntry

protected ZipEntry getZipEntry(String path)

Returns a ZipEntry for the bundle file. Must be called while synchronizing on this object. This method does not ensure that the ZipFile is opened. Callers may need to call getZipfile() prior to calling this method.

Parameters:

path - the path to an entry

Returns:

a ZipEntry or null if the entry does not exist

extractDirectory

protected File extractDirectory(String dirName)

Extracts a directory and all sub content to disk

Parameters:

dirName - the directory name to extract

Returns:

the File used to extract the content to. A value of null is returned if the directory to extract does not exist or if content extraction is not supported.

getExtractFile

protected File getExtractFile(String entryName)

getFile

public File getFile(String entry,
                    boolean nativeCode)

Description copied from class: BundleFile

Returns a File for the bundle entry specified by the path. If required the content of the bundle entry is extracted into a file on the file system.

Specified by:

getFile in class BundleFile

Parameters:

entry - The path to the entry to locate a File for.

nativeCode - true if the path is native code.

Returns:

A File object to access the contents of the bundle entry.

containsDir

public boolean containsDir(String dir)

Description copied from class: BundleFile

Determines if any BundleEntries exist in the given directory path.

Specified by:

containsDir in class BundleFile

Parameters:

dir - The directory path to check existence of.

Returns:

true if the BundleFile contains entries under the given directory path; false otherwise.

getEntry

public BundleEntry getEntry(String path)

Description copied from class: BundleFile

Locates a file name in this bundle and returns a BundleEntry object

Specified by:

getEntry in class BundleFile

Parameters:

path - path of the entry to locate in the bundle

Returns:

BundleEntry object or null if the file name does not exist in the bundle

getEntryPaths

public Enumeration<String> getEntryPaths(String path)

Description copied from class: BundleFile

Allows to access the entries of the bundle. Since the bundle content is usually a jar, this allows to access the jar contents. GetEntryPaths allows to enumerate the content of "path". If path is a directory, it is equivalent to listing the directory contents. The returned names are either files or directories themselves. If a returned name is a directory, it finishes with a slash. If a returned name is a file, it does not finish with a slash.

Specified by:

getEntryPaths in class BundleFile

Parameters:

path - path of the entry to locate in the bundle

Returns:

an Enumeration of Strings that indicate the paths found or null if the path does not exist.

close

public void close()
           throws IOException

Description copied from class: BundleFile

Closes the BundleFile.

Specified by:

close in class BundleFile

Throws:

IOException - if any error occurs.

open

public void open()

Description copied from class: BundleFile

Opens the BundleFiles.

Specified by:

open in class BundleFile