net.sf.sevenzipjbinding.IOutFeatureSetEncryptHeader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sevenzipjbinding Show documentation

7-Zip-JBinding is a free cross-platform java binding of 7-Zip free compress/decompress library (http://www.7-zip.org/, http://p7zip.sourceforge.net/)

The newest version!

package net.sf.sevenzipjbinding;

/**
 * Feature interface for the setting 'encrypt header'. Use {@link SevenZip#openOutArchive(ArchiveFormat)} or one of the
 * SevenZip.openOutArchiveXxx() methods to get implementation of this interface.
 *
 * @see IOutCreateArchive
 *
 * @author Boris Brodski
 * @since 16.02-2.01
 *
 */
public interface IOutFeatureSetEncryptHeader {

    /**
     * Enable/disable header encryption for password protected archives. If enabled, the archive header containing file
     * names and other metadata will be encrypted as well.

     * 

     * Note: Implement {@link ICryptoGetTextPassword} in your callback class to turn on the encryption.
     *
     * @param enabled
     *            true enable header encryption, otherwise false
     * @throws SevenZipException
     *             in error case. If this method ends with an exception, the current operation will be reported to 7-Zip
     *             as failed. There are no guarantee, that there are no further call back methods will get called. The
     *             first and last thrown exceptions will be saved and thrown later on from the originally called method
     *             such as ISevenZipInArchive.extract() or SevenZip.openInArchive(). Up to
     *             four exceptions depending on the situation can be saved for further analysis. See
     *             {@link SevenZipException} and {@link SevenZipException#printStackTraceExtended()} for details.
     */
    public void setHeaderEncryption(boolean enabled) throws SevenZipException;
}