Class MessageDigestCalculatingInputStream.Builder

java.lang.Object

org.apache.commons.io.build.AbstractSupplier<ObservableInputStream, MessageDigestCalculatingInputStream.Builder>

org.apache.commons.io.build.AbstractOriginSupplier<ObservableInputStream, MessageDigestCalculatingInputStream.Builder>

org.apache.commons.io.build.AbstractStreamBuilder<ObservableInputStream, MessageDigestCalculatingInputStream.Builder>

org.apache.commons.io.input.ProxyInputStream.AbstractBuilder<ObservableInputStream, MessageDigestCalculatingInputStream.Builder>

org.apache.commons.io.input.ObservableInputStream.AbstractBuilder<MessageDigestCalculatingInputStream.Builder>

org.apache.commons.io.input.MessageDigestCalculatingInputStream.Builder

All Implemented Interfaces:

IOSupplier<ObservableInputStream>

Enclosing class:

MessageDigestCalculatingInputStream

public static class MessageDigestCalculatingInputStream.Builder
extends ObservableInputStream.AbstractBuilder<MessageDigestCalculatingInputStream.Builder>

Builds a new MessageDigestCalculatingInputStream.

For example:

MessageDigestCalculatingInputStream s = MessageDigestCalculatingInputStream.builder()
  .setPath(path)
  .setMessageDigest("SHA-512")
  .get();

The MD5 cryptographic algorithm is weak and should not be used.

Since:

2.12.0

See Also:

• get()

Constructor Summary

Constructors

Constructor	Description
Builder()	Constructs a new builder of MessageDigestCalculatingInputStream.

Method Summary

Modifier and Type	Method	Description
MessageDigestCalculatingInputStream	get()	Builds a new MessageDigestCalculatingInputStream.
void	setMessageDigest(String algorithm)	Sets the name of the name of the message digest algorithm.
void	setMessageDigest(MessageDigest messageDigest)	Sets the message digest.

Methods inherited from class ObservableInputStream.AbstractBuilder

setObservers

Methods inherited from class ProxyInputStream.AbstractBuilder

getAfterRead, setAfterRead

Methods inherited from class AbstractStreamBuilder

getBufferSize, getBufferSizeDefault, getChannel, getCharSequence, getCharset, getCharsetDefault, getFile, getInputStream, getOpenOptions, getOutputStream, getPath, getRandomAccessFile, getReader, getWriter, setBufferSize, setBufferSize, setBufferSizeChecker, setBufferSizeDefault, setBufferSizeMax, setCharset, setCharset, setCharsetDefault, setOpenOptions

Methods inherited from class AbstractOriginSupplier

checkOrigin, getOrigin, hasOrigin, newByteArrayOrigin, newChannelOrigin, newCharSequenceOrigin, newFileOrigin, newFileOrigin, newInputStreamOrigin, newOutputStreamOrigin, newPathOrigin, newPathOrigin, newRandomAccessFileOrigin, newRandomAccessFileOrigin, newReaderOrigin, newURIOrigin, newWriterOrigin, setByteArray, setChannel, setCharSequence, setFile, setFile, setInputStream, setOrigin, setOutputStream, setPath, setPath, setRandomAccessFile, setRandomAccessFile, setReader, setURI, setWriter

Methods inherited from class AbstractSupplier

asThis

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface IOSupplier

asSupplier, getUnchecked

Constructor Details

Builder

public Builder()

Constructs a new builder of MessageDigestCalculatingInputStream.

The default for compatibility is the MD5 cryptographic algorithm which is weak and should not be used.

Method Details

get

public MessageDigestCalculatingInputStream get()
                                        throws IOException

Builds a new MessageDigestCalculatingInputStream.

You must set an aspect that supports AbstractStreamBuilder.getInputStream(), otherwise, this method throws an exception.

This builder uses the following aspects:

• AbstractStreamBuilder.getInputStream() gets the target aspect.
• MessageDigest

Returns:

a new instance.

Throws:

NullPointerException - if messageDigest is null.

IllegalStateException - if the origin is null.

UnsupportedOperationException - if the origin cannot be converted to an InputStream.

IOException - if an I/O error occurs converting to an InputStream using AbstractStreamBuilder.getInputStream().

See Also:

• AbstractStreamBuilder.getInputStream()
• IOSupplier.getUnchecked()

setMessageDigest

public void setMessageDigest(MessageDigest messageDigest)

Sets the message digest.

The MD5 cryptographic algorithm is weak and should not be used.

Parameters:

messageDigest - the message digest.

setMessageDigest

public void setMessageDigest(String algorithm)
                      throws NoSuchAlgorithmException

Sets the name of the name of the message digest algorithm.

The MD5 cryptographic algorithm is weak and should not be used.

Parameters:

algorithm - the name of the algorithm. See the MessageDigest section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.

Throws:

NoSuchAlgorithmException - if no Provider supports a MessageDigestSpi implementation for the specified algorithm.