com.captainalm.lib.stdcrypt.digest

Class DigestProvider

java.lang.Object

com.captainalm.lib.stdcrypt.digest.DigestProvider

All Implemented Interfaces:

java.lang.Cloneable

public final class DigestProvider
extends java.lang.Object
implements java.lang.Cloneable

This class allows for obtaining DigestInputStream and DigestOutputStream using the specified algorithm.

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
DigestProvider(java.lang.String algorithm) Constructs a new digest provider with the specified algorithm.
DigestProvider(java.lang.String algorithm, boolean shouldClone) Constructs a new digest provider with the specified algorithm and if the digest should be cloned for created streams.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clones this object.
boolean	digestClonedForStreams() Gets whether MessageDigests are cloned for streams.
java.lang.String	getAlgorithm() Gets the algorithm of this provider.
java.security.DigestInputStream	getDigestInputStream(java.io.InputStream inputStream) Gets the digest input stream for this class.
byte[]	getDigestOf(byte[] dataIn) Gets the digest of the specified array.
java.security.DigestOutputStream	getDigestOutputStream(java.io.OutputStream outputStream) Gets the digest output stream for this class.
int	getLength() Gets the length of the algorithm in bytes.
static DigestProvider	getMD5Instance(boolean shouldClone) Gets the instance for MD5.
static DigestProvider	getSHA1Instance(boolean shouldClone) Gets the instance for SHA-1.
static DigestProvider	getSHA256Instance(boolean shouldClone) Gets the instance for SHA-256.
static DigestProvider	getSHA512Instance(boolean shouldClone) Gets the instance for SHA-512.

Methods inherited from class java.lang.Object

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

Constructor Detail

DigestProvider

public DigestProvider(java.lang.String algorithm)
               throws java.security.NoSuchAlgorithmException

Constructs a new digest provider with the specified algorithm.

Parameters:

algorithm - The algorithm of the digest.

Throws:

java.lang.NullPointerException - algorithm is null.

java.security.NoSuchAlgorithmException - The algorithm does not exist.

DigestProvider

public DigestProvider(java.lang.String algorithm,
                      boolean shouldClone)
               throws java.security.NoSuchAlgorithmException

Constructs a new digest provider with the specified algorithm and if the digest should be cloned for created streams.

Parameters:

algorithm - The algorithm of the digest.

shouldClone - The digest should be cloned when creating streams.

Throws:

java.lang.NullPointerException - algorithm is null.

java.security.NoSuchAlgorithmException - The algorithm does not exist.

Method Detail

getDigestInputStream

public java.security.DigestInputStream getDigestInputStream(java.io.InputStream inputStream)

Gets the digest input stream for this class. NOTE: If using any other streams on this digest, and digestClonedForStreams() is false, The current calculated digest for this stream changes for all the other streams.

Parameters:

inputStream - The input stream to get the digest for.

Returns:

The digest input stream.

getDigestOutputStream

public java.security.DigestOutputStream getDigestOutputStream(java.io.OutputStream outputStream)

Gets the digest output stream for this class. NOTE: If using any other streams on this digest, and digestClonedForStreams() is false, The current calculated digest for this stream changes for all the other streams.

Parameters:

outputStream - The output stream to get the digest for.

Returns:

The digest output stream.

getAlgorithm

public java.lang.String getAlgorithm()

Gets the algorithm of this provider.

Returns:

The algorithm.

getLength

public int getLength()

Gets the length of the algorithm in bytes.

Returns:

The length in bytes.

digestClonedForStreams

public boolean digestClonedForStreams()

Gets whether MessageDigests are cloned for streams.

Returns:

If the digests are cloned.

getDigestOf

public byte[] getDigestOf(byte[] dataIn)

Gets the digest of the specified array. NOTE: If using any streams on this digest, and digestClonedForStreams() is false, The current calculated digest for all these streams are reset.

Parameters:

dataIn - The byte array to find the digest of.

Returns:

The digest array.

clone

public java.lang.Object clone()

Clones this object.

Overrides:

clone in class java.lang.Object

Returns:

The clone of this object.

getMD5Instance

public static DigestProvider getMD5Instance(boolean shouldClone)

Gets the instance for MD5.

Parameters:

shouldClone - The digest should be cloned when creating streams.

Returns:

The DigestProvider for MD5 or null.

getSHA1Instance

public static DigestProvider getSHA1Instance(boolean shouldClone)

Gets the instance for SHA-1.

Parameters:

shouldClone - The digest should be cloned when creating streams.

Returns:

The DigestProvider for SHA-1 or null.

getSHA256Instance

public static DigestProvider getSHA256Instance(boolean shouldClone)

Gets the instance for SHA-256.

Parameters:

shouldClone - The digest should be cloned when creating streams.

Returns:

The DigestProvider for SHA-256 or null.

getSHA512Instance

public static DigestProvider getSHA512Instance(boolean shouldClone)

Gets the instance for SHA-512.

Parameters:

shouldClone - The digest should be cloned when creating streams.

Returns:

The DigestProvider for SHA-512 or null.