net.sf.basedb.plugins
Class ZipFileUnpacker

java.lang.Object
  net.sf.basedb.core.plugin.AbstractPlugin
      net.sf.basedb.util.zip.AbstractFileUnpacker
          net.sf.basedb.plugins.ZipFileUnpacker

All Implemented Interfaces:

InteractivePlugin, Plugin, SignalTarget, FileUnpacker

public class ZipFileUnpacker
extends AbstractFileUnpacker

A plugin for unpacking zip and jar file on the BASE file system.

Version:

2.0

Author:

nicklas

Last modified

$Date: 2008-09-11 22:06:36 +0200 (Thu, 11 Sep 2008) $

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.basedb.core.plugin.Plugin

Plugin.MainType

Field Summary

private static About	about Plugin description
private static Set<String>	extensions
private static Set<String>	mimeTypes

Fields inherited from class net.sf.basedb.util.zip.AbstractFileUnpacker

OVERWRITE, UNPACK_DIRECTORY, ZIP_FILE

Fields inherited from class net.sf.basedb.core.plugin.AbstractPlugin

annotationSection, configuration, COPY_ANNOTATIONS, job, OVERWRITE_ANNOTATIONS, sc

Constructor Summary

ZipFileUnpacker()

Method Summary

About	getAbout() Get information about the plugin, such as name, version, authors, etc.
Set<String>	getExtensions() Return a set containing the strings [ zip, jar ].
String	getFormatName() Get the name of the compressed file format this unpacker supports.
Set<String>	getMimeTypes() Return a set containing the strings [ application/zip, application/java-archive ].
int	unpack(DbControl dc, Directory dir, InputStream in, boolean overwrite, AbsoluteProgressReporter progress) Use the ZipUnpacker to unpack the file.

Methods inherited from class net.sf.basedb.util.zip.AbstractFileUnpacker

configure, getCurrentDirectory, getCurrentFile, getDirectoryParameter, getGuiContexts, getMainType, getOverwrite, getOverwriteParameter, getPermissions, getRequestInformation, getSignalHandler, getUnpackDirectory, getZipFile, getZipFileParameter, isInContext, requiresConfiguration, run, supportsConfigurations

Methods inherited from class net.sf.basedb.core.plugin.AbstractPlugin

checkInterrupted, cloneParameterWithDefaultValue, closeLogFile, createLogFile, done, getCopyAnnotationsParmeter, getCurrentConfiguration, getCurrentJob, getJobOrConfigurationValue, getOverwriteAnnotationsParameters, init, log, log, storeValue, storeValue, storeValues, validateRequestParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.basedb.core.plugin.Plugin

done, init

Field Detail

about

private static final About about

Plugin description

extensions

private static final Set<String> extensions

mimeTypes

private static final Set<String> mimeTypes

Constructor Detail

ZipFileUnpacker

public ZipFileUnpacker()

Method Detail

getAbout

public About getAbout()

Description copied from interface: Plugin

Get information about the plugin, such as name, version, authors, etc.

Returns:

An About object

getFormatName

public String getFormatName()

Description copied from interface: FileUnpacker

Get the name of the compressed file format this unpacker supports. For example: ZIP files

getExtensions

public Set<String> getExtensions()

Return a set containing the strings [ zip, jar ].

Returns:

A set containing file extensions (do not inlcude the dot)

getMimeTypes

public Set<String> getMimeTypes()

Return a set containing the strings [ application/zip, application/java-archive ].

Returns:

A set containing MIME types

unpack

public int unpack(DbControl dc,
                  Directory dir,
                  InputStream in,
                  boolean overwrite,
                  AbsoluteProgressReporter progress)
           throws IOException

Use the ZipUnpacker to unpack the file.

Parameters:

dc - The DbControl to use for database access

dir - The directory to unpack the files to

in - The input stream containing the packed data

overwrite - If existing files should be overwritten or ignored

progress - A optional progress reporter which expects the number of compressed bytes that has been uncompressed

Returns:

The number of unpacked files

Throws:

IOException - If there is an error reading the input stream