ArchiveWriter Class

Properties   Methods   Events   Config Settings   Errors  

The ArchiveWriter class allows compressing, updating and modifying files for zip, tar, gzip and bzip2 archives.

Syntax

secureblackbox.ArchiveWriter

Remarks

Use ArchiveWriter to compress, update, and modify files in archives. ArchiveWriter archiveWriter = new ArchiveWriter(); archiveWriter.setEncryptionType(ArchiveWriter.aetGeneric); // the type of encryption to apply to the archive archiveWriter.setEncryptionPassword("MyPassword"); // specifies the archive encryption password // creates a new archive with the desired archive type as a parameter archiveWriter.createNew(ArchiveWriter.aftZip); // add a file to the archive, the first parameter specifies the path where the file will be saved within the // archive, the second parameter the file that you want to add to the archive archiveWriter.addFile("","C:\\Photos\\MyPhoto.jpeg"); // add a collection of files to the archive, first param specifies the desired mount point for the files within the archive, // second param is the path to the files on the local system, and the last one indicates whether you want to process the // subdirectories recursively archiveWriter.addFiles("","C:\\Photos",true); archiveWriter.save("C:\\MyArchives");

Property List

---

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

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

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

ArchiveType Property (ArchiveWriter Class)

The type of the archive.

Syntax

public int getArchiveType();



Enumerated values:
  public final static int aftUnknown = 0;
  public final static int aftZip = 1;
  public final static int aftGzip = 2;
  public final static int aftBzip2 = 3;
  public final static int aftTar = 4;
  public final static int aftTarGzip = 5;
  public final static int aftTarBzip2 = 6;
  public final static int aftSFX = 7;

Default Value

0

Remarks

This property indicates the type of the opened archive.

This property is read-only.

CompressionAlgorithm Property (ArchiveWriter Class)

Specifies the compression algorithm to use when forming the ZIP archive.

Syntax

public int getCompressionAlgorithm();


public void setCompressionAlgorithm(int compressionAlgorithm);

Default Value

8

Remarks

Use this property to select the compression algorithm to be used when creating a ZIP archive.

A typical choice is DEFLATE, which is the default setting. Some implementations also use STORED as an alternative where no compression is required (so the resulting archive is effectively an uncompressed directory of files).

CompressionLevel Property (ArchiveWriter Class)

The compression level to apply to the archived data.

Syntax

public int getCompressionLevel();


public void setCompressionLevel(int compressionLevel);

Default Value

6

Remarks

Use this property to specify the compression level (1 to 9) to apply to the archived data.

DecryptionCertificates Property (ArchiveWriter Class)

A collection of decryption certificates.

Syntax

public CertificateList getDecryptionCertificates();


public void setDecryptionCertificates(CertificateList decryptionCertificates);

Remarks

Use this property to provide a collection of decryption certificates. All certificates should contain their respective private keys.

When processing an encrypted document, the class will walk through the certificate list to locate the matching decryption certificate. If no such certificate is found, it will fire RecipientFound event to request it.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

DecryptionPassword Property (ArchiveWriter Class)

The decryption password.

Syntax

public String getDecryptionPassword();


public void setDecryptionPassword(String decryptionPassword);

Default Value

""

Remarks

Use this property to provide the decryption password. You can assign it explicitly before commencing file extraction, or provide it on the fly from DecryptionPasswordNeeded event handler.

EncryptionAlgorithm Property (ArchiveWriter Class)

Specifies the encryption algorithm to apply to the archive.

Syntax

public String getEncryptionAlgorithm();


public void setEncryptionAlgorithm(String encryptionAlgorithm);

Default Value

""

Remarks

Use this property to specify the encryption algorithm to apply to the archive.

Class supports the following algorithms: AES128, AES192, AES256, BLOWFISH, TWOFISH, 3DES, 3DES112, DES, RC2, RC4. Note that not all of them may be supported by the processing software.

EncryptionCertificate Property (ArchiveWriter Class)

The encryption certificate.

Syntax

public Certificate getEncryptionCertificate();


public void setEncryptionCertificate(Certificate encryptionCertificate);

Remarks

Use this property to provide the encryption certificate.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

EncryptionKeyLength Property (ArchiveWriter Class)

The length of the encryption key.

Syntax

public int getEncryptionKeyLength();


public void setEncryptionKeyLength(int encryptionKeyLength);

Default Value

0

Remarks

Use this setting to specify the length of the encryption key in bits. Keep the key length at zero to let the component use the default value assumed by the encryption algorithm.

