DigestOutputStream (Java 2 Platform SE 5.0) (original) (raw)

java.security

Class DigestOutputStream

java.lang.Object extended by java.io.OutputStream java.io.FilterOutputStream java.security.DigestOutputStream

All Implemented Interfaces:

public class DigestOutputStream

A transparent stream that updates the associated message digest using the bits going through the stream.

To complete the message digest computation, call one of thedigest methods on the associated message digest after your calls to one of this digest ouput stream'swrite methods.

It is possible to turn this stream on or off (seeon). When it is on, a call to one of thewrite methods results in an update on the message digest. But when it is off, the message digest is not updated. The default is for the stream to be on.

See Also:

MessageDigest, DigestInputStream

Field Summary
protected MessageDigest	digest The message digest associated with this stream.

Fields inherited from class java.io.FilterOutputStream
out

Constructor Summary
[DigestOutputStream](../../java/security/DigestOutputStream.html#DigestOutputStream%28java.io.OutputStream, java.security.MessageDigest%29)(OutputStream stream,MessageDigest digest) Creates a digest output stream, using the specified output stream and message digest.

Method Summary
MessageDigest	getMessageDigest() Returns the message digest associated with this stream.
void	on(boolean on) Turns the digest function on or off.
void	setMessageDigest(MessageDigest digest) Associates the specified message digest with this stream.
String	toString() Prints a string representation of this digest output stream and its associated message digest object.
void	[write](../../java/security/DigestOutputStream.html#write%28byte[], int, int%29)(byte[] b, int off, int len) Updates the message digest (if the digest function is on) using the specified subarray, and in any case writes the subarray to the output stream.
void	write(int b) Updates the message digest (if the digest function is on) using the specified byte, and in any case writes the byte to the output stream.

Methods inherited from class java.io.FilterOutputStream
close, flush, write

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Field Detail

digest

protected MessageDigest digest

The message digest associated with this stream.

Constructor Detail

DigestOutputStream

public DigestOutputStream(OutputStream stream, MessageDigest digest)

Creates a digest output stream, using the specified output stream and message digest.

Parameters:

stream - the output stream.

digest - the message digest to associate with this stream.

Method Detail

getMessageDigest

public MessageDigest getMessageDigest()

Returns the message digest associated with this stream.

Returns:

the message digest associated with this stream.

setMessageDigest

public void setMessageDigest(MessageDigest digest)

Associates the specified message digest with this stream.

Parameters:

digest - the message digest to be associated with this stream.

See Also:

getMessageDigest()

write

public void write(int b) throws IOException

Updates the message digest (if the digest function is on) using the specified byte, and in any case writes the byte to the output stream. That is, if the digest function is on (see on), this method callsupdate on the message digest associated with this stream, passing it the byte b. This method then writes the byte to the output stream, blocking until the byte is actually written.

Overrides:

[write](../../java/io/FilterOutputStream.html#write%28int%29) in class [FilterOutputStream](../../java/io/FilterOutputStream.html "class in java.io")

Parameters:

b - the byte to be used for updating and writing to the output stream.

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

See Also:

MessageDigest.update(byte)

write

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

Updates the message digest (if the digest function is on) using the specified subarray, and in any case writes the subarray to the output stream. That is, if the digest function is on (seeon), this method calls update on the message digest associated with this stream, passing it the subarray specifications. This method then writes the subarray bytes to the output stream, blocking until the bytes are actually written.

Overrides:

[write](../../java/io/FilterOutputStream.html#write%28byte[], int, int%29) in class [FilterOutputStream](../../java/io/FilterOutputStream.html "class in java.io")

Parameters:

b - the array containing the subarray to be used for updating and writing to the output stream.

off - the offset into b of the first byte to be updated and written.

len - the number of bytes of data to be updated and written from b, starting at offset off.

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

See Also:

[MessageDigest.update(byte[], int, int)](../../java/security/MessageDigest.html#update%28byte[], int, int%29)

on

public void on(boolean on)

Turns the digest function on or off. The default is on. When it is on, a call to one of the write methods results in an update on the message digest. But when it is off, the message digest is not updated.

Parameters:

on - true to turn the digest function on, false to turn it off.

toString

public String toString()

Prints a string representation of this digest output stream and its associated message digest object.

Overrides:

[toString](../../java/lang/Object.html#toString%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Returns:

a string representation of the object.

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.