gnu.javax.crypto.mac

Class MacOutputStream

Implemented Interfaces:
AutoCloseable, Closeable, Flushable

public class MacOutputStream
extends FilterOutputStream

A filtering output stream that computes a MAC (message authentication code) over all data written to the stream.

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

MacOutputStream(OutputStream out, IMac mac)
Creates a new MacOutputStream.

Method Summary

IMac
getMac()
Returns the MAC this stream is updating.
void
on(boolean flag)
Turns the digesting state on or off.
void
setMac(IMac mac)
Sets the MAC this stream is updating, which must have already been initialized.
void
write(byte[] buf, int off, int len)
This method calls the write(int) method len times for all bytes from the array buf starting at index offset.
void
write(int b)
This method writes a single byte of output to the underlying OutputStream.

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

MacOutputStream

public MacOutputStream(OutputStream out,
                       IMac mac)
Creates a new MacOutputStream. The stream is initially set to digest data written, the mac argument must have already been initialized, and the mac argument is not cloned.
Parameters:
out - The underlying output stream.
mac - The mac instance to use.

Method Details

getMac

public IMac getMac()
Returns the MAC this stream is updating.
Returns:
The MAC.

on

public void on(boolean flag)
Turns the digesting state on or off. When off, the MAC will not be updated when data is written to the stream.
Parameters:
flag - The new digesting state.

setMac

public void setMac(IMac mac)
Sets the MAC this stream is updating, which must have already been initialized. The argument is not cloned by this method.
Parameters:
mac - The non-null new MAC.
Throws:
NullPointerException - If the argument is null.

write

public void write(byte[] buf,
                  int off,
                  int len)
            throws IOException
This method calls the write(int) method len times for all bytes from the array buf starting at index offset. Subclasses should overwrite this method to get a more efficient implementation.
Overrides:
write in interface FilterOutputStream
Parameters:
buf - The byte array to write bytes from
len - The number of bytes to write
Throws:
IOException - If an error occurs

write

public void write(int b)
            throws IOException
This method writes a single byte of output to the underlying OutputStream.
Overrides:
write in interface FilterOutputStream
Parameters:
b - The byte to write, passed as an int.
Throws:
IOException - If an error occurs

MacOutputStream.java -- Copyright (C) 2003, 2006 Free Software Foundation, Inc. This file is a 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 of the License, 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; if not, write to the Free Software Foundation, Inc., 51 Franklin St, 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.