EncryptionPassword Property (ArchiveWriter Class)

Specifies the archive encryption password.

Syntax

public String getEncryptionPassword();


public void setEncryptionPassword(String encryptionPassword);

Default Value

""

Remarks

Use this property to provide the password to encrypt the archive with. Use it alongside EncryptionType and EncryptionAlgorithm properties to set up the whole set of protection settings for the archive.

EncryptionType Property (ArchiveWriter Class)

The type of encryption to apply to the archive.

Syntax

public int getEncryptionType();


public void setEncryptionType(int encryptionType);


Enumerated values:
  public final static int aetDefault = 0;
  public final static int aetNoEncryption = 1;
  public final static int aetGeneric = 2;
  public final static int aetWinZip = 3;
  public final static int aetStrong = 4;

Default Value

0

Remarks

Specifies the encryption type for the archive.

FileData Property (ArchiveWriter Class)

The contents of the file being added to the archive.

Syntax

public byte[] getFileData();


public void setFileData(byte[] fileData);

Remarks

Assign this property with a byte array containing the contents of the file being added, if you set the corresponding entry's DataSource to fdsBuffer.

Use FileStream property, with DataSource set to fdsStream, to provide the data in a stream instead. Alternatively, use fdsFile data source to supply the file data in a disk file.

This property is not available at design time.

Files Property (ArchiveWriter Class)

Lists the contents of the archive.

Syntax

public ArchivedFileList getFiles();

Remarks

This colletction property provides access to all files contained in the archive, both existing and newly added.

Use it to view or adjust properties of specific files, alter their data sources, and tune up actions to be performed on them.

This property is read-only and not available at design time.

Please refer to the ArchivedFile type for a complete list of fields.

FileStream Property (ArchiveWriter Class)

The contents of the file being added to the archive, in a stream.

Syntax

public java.io.InputStream getFileStream();


public void setFileStream(java.io.InputStream fileStream);

Default Value

null

Remarks

Assign a stream containing the contents of the file being added to the archive to this property. Remember to assign the entry's DataSource field to fdsStream.

This property is not available at design time.

FIPSMode Property (ArchiveWriter Class)

Reserved.

Syntax

public boolean isFIPSMode();


public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

HashAlgorithm Property (ArchiveWriter Class)

Specifies the hash algorithm to be used to generate the signature.

Syntax

public String getHashAlgorithm();


public void setHashAlgorithm(String hashAlgorithm);

Default Value

""

Remarks

Set this property before signing the archive to specify the hash algorithm to be used to calculate the signature.

This property is not available at design time.

NewArchive Property (ArchiveWriter Class)

Indicates whether the archive object represents a new (rather than opened) archive.

Syntax

public boolean isNewArchive();

Default Value

False

Remarks

This property is set to true if the archive is new, or to false if the class control is editing an existing archive.

NewArchive would typically be set to true after a CreateNew call, and to false after an Open call.

This property is read-only.

Opened Property (ArchiveWriter Class)

Indicates whether class is currently in edit mode.

Syntax

public boolean isOpened();

Default Value

False

Remarks

This property is set to true if the archive control is in edit mode, meaning it was opened with Open or created with CreateNew call.

When an archive is opened, you can add new files to it, remove existing files, or modify encryption attributes.

This property is read-only.

Overwrite Property (ArchiveWriter Class)

Whether the class should overwrite existing files.

Syntax

public boolean isOverwrite();


public void setOverwrite(boolean overwrite);

Default Value

False

Remarks

Enable this property to force overwriting of existing files.

SigningCertificate Property (ArchiveWriter Class)

The certificate to be used for signing.

Syntax

public Certificate getSigningCertificate();


public void setSigningCertificate(Certificate signingCertificate);

Remarks

Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

SigningChain Property (ArchiveWriter Class)

The signing certificate chain.

Syntax

public CertificateList getSigningChain();


public void setSigningChain(CertificateList signingChain);

Remarks

Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

AddEmptyDir Method (ArchiveWriter Class)

Adds an empty folder to the archive.

Syntax

public int addEmptyDir(String path);

Remarks

Use this method to added an empty folder to the archive with an internal path of Path.

The method returns the index of the new folder entry in the Files collection.

AddFile Method (ArchiveWriter Class)

Adds a file to the archive.

Syntax

public int addFile(String path, String localPath);

Remarks

