javax.crypto

Class CipherOutputStream

Implemented Interfaces:
Closeable, Flushable

public class CipherOutputStream
extends FilterOutputStream

A filtered output stream that transforms data written to it with a Cipher before sending it to the underlying output stream.

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

CipherOutputStream(OutputStream out)
Create a cipher output stream with no cipher.
CipherOutputStream(OutputStream out, Cipher cipher)
Create a new cipher output stream.

Method Summary

void
close()
Close this output stream, and the sink output stream.
void
flush()
Flush any pending output.
void
write(byte[] buf)
Write a byte array to the output stream.
void
write(byte[] buf, int off, int len)
Write a portion of a byte array to the output stream.
void
write(int b)
Write a single byte to the output stream.

Methods inherited from class java.io.FilterOutputStream

close, flush, write, write, write

Methods inherited from class java.io.OutputStream

close, flush, write, write, write

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CipherOutputStream

protected CipherOutputStream(OutputStream out)
Create a cipher output stream with no cipher.
Parameters:
out - The sink for transformed data.

CipherOutputStream

public CipherOutputStream(OutputStream out,
                          Cipher cipher)
Create a new cipher output stream. The cipher argument must have already been initialized.
Parameters:
out - The sink for transformed data.
cipher - The cipher to transform data with.

Method Details

close

public void close()
            throws IOException
Close this output stream, and the sink output stream.

This method will first invoke the Cipher.doFinal() method of the underlying Cipher, and writes the output of that method to the sink output stream.

Specified by:
close in interface Closeable
Overrides:
close in interface FilterOutputStream
Throws:
IOException - If an I/O error occurs, or if an error is caused by finalizing the transformation.

flush

public void flush()
            throws IOException
Flush any pending output.
Specified by:
flush in interface Flushable
Overrides:
flush in interface FilterOutputStream
Throws:
IOException - If an I/O error occurs.

write

public void write(byte[] buf)
            throws IOException
Write a byte array to the output stream.
Overrides:
write in interface FilterOutputStream
Parameters:
buf - The next bytes.
Throws:
IOException - If an I/O error occurs, or if the underlying cipher is not in the correct state to transform data.

write

public void write(byte[] buf,
                  int off,
                  int len)
            throws IOException
Write a portion of a byte array to the output stream.
Overrides:
write in interface FilterOutputStream
Parameters:
buf - The next bytes.
off - The offset in the byte array to start.
len - The number of bytes to write.
Throws:
IOException - If an I/O error occurs, or if the underlying cipher is not in the correct state to transform data.

write

public void write(int b)
            throws IOException
Write a single byte to the output stream.
Overrides:
write in interface FilterOutputStream
Parameters:
b - The next byte.
Throws:
IOException - If an I/O error occurs, or if the underlying cipher is not in the correct state to transform data.

CipherOutputStream.java -- Filters output through a cipher. Copyright (C) 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.