org.dataone.service.types.v1.util

Class ChecksumUtil

java.lang.Object

org.dataone.service.types.v1.util.ChecksumUtil

public class ChecksumUtil
extends Object

Author:

waltz

Constructor Summary

Constructors

Constructor and Description
ChecksumUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	areChecksumsEqual(Checksum checksum1, Checksum checksum2) Returns true if and only if checksum1 and checksum2 are equal: Values are equal, algorithms are equal.
static Checksum	checksum(byte[] object, String algorithm) produce a checksum for the given byte array
static Checksum	checksum(InputStream is, String checksumAlgorithm) return a Checksum based on the input of the stream A useful technique when creating systemMetadata is to wrap the the inputStream in an org.apache.commons.io.input.CountingInputStream, to get the length of the content from the stream (after calling this method).

Methods inherited from class java.lang.Object

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

Constructor Detail

ChecksumUtil

public ChecksumUtil()

Method Detail

checksum

public static Checksum checksum(InputStream is,
                String checksumAlgorithm)
                         throws NoSuchAlgorithmException,
                                IOException

return a Checksum based on the input of the stream A useful technique when creating systemMetadata is to wrap the the inputStream in an org.apache.commons.io.input.CountingInputStream, to get the length of the content from the stream (after calling this method). This saves you from having to re-read or turn the inputStream into a byte[].

Parameters:

is -

algorithmAlgorithm -

Returns:

Throws:

NoSuchAlgorithmException

IOException

checksum

public static Checksum checksum(byte[] object,
                String algorithm)
                         throws NoSuchAlgorithmException

produce a checksum for the given byte array

Throws:

NoSuchAlgorithmException

areChecksumsEqual

public static boolean areChecksumsEqual(Checksum checksum1,
                        Checksum checksum2)

Returns true if and only if checksum1 and checksum2 are equal: Values are equal, algorithms are equal. Null objects or properties of checksum objects will return false

Parameters:

checksum1 -

checksum2 -

Returns: