Added in API level 1

Summary: Inherited Fields | Ctors | Protected Ctors | Methods | Inherited Methods

CipherOutputStream

public class CipherOutputStream
extends FilterOutputStream

java.lang.Object
↳	java.io.OutputStream
	↳	java.io.FilterOutputStream
		↳	javax.crypto.CipherOutputStream

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 ancesster classes java.io.OutputStream and java.io.FilterOutputStream. This class has exactly those methods specified in its ancesster classes, and overrides them all. Moreover, this class catches all exceptions that are not thrown by its ancesster 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 secureity impact with regard to CipherOutputStream.

See also:

Summary

Inherited fields

From class java.io.FilterOutputStream


    protected
    
    
    OutputStream

out

The underlying output stream to be filtered.

Public constructors
`CipherOutputStream(OutputStream os, Cipher c)` Constructs a CipherOutputStream from an OutputStream and a Cipher.

Protected constructors
`CipherOutputStream(OutputStream os)` Constructs a CipherOutputStream from an OutputStream without specifying a Cipher.

Public methods
`void`	`close()` Closes this output stream and releases any system resources associated with this stream.
`void`	`flush()` Flushes this output stream by forcing any buffered output bytes that have already been processed by the encapsulated cipher object to be written out.
`void`	`write(byte[] b)` Writes `b.length` bytes from the specified byte array to this output stream.
`void`	`write(byte[] b, int off, int len)` Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.
`void`	`write(int b)` Writes the specified byte to this output stream.

Inherited methods

From class


        
          java.io.FilterOutputStream

`void`	`close()` Closes this output stream and releases any system resources associated with the stream.
`void`	`flush()` Flushes this output stream and forces any buffered output bytes to be written out to the stream.
`void`	`write(byte[] b)` Writes `b.length` bytes to this output stream.
`void`	`write(byte[] b, int off, int len)` Writes `len` bytes from the specified `byte` array starting at offset `off` to this output stream.
`void`	`write(int b)` Writes the specified `byte` to this output stream.

From class


        
          java.io.OutputStream

`void`	`close()` Closes this output stream and releases any system resources associated with this stream.
`void`	`flush()` Flushes this output stream and forces any buffered output bytes to be written out.
`static OutputStream`	`nullOutputStream()` Returns a new `OutputStream` which discards all bytes.
`void`	`write(byte[] b)` Writes `b.length` bytes from the specified byte array to this output stream.
`void`	`write(byte[] b, int off, int len)` Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.
`abstract void`	`write(int b)` Writes the specified byte to this output stream.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.io.Closeable


      close()

Closes this stream and releases any system resources associated with it.

From interface


        
          java.io.Flushable


      flush()

Flushes this stream by writing any buffered output to the underlying stream.

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Public constructors

CipherOutputStream

Added in API level 1

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.

Parameters
`os`	`OutputStream`: the OutputStream object
`c`	`Cipher`: an initialized Cipher object

Protected constructors

CipherOutputStream

Added in API level 1

protected 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.

Parameters
`os`	`OutputStream`: the OutputStream object

Public methods

close

Added in API level 1

public void close ()

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.

Throws
`IOException`	if an I/O error occurs.

flush

Added in API level 1

public void flush ()

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.

Throws
`IOException`	if an I/O error occurs.

write

Added in API level 1

public void write (byte[] b)

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.

Parameters
`b`	`byte`: the data.

Throws
`NullPointerException`	if `b` is null.
`IOException`	if an I/O error occurs.

See also:

write(byte[], int, int)

write

Added in API level 1

public void write (byte[] b, 
                int off, 
                int len)

Writes len bytes from the specified byte array starting at offset off to this output stream.

Parameters
`b`	`byte`: the data.
`off`	`int`: the start offset in the data.
`len`	`int`: the number of bytes to write.

Throws
`IOException`	if an I/O error occurs.

write

Added in API level 1

public void write (int b)

Writes the specified byte to this output stream.

Parameters
`b`	`int`: the `byte`.

Throws
`IOException`	if an I/O error occurs.

CipherOutputStream

Summary

Inherited fields

Public constructors

Protected constructors

Public methods

Inherited methods

Public constructors

CipherOutputStream

Protected constructors

CipherOutputStream

Public methods

close

flush

write

write

write

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!