Jar ConfigurationThe 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.
Jar Configuration Settings
If true, the component requests an exclusive lock during initialization.If set to true, the component will request an exclusive lock during initialization to ensure there are no other processes locking a file. This is a temporary lock and is released before work is done. This is especially useful when another process has a partial lock on a file, for instance when Outlook is working with a .pst.
False by default.
Attributes of files to be excluded.
Files with attributes matching those specified will be excluded from compression or decompression. May be set to any
combination of H (hidden), S (system), A (archive), and R (read-only).
(Example: "HSR") Alternatively, may be set to a bitmask of the following flags:
Readonly (1), Hidden (2), System (4), Directory (16), Archive (32).
For Java, when compressing, attributes other than "H" and "R" will be ignored (due to JRE limitations).
Default: "" (no excluded attributes)
|ExtractFilesOnly: Whether to only extract the files contained within the archive. If true, only the files contained within the archive_file are extracted directly to the specified extract_to_path. Folders contained within the archive_file will not be created within the extract_to_path. If an archive contains files with the same name, you can control whether or not they get overwritten by setting overwrite_files.|
|OverwriteReadonlyFiles: Whether to overwrite readonly files. If true, the class will overwrite readonly files when decompressing. If false (the default), the class will fire the on_error event, instead, and will fail with an exception if the error is not trapped and explicitly ignored in the event.|
Whether or not to write data to the Progress Event.If WriteToProgressEvent is set to true, then all data produced through invocations
of extract, extract_all, and compress will be written to the on_progress
event as well as to disk. Applications may stream out the compressed or decompressed
data by trapping this event and copying the data.
By default, this config is set to false.
Base Configuration Settings
|BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build.|
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to false to use the class in a background thread on macOS. By default this setting is True.|
|SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.|
|UseInternalSecurityAPI: Tells the class whether or not to use the system security libraries or an internal implementation. By default the class will use the system security libraries to perform cryptographic functions. Setting this to True tells the class to use the internal implementation instead of using the system's security API.|