Use this method to add a disk file to the archive. Provide the local path to the file (e.g. C:\Photos\photo.jpg) via the LocalPath parameter, and the desired path within the archive (e.g. PhotosBackup2020/photo.jpg) via the Path parameter.

AddFiles Method (ArchiveWriter Class)

Adds a group of files to the archive.

Syntax

public void addFiles(String folder, String localPath, boolean recursive);

Remarks

Use this method to add a collection of files to the archive.

Provide the path to the files on a local system (e.g. C:\photos) via the LocalPath parameter, and set Recursive to indicate whether you want to process the subdirectories recursively. Pass the desired mount point for the files within the archive (e.g. Backup2020/photos) via the Folder parameter.

You can use file mask wildcards in LocalPath to only select the files that match the mask.

AddVirtual Method (ArchiveWriter Class)

Adds a file placeholder to the archive.

Syntax

public int addVirtual(String path);

Remarks

Use this method to add a placeholder for the entry the contents of which is to be provided on the fly from a stream or buffer.

Pass the path to the entry within the archive (e.g. Reports/report2020.csv) via the Path parameter. After the entry has been added, use PrepareFile event or Files property to tune up the type of the data source (file, stream, or memory buffer). During the actual compression, provide the contents of the entry in a stream or buffer in the BeforeCompressFile event handler.

This method returns the index of the new entry in the Files collection.

Close Method (ArchiveWriter Class)

Closes the archive.

Syntax

public void close();

Remarks

Use this method to close the current archive and dispose of all the allocated resources.

Call this method when you are done with the archive.

