org.apache.commons.io.input
Class MessageDigestCalculatingInputStream
- java.lang.Object
-
- java.io.InputStream
-
- java.io.FilterInputStream
-
- org.apache.commons.io.input.ProxyInputStream
-
- org.apache.commons.io.input.ObservableInputStream
-
- org.apache.commons.io.input.MessageDigestCalculatingInputStream
-
- All Implemented Interfaces:
- Closeable, AutoCloseable
public class MessageDigestCalculatingInputStream extends ObservableInputStream
This class is an example for using anObservableInputStream. It creates its ownObservableInputStream.Observer, which calculates a checksum using a MessageDigest, for example an MD5 sum. Note: NeitherObservableInputStream, norMessageDigest, are thread safe. So isMessageDigestCalculatingInputStream.
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classMessageDigestCalculatingInputStream.MessageDigestMaintainingObserverMaintains the message digest.Nested classes/interfaces inherited from class org.apache.commons.io.input.ObservableInputStream
ObservableInputStream.Observer
Field Summary
Fields inherited from class java.io.FilterInputStream
in
Constructor Summary
Constructors Constructor and Description MessageDigestCalculatingInputStream(InputStream inputStream)Creates a new instance, which calculates a signature on the given stream, using aMessageDigestwith the "MD5" algorithm.MessageDigestCalculatingInputStream(InputStream inputStream, MessageDigest messageDigest)Creates a new instance, which calculates a signature on the given stream, using the givenMessageDigest.MessageDigestCalculatingInputStream(InputStream inputStream, String algorithm)Creates a new instance, which calculates a signature on the given stream, using aMessageDigestwith the given algorithm.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description MessageDigestgetMessageDigest()Returns theMessageDigest, which is being used for generating the checksum.Methods inherited from class org.apache.commons.io.input.ObservableInputStream
add, close, consume, getObservers, noteClosed, noteDataByte, noteDataBytes, noteError, noteFinished, read, read, read, remove, removeAllObservers
Methods inherited from class org.apache.commons.io.input.ProxyInputStream
afterRead, available, beforeRead, handleIOException, mark, markSupported, reset, skip
-
Constructor Detail
MessageDigestCalculatingInputStream
public MessageDigestCalculatingInputStream(InputStream inputStream, MessageDigest messageDigest)
Creates a new instance, which calculates a signature on the given stream, using the givenMessageDigest.- Parameters:
-
inputStream- the stream to calculate the message digest for -
messageDigest- the message digest to use
MessageDigestCalculatingInputStream
public MessageDigestCalculatingInputStream(InputStream inputStream, String algorithm) throws NoSuchAlgorithmException
Creates a new instance, which calculates a signature on the given stream, using aMessageDigestwith the given algorithm.- Parameters:
-
inputStream- the stream to calculate the message digest for -
algorithm- the name of the algorithm to use - Throws:
-
NoSuchAlgorithmException- if no Provider supports a MessageDigestSpi implementation for the specified algorithm.
MessageDigestCalculatingInputStream
public MessageDigestCalculatingInputStream(InputStream inputStream) throws NoSuchAlgorithmException
Creates a new instance, which calculates a signature on the given stream, using aMessageDigestwith the "MD5" algorithm.- Parameters:
-
inputStream- the stream to calculate the message digest for - Throws:
-
NoSuchAlgorithmException- if no Provider supports a MessageDigestSpi implementation for the specified algorithm.
Method Detail
getMessageDigest
public MessageDigest getMessageDigest()
Returns theMessageDigest, which is being used for generating the checksum. Note: The checksum will only reflect the data, which has been read so far. This is probably not, what you expect. Make sure, that the complete data has been read, if that is what you want. The easiest way to do so is by invokingObservableInputStream.consume().- Returns:
- the message digest used
Copyright © 2002–2021 The Apache Software Foundation. All rights reserved.