|
IP*Works! ZIP V8 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--ipworkszip.Zip
The Zip bean implements a PKZip-compatible Zip compressor and decompressor.
The bean uses the Deflate algorithm specified in RFC 1951 for compression, and produces and reads output compatible with PKZip, WinZip, etc.
To create a new archive, first set the ArchiveFile
property to the
name of the archive to be created. Then, specify the files to be compressed
either by invoking IncludeFiles
, or by adding a new object to the Files
collection and setting the values of the DecompressedName and CompressedName .
fields. Finally, call the Compress
method to create the archive.
To decompress an existing archive, set ArchiveFile
to the name of the
archive to be decompressed. The ExtractToPath
property may be set, and
then calling the ExtractAll
method will decompress all files in the archive
to this path.
For finer control, the Scan
method should be used to read the file
information stored in the archive. This will fill out the information in the Files
collection. The values of DecompressedName may then
be changed if desired. Finally, ExtractAll
may be used to decompress the
entire archive, or Extract
may be used for finer control.
Data may be streamed out by setting WriteToProgressEvent
to true.
Then, the Progress
event may be trapped to retrieve the data.
Example (Creating an Archive)
ZipControl.ArchiveFile = "c:\\test.zip"
ZipControl.RecurseSubdirectories = true
ZipControl.IncludeFiles("c:\\foo\\*")
ZipControl.Compress()
Example (Extracting from an Archive)
ZipControl.ArchiveFile = "c:\\temp.zip"
ZipControl.ExtractToPath = "c:\\unzipped\\"
ZipControl.ExtractAll()
Field Summary | |
static int |
eaAESMaximum
|
static int |
eaAESStrong
|
static int |
eaAESWeak
|
static int |
eaDefault
|
Constructor Summary | |
Zip()
|
Method Summary | |
void |
abort()
Aborts the current operation. |
void |
addZipEventListener(ipworkszip.ZipEventListener l)
|
void |
appendFiles()
Adds specified files to an existing archive. |
void |
compress()
Creates the compressed archive. |
java.lang.String |
config(java.lang.String configurationString)
Sets or retrieves a configuration setting. |
void |
delete(java.lang.String filenames)
Deletes one or more files from an existing archive. |
void |
extract(java.lang.String filenames)
Extracts a single file, directory, or group of files, from the archive. |
void |
extractAll()
Extracts all files from the compressed archive. |
java.lang.String |
getArchiveFile()
The name of the zip, gzip, tar, or jar archive. |
int |
getCompressionLevel()
The compression level to use. |
int |
getEncryptionAlgorithm()
The algorithm used to encrypt files written to the archive. |
java.lang.String |
getExcludedFiles()
A list of files to exclude. |
java.lang.String |
getExtractToPath()
A base path to decompress to. |
ipworkszip.ZIPFileList |
getFiles()
Collection of Zip archive files. |
java.lang.String |
getPassword()
A password for the zip archive. |
java.lang.String |
getZipComment()
The comment for the entire zip file. |
void |
includeFiles(java.lang.String filenames)
Specifies that the indicated files should be added to the archive. |
boolean |
isOverwriteFiles()
Whether or not to overwrite files. |
boolean |
isRecurseSubdirectories()
Whether or not to recurse into subdirectories. |
void |
removeZipEventListener(ipworkszip.ZipEventListener l)
|
void |
reset()
Resets the bean. |
void |
scan(javax.servlet.http.HttpServletRequest request)
Scans the compressed archive. |
void |
setArchiveFile(java.lang.String archiveFile)
The name of the zip, gzip, tar, or jar archive. |
void |
setArchiveInputStream(java.io.InputStream archiveStream)
The stream to read the zip, tar, jar, or gzip archive from. |
void |
setArchiveOutputStream(java.io.OutputStream archiveStream)
The stream to write the zip, tar, jar, or gzip archive to. |
void |
setCompressionLevel(int compressionLevel)
The compression level to use. |
void |
setEncryptionAlgorithm(int encryptionAlgorithm)
The algorithm used to encrypt files written to the archive. |
void |
setExcludedFiles(java.lang.String excludedFiles)
A list of files to exclude. |
void |
setExtractToPath(java.lang.String extractToPath)
A base path to decompress to. |
void |
setOverwriteFiles(boolean overwriteFiles)
Whether or not to overwrite files. |
void |
setPassword(java.lang.String password)
A password for the zip archive. |
void |
setRecurseSubdirectories(boolean recurseSubdirectories)
Whether or not to recurse into subdirectories. |
void |
setZipComment(java.lang.String zipComment)
The comment for the entire zip file. |
void |
setZipData(byte[] zipData)
(Decompression only) The zip file contents as a byte array. |
void |
update(java.lang.String filenames)
Will update certain files in an archive. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int eaDefault
public static final int eaAESWeak
public static final int eaAESStrong
public static final int eaAESMaximum
Constructor Detail |
public Zip()
Method Detail |
public java.lang.String getArchiveFile()
This property specifies the name of the archive to be read or written. This property is required when extracting files.
When Scan
, Extract
, or ExtractAll
is invoked, the file specified by ArchiveFile will be opened for read. If the file does not exist, a trappable
error will be generated.
When Compress
is called, the file named by ArchiveFile will be written; if
a file of this name already exists the Overwrite
event will be fired. If ArchiveFile is set to the empty string (""), the archive will not be
written to disk, and will be provided only through the Progress
event.
The filename may be specified with or without a path. Paths may be relative or absolute, and should be specified in the format native to the host operating system. The filename should be specified with the appropriate extension (such as "zip"); an extension will not automatically be appended by the bean.
If the file cannot be read, or written, as appropriate, a trappable error will be generated.
Example (Creating an Archive)
ZipControl.ArchiveFile = "c:\\test.zip"
ZipControl.RecurseSubdirectories = true
ZipControl.IncludeFiles("c:\\foo\\*")
ZipControl.Compress()
Note: an archive already open for read may be closed by setting ArchiveFile to the empty string ("").
public void setArchiveFile(java.lang.String archiveFile) throws IPWorksZipException
This property specifies the name of the archive to be read or written. This property is required when extracting files.
When Scan
, Extract
, or ExtractAll
is invoked, the file specified by ArchiveFile will be opened for read. If the file does not exist, a trappable
error will be generated.
When Compress
is called, the file named by ArchiveFile will be written; if
a file of this name already exists the Overwrite
event will be fired. If ArchiveFile is set to the empty string (""), the archive will not be
written to disk, and will be provided only through the Progress
event.
The filename may be specified with or without a path. Paths may be relative or absolute, and should be specified in the format native to the host operating system. The filename should be specified with the appropriate extension (such as "zip"); an extension will not automatically be appended by the bean.
If the file cannot be read, or written, as appropriate, a trappable error will be generated.
Example (Creating an Archive)
ZipControl.ArchiveFile = "c:\\test.zip"
ZipControl.RecurseSubdirectories = true
ZipControl.IncludeFiles("c:\\foo\\*")
ZipControl.Compress()
Note: an archive already open for read may be closed by setting ArchiveFile to the empty string ("").
IPWorksZipException
public int getCompressionLevel()
This property specifies the level of compression to be used, between 0 and 6. Higher values will cause the bean to compress better; lower values will cause the bean to compress faster. A value of 0 will store the file without compression.
Set the level of CompressionLevel in the BeginFile
event to apply
different levels of compression to different files.
public void setCompressionLevel(int compressionLevel) throws IPWorksZipException
This property specifies the level of compression to be used, between 0 and 6. Higher values will cause the bean to compress better; lower values will cause the bean to compress faster. A value of 0 will store the file without compression.
Set the level of CompressionLevel in the BeginFile
event to apply
different levels of compression to different files.
IPWorksZipException
public int getEncryptionAlgorithm()
The algorithm used to encrypt files written to the archive.
Note that files will only be encrypted if Password
is set. By default the
bean will use standard zip encryption if Password
is set, and will not
encrypt data otherwise.
The bean supports the use of AES , the Advanced Encryption Standard, as well as standard Zip encryption. The default encryption algorithm is the algorithm introduced in version 2.0 of the Zip specification, and is compatible with virtually all other zip utilities. However, this algorithm is considered weak and should not be used to protect sensitive data.
AES is a U.S. government standard cleared to protect even the most sensitive data. The file format used to create AES-encrypted files is designed to be compatible with WinZip 9.0 . AES-encrypted files created by the bean may or may not be compatible with other Zip utilities.
The bean supports the use of AES with key lengths of 128, 192, or 256 bits. Note that even with the weakest (128-bit) keys AES is much more secure than standard Zip encryption.
If you use strong or maximum AES encryption the bean will generate a unique salt value and cryptographic key for each file encrypted. If you use weak encryption the bean will use the same salt for each file in the archive. If you are encrypting a large number of files this will have a substantial effect on performance. Set the AESGenerateUniqueKeys configuration setting to configure the salt generation independent of the key length.
If using AES encryption it is important to choose a good Password
. For 128-bit keys
it is recommended that your password be 32 characters long, and for 256-bit keys,
64 characters.
Important: Note that AES encryption only encrypts the contents of encrypted files within the Zip archive; it does not prevent an attacker from reading the names of files in the archive, or from adding or deleting files to or from the archive. To prevent this consider first storing your files in an unencrypted zip file, and then storing this zip file in another, AES-encrypted zip file.
Property values:
public void setEncryptionAlgorithm(int encryptionAlgorithm) throws IPWorksZipException
The algorithm used to encrypt files written to the archive.
Note that files will only be encrypted if Password
is set. By default the
bean will use standard zip encryption if Password
is set, and will not
encrypt data otherwise.
The bean supports the use of AES , the Advanced Encryption Standard, as well as standard Zip encryption. The default encryption algorithm is the algorithm introduced in version 2.0 of the Zip specification, and is compatible with virtually all other zip utilities. However, this algorithm is considered weak and should not be used to protect sensitive data.
AES is a U.S. government standard cleared to protect even the most sensitive data. The file format used to create AES-encrypted files is designed to be compatible with WinZip 9.0 . AES-encrypted files created by the bean may or may not be compatible with other Zip utilities.
The bean supports the use of AES with key lengths of 128, 192, or 256 bits. Note that even with the weakest (128-bit) keys AES is much more secure than standard Zip encryption.
If you use strong or maximum AES encryption the bean will generate a unique salt value and cryptographic key for each file encrypted. If you use weak encryption the bean will use the same salt for each file in the archive. If you are encrypting a large number of files this will have a substantial effect on performance. Set the AESGenerateUniqueKeys configuration setting to configure the salt generation independent of the key length.
If using AES encryption it is important to choose a good Password
. For 128-bit keys
it is recommended that your password be 32 characters long, and for 256-bit keys,
64 characters.
Important: Note that AES encryption only encrypts the contents of encrypted files within the Zip archive; it does not prevent an attacker from reading the names of files in the archive, or from adding or deleting files to or from the archive. To prevent this consider first storing your files in an unencrypted zip file, and then storing this zip file in another, AES-encrypted zip file.
Property values:
IPWorksZipException
public java.lang.String getExcludedFiles()
This property specifies files that should be excluded when Compress
or Extract
is invoked. When Compress
is invoked, each value of DecompressedName in Files
will
be compared to ExcludedFiles , and each file will be excluded if the name matches.
When Extract
is called, each value of CompressedName in Files
matching the parameter
to Extract
will be compared to ExcludedFiles , and will be excluded if
appropriate.
This property may be set to one or more filenames or directory names. Files may be
specified with or without a path, and with or without wildcards. If a path is
specified, files in the indicated directory will be excluded; subdirectories will
be recursed into if RecurseSubdirectories
is true. If no path is specified but wildcards are, matching files in all directories
will be excluded. If a single filename without a path is specified, it must correspond
exactly to the appropriate value of CompressedName or DecompressedName .
Directories should end with a slash ("/" or "\\", as appropriate.) If a directory is specified, all files and subdirectories in the specified directory will be excluded.
A pipe character ("|") should be used to separate multiple file or directory names.
The following examples illustrate the use of the property:
Example
ZipControl.ArchiveFile = "c:\\test.zip"
ZipControl.IncludeFiles("c:\\test\\*")
ZipControl.ExcludedFiles = "*.tmp"
ZipControl.Compress()
Example
ZipControl.ArchiveFile = "c:\\test.tar"
ZipControl.Scan()
ZipControl.ExcludedFiles = "*.bak | backup/"
ZipControl.ExtractToPath = "c:\\temp"
ZipControl.Extract("*")
As per the examples, the property should be specified differently for compression and
decompression. When invoking Compress
, the format of ExcludedFiles should
correspond to that of the local file system. When invoking Extract
the format should
correspond to standard (UNIX) format, and should not contain drive letters or backslashes.
You may exclude files based on their attributes as well: See the ExcludedAttributes configuration setting for more information.
If the property is set to the empty string, no files will be excluded. This property is never reset automatically, so be sure to reset it manually if using a single instance of the bean for both compression and extraction. Failure to do so may result in I/O errors or unexpected results.
public void setExcludedFiles(java.lang.String excludedFiles) throws IPWorksZipException
This property specifies files that should be excluded when Compress
or Extract
is invoked. When Compress
is invoked, each value of DecompressedName in Files
will
be compared to ExcludedFiles , and each file will be excluded if the name matches.
When Extract
is called, each value of CompressedName in Files
matching the parameter
to Extract
will be compared to ExcludedFiles , and will be excluded if
appropriate.
This property may be set to one or more filenames or directory names. Files may be
specified with or without a path, and with or without wildcards. If a path is
specified, files in the indicated directory will be excluded; subdirectories will
be recursed into if RecurseSubdirectories
is true. If no path is specified but wildcards are, matching files in all directories
will be excluded. If a single filename without a path is specified, it must correspond
exactly to the appropriate value of CompressedName or DecompressedName .
Directories should end with a slash ("/" or "\\", as appropriate.) If a directory is specified, all files and subdirectories in the specified directory will be excluded.
A pipe character ("|") should be used to separate multiple file or directory names.
The following examples illustrate the use of the property:
Example
ZipControl.ArchiveFile = "c:\\test.zip"
ZipControl.IncludeFiles("c:\\test\\*")
ZipControl.ExcludedFiles = "*.tmp"
ZipControl.Compress()
Example
ZipControl.ArchiveFile = "c:\\test.tar"
ZipControl.Scan()
ZipControl.ExcludedFiles = "*.bak | backup/"
ZipControl.ExtractToPath = "c:\\temp"
ZipControl.Extract("*")
As per the examples, the property should be specified differently for compression and
decompression. When invoking Compress
, the format of ExcludedFiles should
correspond to that of the local file system. When invoking Extract
the format should
correspond to standard (UNIX) format, and should not contain drive letters or backslashes.
You may exclude files based on their attributes as well: See the ExcludedAttributes configuration setting for more information.
If the property is set to the empty string, no files will be excluded. This property is never reset automatically, so be sure to reset it manually if using a single instance of the bean for both compression and extraction. Failure to do so may result in I/O errors or unexpected results.
IPWorksZipException
public java.lang.String getExtractToPath()
Setting the ExtractToPath property affects the operation of the Extract
and ExtractAll
methods. Setting this property to a nonempty string will cause all decompressed
files to be written to the specified path. If pathnames are given in the values of DecompressedName they will be regarded as relative to ExtractToPath .
If the specified directory does not exist, it will be created when extraction is done.
ExtractToPath should always be specified in the format native to the host operating system, and with a trailing slash or backslash. If the path is specified otherwise, it will be immediately converted and stored in the converted format. For example, "/temp" would be immediately converted to "\\temp\\" on a Windows system.
Example (Extracting from an Archive)
ZipControl.ArchiveFile = "c:\\temp.zip"
ZipControl.ExtractToPath = "c:\\unzipped\\"
ZipControl.ExtractAll()
Example - Adding Files
Dim i as Integer
ZipControl.ArchiveFile = "c:\\test.zip"
ZipControl.Scan()
For i = 0 to ZipControl.Files.Count - 1
ZipControl.Files(i).DecompressedName(i) = "c:\\temp\\" + ZipControl.Files(i).DecompressedName
Next i
ZipControl.ExtractToPath = ""
ZipControl.ExtractAll()
ZipControl.IncludeFiles("c:\\extra\\*")
ZipControl.Compress()
public void setExtractToPath(java.lang.String extractToPath) throws IPWorksZipException
Setting the ExtractToPath property affects the operation of the Extract
and ExtractAll
methods. Setting this property to a nonempty string will cause all decompressed
files to be written to the specified path. If pathnames are given in the values of DecompressedName they will be regarded as relative to ExtractToPath .
If the specified directory does not exist, it will be created when extraction is done.
ExtractToPath should always be specified in the format native to the host operating system, and with a trailing slash or backslash. If the path is specified otherwise, it will be immediately converted and stored in the converted format. For example, "/temp" would be immediately converted to "\\temp\\" on a Windows system.
Example (Extracting from an Archive)
ZipControl.ArchiveFile = "c:\\temp.zip"
ZipControl.ExtractToPath = "c:\\unzipped\\"
ZipControl.ExtractAll()
Example - Adding Files
Dim i as Integer
ZipControl.ArchiveFile = "c:\\test.zip"
ZipControl.Scan()
For i = 0 to ZipControl.Files.Count - 1
ZipControl.Files(i).DecompressedName(i) = "c:\\temp\\" + ZipControl.Files(i).DecompressedName
Next i
ZipControl.ExtractToPath = ""
ZipControl.ExtractAll()
ZipControl.IncludeFiles("c:\\extra\\*")
ZipControl.Compress()
IPWorksZipException
public ipworkszip.ZIPFileList getFiles()
When a compressed archive is scanned or decompressed, the values of this collection are populated accordingly.
When creating a compressed archive, this property may be used to set the files to be stored. For each entry added to the collection, the DecompressedName field should be set to the name of the file to be decompressed, and the CompressedName field should be set to the filename to store in the archive.
Archives may also be created using the IncludeFiles
method. Invoking the IncludeFiles
method causes the values of this collection to be filled out. These
values may then be changed directly if desired.
public boolean isOverwriteFiles()
If this property is set to true, existing files will be overwritten when decompressing. When Extract
or ExtractAll
is called, each file specified in Files
will be checked for
existence. If a file exists, the Overwrite
event will be fired, and the files will be
overwritten if OverwriteFiles is set to true.
More precise control of which files should be overwritten may be gained by listening to the Overwrite
event and altering its parameters when the event is fired.
This property only affects the operation of Extract
and ExtractAll
. When
compressing files, ArchiveFile
will always be overwritten unless the user specifies
otherwise in the Overwrite
event.
public void setOverwriteFiles(boolean overwriteFiles) throws IPWorksZipException
If this property is set to true, existing files will be overwritten when decompressing. When Extract
or ExtractAll
is called, each file specified in Files
will be checked for
existence. If a file exists, the Overwrite
event will be fired, and the files will be
overwritten if OverwriteFiles is set to true.
More precise control of which files should be overwritten may be gained by listening to the Overwrite
event and altering its parameters when the event is fired.
This property only affects the operation of Extract
and ExtractAll
. When
compressing files, ArchiveFile
will always be overwritten unless the user specifies
otherwise in the Overwrite
event.
IPWorksZipException
public java.lang.String getPassword()
This property specifies the case-sensitive password used to encrypt or decrypt the archive. If set to an empty string, no password is used.
In this release, streaming out of encrypted archives is not supported.
When compressing, WriteToProgressEvent
must be set to
false if Password is set.
Example (Compressing an Archive)
ZipControl.ArchiveFile = "c:\\test.zip"
ZipControl.RecurseSubdirectories = true
ZipControl.IncludeFiles("c:\\foo\\*")
ZipControl.Password = "nsoftware"
ZipControl.Compress()
public void setPassword(java.lang.String password) throws IPWorksZipException
This property specifies the case-sensitive password used to encrypt or decrypt the archive. If set to an empty string, no password is used.
In this release, streaming out of encrypted archives is not supported.
When compressing, WriteToProgressEvent
must be set to
false if Password is set.
Example (Compressing an Archive)
ZipControl.ArchiveFile = "c:\\test.zip"
ZipControl.RecurseSubdirectories = true
ZipControl.IncludeFiles("c:\\foo\\*")
ZipControl.Password = "nsoftware"
ZipControl.Compress()
IPWorksZipException
public boolean isRecurseSubdirectories()
This property affects the behavior of IncludeFiles
and Extract
and the meaning of ExcludedFiles
. If this property is set to true, IncludeFiles
will recurse into all subdirectories whenever
it performs a search on the file system.
Be sure RecurseSubdirectories is set to the appropriate value before
invoking IncludeFiles
, Extract
, or Compress
; changing the value of this
property after method calls will not retroactively alter their effects.
Example (Creating an Archive)
ZipControl.ArchiveFile = "c:\\test.zip"
ZipControl.RecurseSubdirectories = true
ZipControl.IncludeFiles("c:\\foo\\*")
ZipControl.Compress()
public void setRecurseSubdirectories(boolean recurseSubdirectories) throws IPWorksZipException
This property affects the behavior of IncludeFiles
and Extract
and the meaning of ExcludedFiles
. If this property is set to true, IncludeFiles
will recurse into all subdirectories whenever
it performs a search on the file system.
Be sure RecurseSubdirectories is set to the appropriate value before
invoking IncludeFiles
, Extract
, or Compress
; changing the value of this
property after method calls will not retroactively alter their effects.
Example (Creating an Archive)
ZipControl.ArchiveFile = "c:\\test.zip"
ZipControl.RecurseSubdirectories = true
ZipControl.IncludeFiles("c:\\foo\\*")
ZipControl.Compress()
IPWorksZipException
public java.lang.String getZipComment()
Specifies a global comment for the zip file. Set this property before invoking Compress
to include
a comment in the zip file. Read it after invoking Scan
to read the zip comment.
public void setZipComment(java.lang.String zipComment) throws IPWorksZipException
Specifies a global comment for the zip file. Set this property before invoking Compress
to include
a comment in the zip file. Read it after invoking Scan
to read the zip comment.
IPWorksZipException
public void setZipData(byte[] zipData) throws IPWorksZipException
Normally you should set ArchiveFile
before invoking Scan
or Extract
.
If you prefer to read the zip file from memory you may set ZipData
instead. ZipData
should be set to the entire contents of the zip file; this will
allow you to read from the zip without writing any temporary files to
disk.
If you would like to extract data from the archive without ever writing to disk you
should also set WriteToProgressEvent
to true, and after invoking Scan
,
you should set the value of DecompressedName for each file in the Files
collection
to an empty string. Then, when you invoke Extract
(or ExtractAll
) the data will
be provided in the Progress
event.
This property is write-only. Note that modifying a zip file stored in ZipData
is
not supported, so Append
, Delete
, etc., will throw exceptions.
IPWorksZipException
public void abort() throws IPWorksZipException
Abort
may be used to immediately interrupt compression or decompression. Any files partially
written by the bean will be deleted.
In case Append
or Delete
is aborted the archive will be left in its original state.
IPWorksZipException
public void appendFiles() throws IPWorksZipException
All files contained in the Files
collection will be appended to the archive specified
by ArchiveFile
.
When AppendFiles is called, only those files which are to be added to the archive
must exist inside the collection. Note that if you call Scan
or Extract
, you must
empty the collection before adding files to the collection to be appended.
After the file is added, the collection will be updated appropriately.
This method may only be used to add files to an existing archive. To add files to a new
archive, the IncludeFiles
and Compress
methods should be used.
IPWorksZipException
public void compress() throws IPWorksZipException
Invoking Compress creates the archive specified by ArchiveFile
. When the
method is called, all files specified by the DecompressedName field of the Files
collection will be compressed and written to ArchiveFile
.
The compressed data may be streamed out by setting WriteToProgressEvent
to true. If
streaming is enabled the compressed data will also be provided via the Progress
event.
If ArchiveFile
is set to an empty string the archive will be written only to this
event.
The files to compress are specified in the Files
collection.
The file names are specified by CompressedName and DecompressedName .
These should be specified before invoking Compress , either manually or by
invoking IncludeFiles
.
The BeginFile
and EndFile
events will be fired as
files are processed, and the Progress
event will be fired as data is compressed.
Existing files will be overwritten by the bean if OverwriteFiles
is set to true.
Finer control over which files are overwritten may be gained by trapping the Overwrite
event.
Example (Creating an Archive)
ZipControl.ArchiveFile = "c:\\test.zip"
ZipControl.RecurseSubdirectories = true
ZipControl.IncludeFiles("c:\\foo\\*")
ZipControl.Compress()
IPWorksZipException
public java.lang.String config(java.lang.String configurationString) throws IPWorksZipException
Config
is a generic method available in every bean.
It is used to set and retrieve configuration settings
for the
bean.
Configuration settings are similar in functionality to properties,
but they are rarely used. In order to avoid "polluting" the property
namespace of the bean, access to these internal properties is provided through the Config
method.
To set a configuration setting named PROPERTY , you must call Config("PROPERTY=VALUE") , where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY") . The value will be returned as a string.
The bean accepts one or more of the following configuration settings .
Configuration settings are similar in functionality to properties,
but they are rarely used. In order to avoid "polluting" the property
namespace of the bean, access to these internal properties is provided through the Config
method.
Default - Jar: "UTF-8"
Example - This would set encoding to Japanese Shift-JIS.
Zip1.Config("Encoding=SJIS");
Default: "" (no excluded attributes)
Error
event, instead, and will fail with an exception if the
error is not trapped and explicitly ignored in the event.
Password
specified. For added security, a random salt value is generated, and a unique key will be generated for every unique
combination of Password
and salt.If true, a unique salt value and key will be generated for each file encrypted.
If false, a single salt value and key will be generated for all encrypted files
in the archive.
If you are encrypting a lot of files, the value of this setting can have a
substantial effect on both security and performance. By default, the bean
will set this to false if you set EncryptionAlgorithm
to eaAESWeak ,
and true if you set EncryptionAlgorithm
to eaAESStrong or eaAESMaximum . Set AESGenerateUniqueKeys after setting EncryptionAlgorithm
to override the default.
WriteToProgressEvent
set to true or with SetArchiveOutputStream
set to a valid stream and a Password
has been set.Use extreme caution when setting this option, as streamed and encrypted
zip files may be unreadable by other zip software.
BeginFile
event and set this
property value as appropriate for each file.
Extract
, ExtractAll
, and Compress
will be written to the Progress
event as well as to disk. Applications may stream out the compressed or decompressed
data by trapping this event and copying the data.If WriteToProgressEvent is set to false, the data will not be streamed out, and
the Data parameter of the Progress
event will contain null.
Note that if streaming is enabled the zip files written will be slightly larger. Moreover, zip files produced with WriteToProgressEvent may be incompatible with certain older zip utilities.
By default, Password
encryption is not allowed for archives created with WriteToProgressEvent set to true. You may set the EnableStreamingEncryption setting to allow this, but streamed and encrypted zip files may be
incompatible with other utilities.
By default, this config is set to false.
IPWorksZipException
public void delete(java.lang.String filenames) throws IPWorksZipException
Delete deletes one or more files from an existing archive, without reprocessing the compressed data. The archive will be opened immediately, and the file(s) will immediately be removed permanently from the archive.
The list of filenames should be specified exactly as when calling Extract
:
Filenames may be set to one or more filenames or directory names. Files may be
specified with or without a path, and with or without wildcards. If a path is
specified, files in the indicated directory will be affected; subdirectories will
be recursed into if RecurseSubdirectories
is true. If no path is specified but wildcards are, matching files in all directories
will be affected. If a single filename without a path is specified, it must correspond
exactly to the appropriate value of CompressedName .
Directories should end with a slash ("/"). If a directory is specified, all files and subdirectories in the specified directory will be affected.
A pipe character ("|") should be used to separate multiple file or directory names. Alternatively, the method may be invoked repeatedly.
The ExcludedFiles
property may be used to further limit the files to be deleted.
When Delete is used to delete a directory or match wildcards, each file to be
deleted is first compared against ExcludedFiles
, and any files marked as excluded
will not be deleted. When Delete is used to delete a single file, the value of ExcludedFiles
will be ignored.
When the method is invoked, the Scan
method will first be invoked, if it has
not been invoked already. Note that if IncludeFiles
has been invoked, or if the values
of CompressedName and DecompressedName for each file in the Files
collection
have been set, this information will be reset by the call to Scan
.
When deleting multiple files, the bean will operate most efficiently if all filenames are passed to Delete in a single invocation of the method. Invoking Delete repeatedly on large archives is not recommended.
Invoking Delete will only remove files from ArchiveFile
; it will not
delete the files from the disk.
Example
ZipControl.ArchiveFile = "c:\\\\test.zip"
ZipControl.Delete("default_readme.txt");
ZipControl.Append("\\\\mydir\\\\my_readme.txt", "my_readme.txt")
IPWorksZipException
public void extract(java.lang.String filenames) throws IPWorksZipException
Extract extracts one or more files from the archive. The file(s) will be extracted
to the directory specified by ExtractToPath
, and given the names found in the
archive or specified by the DecompressedName of the file in the Files
collection.
Filenames may be set to one or more filenames or directory names. Files may be
specified with or without a path, and with or without wildcards. If a path is
specified, files in the indicated directory will be affected; subdirectories will
be recursed into if RecurseSubdirectories
is true. If no path is specified but wildcards are, matching files in all directories
will be affected. If a single filename without a path is specified, it must correspond
exactly to the appropriate value of CompressedName .
Directories should end with a slash ("/"). If a directory is specified, all files and subdirectories in the specified directory will be affected.
A pipe character ("|") should be used to separate multiple file or directory names. Alternatively, the method may be invoked repeatedly.
The ExcludedFiles
property may be used to further limit the files to be extracted.
When Extract is used to extract a directory or match wildcards, each file to be
extracted is first compared against ExcludedFiles
, and any files marked as excluded
will not be extracted. When Extract is used to extract a single file, the value of ExcludedFiles
will be ignored.
To extract all files in the archive, the ExtractAll
method may be used.
The BeginFile
and EndFile
events will be fired before and after
each file is extracted, and the Progress
event will be fired as the
data is extracted. If WriteToProgressEvent
is set to true,
the decompressed data will be streamed out through the Progress
event.
Example
ZipControl.ArchiveFile = "c:\\test.tar"
ZipControl.ExcludedFiles = "*.bak | backup/"
ZipControl.ExtractToPath = "c:\\temp"
ZipControl.Extract("*")
Example ZipControl.ArchiveFile = "c:\\test.zip"
ZipControl.ExcludedFiles = ""
ZipControl.ExtractToPath = "c:\\temp"
ZipControl.Extract("code/")
Example ZipControl.ArchiveFile = "c:\\test.jar"
ZipControl.ExcludedFiles = "*.txt"
ZipControl.ExtractToPath = "c:\\"
ZipControl.Extract("* | docs/readme.txt")
IPWorksZipException
public void extractAll() throws IPWorksZipException
ExtractAll extracts all files from the archive. The file(s) will be extracted
to the directory specified by ExtractToPath
, and given the names found in the
archive or specified by the DecompressedName field of the file in the Files
collection.
If Scan
has not been invoked when ExtractAll is called, Scan
will
automatically be invoked, and the Files
collection will be set to the values
found in the archive. To manually set the decompressed filenames, Scan
should
be invoked before setting the DecompressedName field.
Invoking this method is equivalent to setting ExcludedFiles
to the empty string, and
then invoking Extract
with "*" as the argument.
The BeginFile
and EndFile
events will be fired before and after
each file is extracted, and the Progress
event will be fired as the
data is extracted. If WriteToProgressEvent
is set to true,
the decompressed data will be streamed out through the Progress
event.
Example (Extracting from an Archive)
ZipControl.ArchiveFile = "c:\\temp.zip"
ZipControl.ExtractToPath = "c:\\unzipped\\"
ZipControl.ExtractAll()
IPWorksZipException
public void includeFiles(java.lang.String filenames) throws IPWorksZipException
IncludeFiles may be used before Compress
, to specify the files to be
compressed. Invoking this method populates the Files
collection accordingly.
Invoking the method does not create or alter the archive.
The argument should be a pipe ("|") -delimited sequence of one or more filenames. The
filenames should be specified with paths if necessary, so that the files may be found on
the local file system. The filenames will be stored as is in the DecompressedName field, and without a pathname in the CompressedName field of the Files
collection.
Filenames may include the wildcards '?', '*', and '< .. >'. '?' will match any single character, and '*' will match an arbitrary sequence of characters. '< .. >' may be used to match any of the characters inside, or a range, such as '<a-z>'.
If wildcards are
specified, the file system will be scanned and all files matching the specified mask will
be added. Moreover, subdirectories will be recursed into if RecurseSubdirectories
is
set to true. When recursing into subdirectories, relative path information will be stored
in CompressedName field of the Files
collection.
The ExcludedFiles
may be used to limit the files to be compressed. This property is
checked when Compress
is invoked, rather than when IncludeFiles is invoked,
so this property may be set before or after invoking IncludeFiles .
Note that invoking IncludeFiles will not reset the bean, or remove
old values of CompressedName and DecompressedName . This may be done
by first clearing the Files
collection.
Example
ZipControl.IncludeFiles("c:\\test\\* | c:\\readme")
ZipControl.ExcludedFiles = "*.tmp"
ZipControl.Compress()
IPWorksZipException
public void reset() throws IPWorksZipException
Reset resets the state of the bean. The Files
collection will be cleared,
all properties will be set to their default values, and any files open will be closed.
IPWorksZipException
public void scan(javax.servlet.http.HttpServletRequest request) throws IPWorksZipException
This method will scan the archive specified by ArchiveFile
. The number of files and
their names and sizes will be determined and written to the Files
collection.
After scanning the archive, the values of DecompressedName may be changed if desired,
and any number of files may be decompressed. The Extract
method allows you to decompress
files of your choice, and the ExtractAll
method will decompress the entire
archive.
Changing the values of the CompressedName field or the number of files in the Files
collection will invalidate the scan. If either of these is changed and Extract
or ExtractAll
is then called; Scan will automatically be called again, and these
values will be reset to their original values.
Calling this method will frequently generate a trappable error if the archive is corrupt. This is not guaranteed, however, as Scan only examines the headers.
Example
Dim i as Integer
ZipControl.ArchiveFile = "c:\\temp.zip"
ZipControl.Scan()
For i = 0 to ZipControl.Files(i).Count -1
Debug.Write("File name : ")
Debug.Write(ZipControl.Files(i).DecompressedName)
Debug.Write(" Size: ")
Debug.WriteLine(ZipControl.Files(i).DecompressedSize)
Next i
IPWorksZipException
public void setArchiveInputStream(java.io.InputStream archiveStream) throws IPWorksZipException
This method should be set when the archive is to be read from a stream when Extract
is called.
By default, and when this is set to null, the bean will read from the file specified
by ArchiveFile
. However, when this is a valid stream, the data will be read from the
stream.
IPWorksZipException
public void setArchiveOutputStream(java.io.OutputStream archiveStream) throws IPWorksZipException
This method should be set when the archive is to be written to a stream when Compress
is called.
By default, and when this is set to null, the bean will write to the file specified
by ArchiveFile
. However, when this is a valid stream, the data will be written to the
stream.
IPWorksZipException
public void update(java.lang.String filenames) throws IPWorksZipException
When this method is called, the bean will attempt to update files in the specified archive with the current files listed in the files collection. You may use the Filenames parameter to tell the bean which files in the collection/archive must be updated.
Filenames may be set to one or more filenames or directory names. Files may be
specified with or without a path, and with or without wildcards. If a path is
specified, files in the indicated directory will be affected; subdirectories will
be recursed into if RecurseSubdirectories
is true. If no path is specified but wildcards are, matching files in all directories
will be affected. If a single filename without a path is specified, it must correspond
exactly to the appropriate value of CompressedName .
Directories should end with a slash ("/"). If a directory is specified, all files and subdirectories in the specified directory will be affected.
A pipe character ("|") should be used to separate multiple file or directory names. Alternatively, the method may be invoked repeatedly.
IPWorksZipException
public void addZipEventListener(ipworkszip.ZipEventListener l) throws java.util.TooManyListenersException
java.util.TooManyListenersException
public void removeZipEventListener(ipworkszip.ZipEventListener l)
|
IP*Works! ZIP V8 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |