public class CipherOutputStream extends FilterOutputStream
A CipherOutputStream is composed of an OutputStream and a Cipher so that write() methods first process the data before writing them out to the underlying OutputStream. The cipher must be fully initialized before being used by a CipherOutputStream.
For example, if the cipher is initialized for encryption, the CipherOutputStream will attempt to encrypt data before writing out the encrypted data.
This class adheres strictly to the semantics, especially the failure semantics, of its ancestor classes java.io.OutputStream and java.io.FilterOutputStream. This class has exactly those methods specified in its ancestor classes, and overrides them all. Moreover, this class catches all exceptions that are not thrown by its ancestor classes.
It is crucial for a programmer using this class not to use methods that are not defined or overriden in this class (such as a new method or constructor that is later added to one of the super classes), because the design and implementation of those methods are unlikely to have considered security impact with regard to CipherOutputStream.
OutputStream, FilterOutputStream, Cipher, CipherInputStream
out public CipherOutputStream(OutputStream os,
Cipher c) Constructs a CipherOutputStream from an OutputStream and a Cipher.
Note: if the specified output stream or cipher is null, a NullPointerException may be thrown later when they are used.
os - the OutputStream objectc - an initialized Cipher objectprotected CipherOutputStream(OutputStream os)
Constructs a CipherOutputStream from an OutputStream without specifying a Cipher. This has the effect of constructing a CipherOutputStream using a NullCipher.
Note: if the specified output stream is null, a NullPointerException may be thrown later when it is used.
os - the OutputStream objectpublic void write(int b)
throws IOException Writes the specified byte to this output stream.
write in class FilterOutputStream
b - the byte.IOException - if an I/O error occurs.public void write(byte[] b)
throws IOException Writes b.length bytes from the specified byte array to this output stream.
The write method of CipherOutputStream calls the write method of three arguments with the three arguments b, 0, and b.length.
write in class FilterOutputStream
b - the data.NullPointerException - if b is null.IOException - if an I/O error occurs.write(byte[], int, int)public void write(byte[] b,
int off,
int len)
throws IOException Writes len bytes from the specified byte array starting at offset off to this output stream.
write in class FilterOutputStream
b - the data.off - the start offset in the data.len - the number of bytes to write.IOException - if an I/O error occurs.FilterOutputStream.write(int)public void flush()
throws IOException Flushes this output stream by forcing any buffered output bytes that have already been processed by the encapsulated cipher object to be written out.
Any bytes buffered by the encapsulated cipher and waiting to be processed by it will not be written out. For example, if the encapsulated cipher is a block cipher, and the total number of bytes written using one of the write methods is less than the cipher's block size, no bytes will be written out.
flush in interface Flushable
flush in class FilterOutputStream
IOException - if an I/O error occurs.FilterOutputStream.outpublic void close()
throws IOException 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 calls the close method of the underlying output stream.
close in interface Closeable
close in interface AutoCloseable
close in class FilterOutputStream
IOException - if an I/O error occurs.FilterOutputStream.flush(), FilterOutputStream.out
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.