(Java) Add Custom Extra Data to a Gzip File

This example demonstrates how to use the SetExtraData method to include custom binary data in the Gzip header using a hex-encoded string.

The hex string represents the raw bytes to embed in the Gzip metadata. When a compression method is called, this data is included in the Gzip header.

The example also shows how to retrieve the metadata using GetGzipInfo to verify that the extra data was successfully embedded. The retrieved value is returned as a Base64-encoded string.

Chilkat Java Downloads Java Libs for Windows, MacOS, Linux, Alpine Linux Java Libs for Android

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean success = false;

    // This example demonstrates how to include custom extra data
    // in the Gzip header when compressing.

    // The extra data is provided as a hex-encoded string.

    CkGzip gzip = new CkGzip();
    CkJsonObject json = new CkJsonObject();

    // Set extra data using a hex string.
    // This example represents 4 bytes: 00 01 02 03
    success = gzip.SetExtraData("00010203","hex");
    if (success == false) {
        System.out.println(gzip.lastErrorText());
        return;
        }

    // Compress a file so the extra data is embedded in the Gzip header:
    String inputFile = "example.txt";
    String outputFile = "example.txt.gz";

    success = gzip.CompressFile(inputFile,outputFile);
    if (success == false) {
        System.out.println(gzip.lastErrorText());
        return;
        }

    System.out.println("Gzip file created with extra data.");

    // (Optional) Retrieve the metadata to verify:
    success = gzip.GetGzipInfo(outputFile,json);
    if (success == false) {
        System.out.println(gzip.lastErrorText());
        return;
        }

    System.out.println("Metadata JSON:");
    System.out.println(json.emit());
  }
}