org.bouncycastle.crypto.CipherOutputStream Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bc-fips Show documentation

The FIPS 140-3 Bouncy Castle Crypto package is a Java implementation of cryptographic algorithms certified to FIPS 140-3 level 1. This jar contains JCE provider and low-level API for the BC-FJA version 2.0.0, FIPS Certificate #4743. Please see certificate for certified platform details.

There is a newer version: 2.0.0

Show newest version

package org.bouncycastle.crypto;

import java.io.IOException;

/**
 * Returned stream for writing data for encryption/decryption.
 */
public abstract class CipherOutputStream
    extends UpdateOutputStream
{
    /**
     * Closes this output stream and releases any system resources
     * associated with this stream.
     * 
     * This method invokes the doFinal method of the encapsulated
     * cipher object, which causes any bytes buffered by the encapsulated
     * cipher to be processed. The result is written out by calling the
     * flush method of this output stream.
     * 
     * This method resets the encapsulated cipher object to its initial state
     * and does not call close method of the underlying output
     * stream.
     *
     * @throws java.io.IOException if an I/O error occurs.
     * @throws InvalidCipherTextException if the data written to this stream was invalid cipher text
     * (e.g. the cipher is an AEAD cipher and the cipher text tag check fails).
     */
    public abstract void close()
        throws IOException;
}