Zip Module

The Zip transformer implements a PKZip-compatible Zip compressor and decompressor.

Remarks

The Zip module is used for compressing and decompressing messages. The module uses the Deflate algorithm specified in RFC 1951 for compression, and produces and reads output compatible with PKZip, WinZip, etc.

Zip Assembler Module

The Assembler takes a group of files as input which contains raw data, and generates a Zip archive file as output.

Compression strength is regulated by the CompressionLevel property. You may also control encryption behavior by setting the Password and EncryptionAlgorithm properties on this module.

Zip Disassembler Module

The Disassembler takes a zipped file as input, and generates a group of unzipped files as output.

The Password property must be set in order to extract files which have been encrypted. You may also use the ExcludedFiles property to regulate which files are to be extracted from the archive.

Single File Operation

If the ExtractToPath configuration setting is not set, the Disassembler operates in single file mode. In this mode, the Disassembler will search the archive for the first file that matches the FileMask, and that file will be the message sent to the next connector in the flow.

Multi File Operation

By setting the ExtractToPath configuration setting, the Disassembler will operate in multi file mode. In this mode, the Disassembler will search the archive for all files that match the FileMask, and will extract those files to the directory specified by the value of ExtractToPath.

Assembler Property List

The following is the full list of the properties of the assembler module with short descriptions. Click on the links for further details.


ArchiveFileName	The name of the zip archive.
CompressedFileName	The names of the zip compress file names.
CompressionLevel	The compression level to use.
EncryptionAlgorithm	The algorithm used to encrypt a MuleSoft when written to the archive.
FileModifiedTime	The modified time of the compressed files.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during connector execution.
Other	Defines a set of configuration settings to be used by the transformer.
Password	A password for the zip file.
TempPath	A temporary directory where uncompressed and compressed data can be stored.
ZipComment	The comment for the entire zip file.

Disassembler Property List

The following is the full list of the properties of the disassembler module with short descriptions. Click on the links for further details.


DecompressedFilename	Holds the decompressed filename.
FileMask	Specifies which files the connector should include when extracting.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during connector execution.
Other	Defines a set of configuration settings to be used by the transformer.
Password	A password for the zip file.
TempPath	A temporary directory where uncompressed and compressed data can be stored.

Configuration Settings

The following is a list of configuration settings for the module with short descriptions. Click on the links for further details.


Append	Specifies whether to append files.
ArchiveFile	The location of the archive file on disk.
CompressionMethod	Used to set the method of compression.
PlainPassword	Allows you to specify a password stored in plaintext.
ExtractToPath	.
OverwriteFiles	Whether or not to overwrite files.
IncludeFiles	Specifies local files to include in the archive.
ExcludedFiles	A list of files to exclude.