/n software Connectors for MuleSoft

Questions / Feedback?

Gzip Module

Properties   Configuration Settings  

The GZIP transformer implements a gzip compressor and decompressor, compliant to RFC 1952 and compatible with the UNIX gzip and gunzip utilities.

Remarks

The GZIP module adds compression and decompression capabilities to your Mule Project.The GZIP file format is typically used only to archive a single file. Accordingly, the operation of the module is simpler than that of other modules.

GZIP Compress Module

The GZIP Compress Single operation compresses a single file. The module reads the input data in the payload and processes it into binary compressed data. When the operation completes, the module writes the bytes of the GZIP-formatted file to the payload of the Mule message as output.

Compression strength is regulated by the CompressionLevel property. Advanced configuration can be specified in the Other property.

Compress Example

To get started, simply provide the module a message to compress. Do this by setting the payload of a Mule Message to the Binary input data before it arrives at the Compress operation. For example, add a File Read Connector to your flow and add GZIP Compress behind it. There is no need to transform the output of the File Read Connector before passing it to the GZIP Compress operation.

No additional configuration is necessary to begin compressing data. To write the compressed data to disk, add a File Write connector behind the GZIP Compress operation and specify the Path and Content. The output of Compress is the Binary of the resulting GZIP-formatted file in the message payload which can be passed directly to the File Write connector.

GZIP Decompress Module

The GZIP Decompress Single operation decompresses a single file. The module reads the input data in the payload and processes it into binary decompressed data. When the operation completes, the module writes the decompressed bytes to the payload of the Mule message.

Decompress Example

To get started, simply provide the module a message to decode. Do this by setting the payload of a Mule Message to the Binary input data before it arrives at the Decompress operation. For example, add a File Read Connector in front of GZIP Decompress. There is no need to transform the output of the File Read Connector before passing it to the GZIP Decompress operation.

No additional configuration is necessary to begin decompressing data. To write the decompressed file to disk, add a File Write connector behind the GZIP Decompress operation and specify the Path and Content. The output of the Decompressor in the payload is Binary decompressed data and can be passed directly to the File Write connector.

Compressor Property List


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

CompressionLevelThe compression level to use.
FileCompressedNameFilename, as stored inside of the archive.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during connector execution.
LogTypeHow information gets logged during connector execution.
OtherDefines a set of configuration settings to be used by the transformer.
RuntimeLicenseSpecifies the connector runtime license key.
TempPathA temporary directory where uncompressed and compressed data can be stored.

Decompressor Property List


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

LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during connector execution.
LogTypeHow information gets logged during connector execution.
OtherDefines a set of configuration settings to be used by the transformer.
RuntimeLicenseSpecifies the connector runtime license key.
TempPathA temporary directory where uncompressed and compressed data can be stored.

Encoder Property List


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

CompressionLevelThe compression level to use.
FileCompressedNameFilename, as stored inside of the archive.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during connector execution.
LogTypeHow information gets logged during connector execution.
OtherDefines a set of configuration settings to be used by the transformer.
RuntimeLicenseSpecifies the connector runtime license key.
TempPathA temporary directory where uncompressed and compressed data can be stored.

Decoder Property List


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

LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during connector execution.
LogTypeHow information gets logged during connector execution.
OtherDefines a set of configuration settings to be used by the transformer.
RuntimeLicenseSpecifies the connector runtime license key.
TempPathA 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.

SuggestCompressedNameWhether to suggest a file name.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
/n software Connectors for MuleSoft - Version 20.0 [Build 7722]