DigestInputStream (Java Platform SE 6) (original) (raw)

java.security

Class DigestInputStream

java.lang.Object java.io.InputStream java.io.FilterInputStream java.security.DigestInputStream

All Implemented Interfaces:

Closeable

public class DigestInputStream

extends FilterInputStream

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 input stream'sread methods.

It is possible to turn this stream on or off (seeon). When it is on, a call to one of theread 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.

Note that digest objects can compute only one digest (seeMessageDigest), so that in order to compute intermediate digests, a caller should retain a handle onto the digest object, and clone it for each digest to be computed, leaving the orginal digest untouched.

See Also:

MessageDigest, DigestOutputStream

digest

protected MessageDigest digest

The message digest associated with this stream.

DigestInputStream

public DigestInputStream(InputStream stream, MessageDigest digest)

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

Parameters:

stream - the input stream.

digest - the message digest to associate with this stream.

getMessageDigest

public MessageDigest getMessageDigest()

Returns the message digest associated with this stream.

Returns:

the message digest associated with this stream.

See Also:

setMessageDigest(java.security.MessageDigest)

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()

read

public int read() throws IOException

Reads a byte, and updates the message digest (if the digest function is on). That is, this method reads a byte from the input stream, blocking until the byte is actually read. If the digest function is on (see on), this method will then call update on the message digest associated with this stream, passing it the byte read.

Overrides:

[read](../../java/io/FilterInputStream.html#read%28%29) in class [FilterInputStream](../../java/io/FilterInputStream.html "class in java.io")

Returns:

the byte read.

Throws:

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

See Also:

MessageDigest.update(byte)

read

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

Reads into a byte array, and updates the message digest (if the digest function is on). That is, this method reads up tolen bytes from the input stream into the arrayb, starting at offset off. This method blocks until the data is actually read. If the digest function is on (seeon), this method will then call update on the message digest associated with this stream, passing it the data.

Overrides:

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

Parameters:

b - the array into which the data is read.

off - the starting offset into b of where the data should be placed.

len - the maximum number of bytes to be read from the input stream into b, starting at offset off.

Returns:

the actual number of bytes read. This is less thanlen if the end of the stream is reached prior to reading len bytes. -1 is returned if no bytes were read because the end of the stream had already been reached when the call was made.

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 read 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 input 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 SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.