SecureBlackbox Lite 2020 Python Edition

Questions / Feedback?

ArchiveWriter Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

class secureblackboxlite.ArchiveWriter

Remarks

Use ArchiveWriter to compress, update, and modify files in archives.

Property List


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

archive_typeThe type of the archive.
compression_levelThe compression level to apply to the archived data.
decryption_cert_countThe number of records in the DecryptionCert arrays.
decryption_cert_bytesReturns raw certificate data in DER format.
decryption_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
decryption_passwordThe decryption password.
encryption_algorithmSpecifies the encryption algorithm to apply to the archive.
encryption_cert_bytesReturns raw certificate data in DER format.
encryption_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
encryption_passwordSpecifies the archive encryption password.
encryption_typeThe type of encryption to apply to the archive.
file_dataThe contents of the file being added to the archive.
file_countThe number of records in the File arrays.
file_actionThe action to apply to the file.
file_compressed_sizeThe size of the file after compression.
file_data_sourceThe type of the data source for this entry.
file_directoryTells if the entry is a directory or a regular file.
file_encryption_algorithmReturns the symmetric algorithm that was used to encrypt the file.
file_encryption_key_lengthReturns the length, in bits, of the encryption key.
file_encryption_typeThe type of encryption applied to the file.
file_file_nameThe original name of the compressed file or folder.
file_folderThe containing folder of the entry.
file_local_pathThe local path associated with this entry.
file_m_timeThe entry's last modification time.
file_new_fileIndicates whether the entry corresponds to a file to be added to the archive.
file_pathThe full internal path of the archived entry.
file_signature_countThe number of signatures covering the entry.
file_signedIndicates whether the entry is signed.
file_sizeThe size of the file before compression.
new_archiveIndicates whether the archive object represents a new (rather than opened) archive.
openedIndicates whether class is currently in edit mode.
signing_cert_bytesReturns raw certificate data in DER format.
signing_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
signing_chain_countThe number of records in the SigningChain arrays.
signing_chain_bytesReturns raw certificate data in DER format.
signing_chain_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.

Method List


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

add_empty_dirAdds an empty folder to the archive.
add_fileAdds a file to the archive.
add_filesAdds a group of files to the archive.
add_virtualAdds a file placeholder to the archive.
closeCloses the archive.
configSets or retrieves a configuration setting.
create_newCreates a new archive.
openOpens an archive file.
open_bytesLoads an archive file from a byte array.
removeRemoves file(s) and/or folder(s) from the archive.
saveCompresses the archive and saves it to a file.
save_bytesCompresses the archive and saves it to a byte array.
update_fileUpdates an existing compressed entry with a fresher local version.
update_filesUpdates a selection of files in the archive.
update_virtualUpdates an entry in the archive with on-the-fly content.

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.

on_after_compress_fileMarks the completion of compression of a file.
on_before_compress_fileMarks the start of compression of a file.
on_decryption_password_neededFires when the class needs a password to decrypt the archive.
on_errorReports information about errors during archive assembling.
on_notificationThis event notifies the application about an underlying control flow event.
on_prepare_fileFires for every file to be compressed before the compression starts.
on_progressReports the progress of data compression.
on_recipient_foundSignifies that the archive was found to be encrypted with a digital certificate.

Configuration Settings


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

EncryptionKeyLengthThe length of the encryption key.
TempPathPath for storing temporary files.
UsePaxEnables use of PAX algorithm when creating TAR directories.
UseUStarEnables use of UStar variant of file name packaging when creating TAR directories.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox Lite 2020 Python Edition - Version 20.0 [Build 8166]