SecureBlackbox Lite 2020 Node.js 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

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.

ArchiveTypeThe type of the archive.
CompressionLevelThe compression level to apply to the archived data.
DecryptionCertCountThe number of records in the DecryptionCert arrays.
DecryptionCertBytesReturns raw certificate data in DER format.
DecryptionCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
DecryptionPasswordThe decryption password.
EncryptionAlgorithmSpecifies the encryption algorithm to apply to the archive.
EncryptionCertBytesReturns raw certificate data in DER format.
EncryptionCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
EncryptionPasswordSpecifies the archive encryption password.
EncryptionTypeThe type of encryption to apply to the archive.
FileDataThe contents of the file being added to the archive.
FileCountThe number of records in the File arrays.
FileActionThe action to apply to the file.
FileCompressedSizeThe size of the file after compression.
FileDataSourceThe type of the data source for this entry.
FileDirectoryTells if the entry is a directory or a regular file.
FileEncryptionAlgorithmReturns the symmetric algorithm that was used to encrypt the file.
FileEncryptionKeyLengthReturns the length, in bits, of the encryption key.
FileEncryptionTypeThe type of encryption applied to the file.
FileFileNameThe original name of the compressed file or folder.
FileFolderThe containing folder of the entry.
FileLocalPathThe local path associated with this entry.
FileMTimeThe entry's last modification time.
FileNewFileIndicates whether the entry corresponds to a file to be added to the archive.
FilePathThe full internal path of the archived entry.
FileSignatureCountThe number of signatures covering the entry.
FileSignedIndicates whether the entry is signed.
FileSizeThe size of the file before compression.
NewArchiveIndicates whether the archive object represents a new (rather than opened) archive.
OpenedIndicates whether class is currently in edit mode.
SigningCertBytesReturns raw certificate data in DER format.
SigningCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SigningChainCountThe number of records in the SigningChain arrays.
SigningChainBytesReturns raw certificate data in DER format.
SigningChainHandleAllows 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.

AddEmptyDirAdds an empty folder to the archive.
AddFileAdds a file to the archive.
AddFilesAdds a group of files to the archive.
AddVirtualAdds a file placeholder to the archive.
CloseCloses the archive.
ConfigSets or retrieves a configuration setting.
CreateNewCreates a new archive.
OpenOpens an archive file.
OpenBytesLoads 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.
SaveBytesCompresses the archive and saves it to a byte array.
UpdateFileUpdates an existing compressed entry with a fresher local version.
UpdateFilesUpdates a selection of files in the archive.
UpdateVirtualUpdates 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.

AfterCompressFileMarks the completion of compression of a file.
BeforeCompressFileMarks the start of compression of a file.
DecryptionPasswordNeededFires when the class needs a password to decrypt the archive.
ErrorReports information about errors during archive assembling.
NotificationThis event notifies the application about an underlying control flow event.
PrepareFileFires for every file to be compressed before the compression starts.
ProgressReports the progress of data compression.
RecipientFoundSignifies 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 Node.js Edition - Version 20.0 [Build 8166]