Config Method (ArchiveWriter Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

CreateNew Method (ArchiveWriter Class)

Creates a new archive.

Syntax

public void createNew(int archiveType);

Remarks

Use this method to create a new archive file. Provide the desired archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save or SaveStream method.

DoAction Method (ArchiveWriter Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Open Method (ArchiveWriter Class)

Opens an archive file.

Syntax

public void open(int archiveType, String archiveName);

Remarks

Use this method to open an existing archive file for modification.

Provide the path to the archive file via the ArchiveName parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save or SaveStream method.

OpenBytes Method (ArchiveWriter Class)

Loads an archive file from a byte array.

Syntax

public void openBytes(int archiveType, byte[] archiveBytes);

Remarks

Use this method to load an existing archive file from a byte array.

Provide the archive stream via the ArchiveBytes parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save, SaveStream, or SaveBytes method.

OpenStream Method (ArchiveWriter Class)

Loads an archive file from a stream.

Syntax

public void openStream(int archiveType, java.io.InputStream archiveStream);

Remarks

Use this method to load an existing archive file from a stream.

Provide the archive stream via the ArchiveStream parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save or SaveStream method.

Remove Method (ArchiveWriter Class)

Removes file(s) and/or folder(s) from the archive.

Syntax

public void remove(String path);

Remarks

Use this method to remove entries from the archive. Provide an archive-local path via the Path parameter.

Path supports file masks, which makes this method quite powerful (and potentially dangerous).

Reset Method (ArchiveWriter Class)

Resets the class settings.

Syntax

public void reset();

Remarks

Reset is a generic method available in every class.

Save Method (ArchiveWriter Class)

Compresses the archive and saves it to a file.

Syntax

public void save(String archiveName);

Remarks

Use this method to finalize all preparations, compress all the entries set up in Files collection, and write the created archive to ArchiveName file.

This method carries out a lot of work and fires a number of events during its execution. Before the compression process starts, PrepareFile event fires repeatedly to provide the summary of what is being included into the archive. A handler of that event is a good place to make last-minute modifications to the data sources, file names, and actions to take upon the files.

Compression of each entry is surrounded with BeforeCompressFile and AfterCompressFile "brackets". Subscribe to BeforeCompressFile to supply the file contents for entries with Buffer and Stream data sources. AfterCompressFile is a good place to release the content stream alloated in the BeforeCompressFile event handler.

Progress event fires repeatedly to report the progress of the current and whole operations. It also provides an opportunity to abort the compression process.

SaveBytes Method (ArchiveWriter Class)

Compresses the archive and saves it to a byte array.

Syntax

public byte[] saveBytes();

Remarks

Use this method to finalize all preparations and compress all entries contained in the Files collection. The method returns the byte array containing the serialized archive.

You can fine-tune the compression process by providing compression details on the fly via the events class fires. See the description of the Save method for the details.

SaveStream Method (ArchiveWriter Class)

Compresses the archive and saves it to a stream.

Syntax

public void saveStream(java.io.OutputStream archiveStream);

Remarks

Use this method to finalize all preparations and compress all entries contained in the Files collection to ArchiveStream.

You can fine-tune the compression process by providing compression details on the fly via the events class fires. See the description of the Save method for the details.

UpdateFile Method (ArchiveWriter Class)

Updates an existing compressed entry with a fresher local version.

Syntax

public void updateFile(String path, String localPath);

Remarks

Call this method to update the Path entry in the archive with a fresher entry at LocalPath.

UpdateFiles Method (ArchiveWriter Class)

Updates a selection of files in the archive.

Syntax

public void updateFiles(String folder, String localPath, boolean addMissingFiles, boolean removeMissingFiles, boolean recursive);

Remarks

This method is a powerful way to update a subset of files in the archive in accordance with a specified criteria.

Pass an archive-local name of the folder to update via the Folder parameter, and the system-local version of the same folder via the LocalPath parameter. Set AddMissingFiles and RemoveMissingFiles as needed to force inclusion of files missing from the archive, or removal of files missing locally, accordingly.

The Recursive parameter specifies whether the directory should be browsed recursively.

UpdateVirtual Method (ArchiveWriter Class)

Updates an entry in the archive with on-the-fly content.

Syntax

public void updateVirtual(String path);

Remarks

Use this method to update content of an existing archive entry. Pass the archive-local entry path via the Path parameter. After updating the entry, tune up its DataSource property in accordance with the desired content origin. Subscribe to BeforeCompressFile to supply the actual data via FileData or FileStream properties.

ActionNeeded Event (ArchiveWriter Class)

Requests a decision from the application in case of a conflict.

Syntax

public class DefaultArchiveWriterEventListener implements ArchiveWriterEventListener {
  ...
  public void actionNeeded(ArchiveWriterActionNeededEvent e) {}
  ...
}

public class ArchiveWriterActionNeededEvent {
  public int whatFor;
  public String entryPath;
  public String destPath;
  public String description;
  public int action; //read-write
}

Remarks

The component fires this event to request a decision from the application when it encounters a conflict.

The WhatFor parameter can take one of the following values:

You can control the further flow from the event handler by setting the Action parameter to one of the following values:

AfterCompressFile Event (ArchiveWriter Class)

Marks the completion of compression of a file.

Syntax

public class DefaultArchiveWriterEventListener implements ArchiveWriterEventListener {
  ...
  public void afterCompressFile(ArchiveWriterAfterCompressFileEvent e) {}
  ...
}

public class ArchiveWriterAfterCompressFileEvent {
  public String path;
  public long fileSize;
  public int dataSource;
}

Remarks

Subscribe to this event to get notified about the completion of compression of a file.

The Path parameter specifies the internal path to the entry inside the archive. The FileSize indicates the size of the file before compression, and the DataSource specifies the type of the source media.

BeforeCompressFile Event (ArchiveWriter Class)

Marks the start of compression of a file.

Syntax

public class DefaultArchiveWriterEventListener implements ArchiveWriterEventListener {
  ...
  public void beforeCompressFile(ArchiveWriterBeforeCompressFileEvent e) {}
  ...
}

public class ArchiveWriterBeforeCompressFileEvent {
  public String path;
  public long fileSize;
  public int dataSource;
}

Remarks

Subscribe to this event to be notified about the start of compression of an archive entry. The handler of this event is a good place to prepare the desired data source.

The Path parameter indicates the path to the extracted entry in the archive. The FileSize specifies the size of the file before compression. Use this event handler to adjust the data source if the file is to be loaded from a stream or buffer. The DataSource parameter indicates the type of the data media:

If passing the data from a stream or buffer, use AfterCompressFile to dispose of any objects allocated in this event handler (such as the source stream).

Use PrepareFile event to adjust the file data source on the fly.

DecryptionPasswordNeeded Event (ArchiveWriter Class)

Fires when the class needs a password to decrypt the archive.

Syntax

public class DefaultArchiveWriterEventListener implements ArchiveWriterEventListener {
  ...
  public void decryptionPasswordNeeded(ArchiveWriterDecryptionPasswordNeededEvent e) {}
  ...
}

public class ArchiveWriterDecryptionPasswordNeededEvent {
  public String passwordTarget;
  public boolean cancel; //read-write
}

Remarks

Class fires this event to request a decryption password from the application when it comes across an encrypted archive or entry.

Please assign the password to DecryptionPassword property inside the event handler, or set Cancel to true to cancel the operation. The PasswordTarget parameter references the object that is protected with the requested password.

Error Event (ArchiveWriter Class)

Reports information about errors during archive assembling.

Syntax

public class DefaultArchiveWriterEventListener implements ArchiveWriterEventListener {
  ...
  public void error(ArchiveWriterErrorEvent e) {}
  ...
}

public class ArchiveWriterErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The event is fired in case of exceptional conditions during archive formation.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (ArchiveWriter Class)

This event notifies the application about an underlying control flow event.

Syntax

public class DefaultArchiveWriterEventListener implements ArchiveWriterEventListener {
  ...
  public void notification(ArchiveWriterNotificationEvent e) {}
  ...
}

public class ArchiveWriterNotificationEvent {
  public String eventID;
  public String eventParam;
}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

PrepareFile Event (ArchiveWriter Class)

Fires for every file to be compressed before the compression starts.

Syntax

public class DefaultArchiveWriterEventListener implements ArchiveWriterEventListener {
  ...
  public void prepareFile(ArchiveWriterPrepareFileEvent e) {}
  ...
}

public class ArchiveWriterPrepareFileEvent {
  public String path;
  public long fileSize;
  public int dataSource; //read-write
  public String localPath; //read-write
  public int action; //read-write
}

Remarks

Class fires this event for every file included in the Files collection before commencing the compression. This is the last opportunity for your code to adjust the action to be taken for each file and tune up the data sources appropriately.

The Path parameter contains the path to the file within the archive (such as Photos/myphoto.jpg), and the FileSize contains the size of that file before compression.

The DataSource parameter indicates the media from which the file contents is to be taken. A typical default value if fdsFile, but you can adjust the value of that parameter if you need to use an alternative source. The following options are available:

Please do not assign FileStream or FileData in this event handler: this should be done further down the road in the BeforeCompressFile event handler. The purpose of this event is to prepare the compression plan by summarizing what should be done and to which files.

The Action parameter, which is also tuneable, indicates the action for class to take on the file:

Progress Event (ArchiveWriter Class)

Reports the progress of data compression.

Syntax

public class DefaultArchiveWriterEventListener implements ArchiveWriterEventListener {
  ...
  public void progress(ArchiveWriterProgressEvent e) {}
  ...
}

public class ArchiveWriterProgressEvent {
  public long processed;
  public long total;
  public long overallProcessed;
  public long overallTotal;
  public boolean cancel; //read-write
}

Remarks

Subscribe to this event to be notified about compression progress.

Processed and Total report the progress of compression of the current entry; OverallProcessed and OverallTotal report the progress of the whole operation. Set Cancel to true to stop the operation.

RecipientFound Event (ArchiveWriter Class)

Signifies that the archive was found to be encrypted with a digital certificate.

Syntax

public class DefaultArchiveWriterEventListener implements ArchiveWriterEventListener {
  ...
  public void recipientFound(ArchiveWriterRecipientFoundEvent e) {}
  ...
}

public class ArchiveWriterRecipientFoundEvent {
  public String publicKeyHash;
  public boolean certFound;
}

Remarks

The class fires this event to notify the application that the archive was found to be encrypted with a digital certificate. The hash of the certificate's public key is provided in the PublicKeyHash parameter.

CertFound indicates whether a certificate with a matching public key hash was found in the DecryptionCertificates list. If it wasn't, you need to locate it on the system and add it to that list: class won't be able to decrypt the archive otherwise.

Please note that the certificate must have an associated private key to be capable of decryption.

ArchivedFile Type

Provides information about the compressed file.

Remarks

Use this type to access compressed file details.

Fields

Constructors

public ArchivedFile();

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

This type keeps and provides access to X.509 certificate details.

Fields

Constructors

public Certificate( bytes,  startIndex,  count,  password);

public Certificate( certBytes,  certStartIndex,  certCount,  keyBytes,  keyStartIndex,  keyCount,  password);

public Certificate( bytes,  startIndex,  count);

public Certificate( path,  password);

public Certificate( certPath,  keyPath,  password);

public Certificate( path);

public Certificate( stream);

public Certificate( stream,  password);

public Certificate( certStream,  keyStream,  password);

public Certificate();

Config Settings (ArchiveWriter Class)

The class 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 class, access to these internal properties is provided through the Config method.

ArchiveWriter Config Settings

Base Config Settings

Trappable Errors (ArchiveWriter Class)