Android™

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.

Android™

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    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) {
        Log.i(TAG, 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) {
        Log.i(TAG, gzip.lastErrorText());
        return;
        }

    Log.i(TAG, "Gzip file created with extra data.");

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

    Log.i(TAG, "Metadata JSON:");
    Log.i(TAG, json.emit());

  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}