org.butor.checksum

Enum CommonChecksumFunction

java.lang.Object

java.lang.Enum<CommonChecksumFunction>

org.butor.checksum.CommonChecksumFunction

All Implemented Interfaces:

Serializable, Comparable<CommonChecksumFunction>, ChecksumFunction

public enum CommonChecksumFunction
extends Enum<CommonChecksumFunction>
implements ChecksumFunction

The checksum is generated like this : CHECKSUM = SALT+MAXTIME+HASH where SALT = 8 bytes of random positive Long JSON = JSON(Sorted Map<String,Object> representing the object) MAXTIME = Long representing the maximum valid period for this checksum, (optional) HASH = HASHFUNCTION(JSON+SALT+MAXTIME) (MAXTIME is Long.MAX_VALUE if no TTL)

Author:

tbussier

Enum Constant Summary

Enum Constants

Enum Constant and Description
MD5
SHA1
SHA256
SHA512

Method Summary

Modifier and Type	Method and Description
String	generateChecksum(String object) Generate the checksum of an object
String	generateChecksumWithTTL(String object, long duration, TimeUnit unit)
boolean	validateChecksum(String object, String checksum)
static CommonChecksumFunction	valueOf(String name) Returns the enum constant of this type with the specified name.
static CommonChecksumFunction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MD5

public static final CommonChecksumFunction MD5

SHA1

public static final CommonChecksumFunction SHA1

SHA256

public static final CommonChecksumFunction SHA256

SHA512

public static final CommonChecksumFunction SHA512

Method Detail

values

public static CommonChecksumFunction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CommonChecksumFunction c : CommonChecksumFunction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CommonChecksumFunction valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

generateChecksum

public String generateChecksum(String object)

Description copied from interface: ChecksumFunction

Generate the checksum of an object

Specified by:

generateChecksum in interface ChecksumFunction

Parameters:

object - a String

Returns:

the checksum

validateChecksum

public boolean validateChecksum(String object,
                                String checksum)

Specified by:

validateChecksum in interface ChecksumFunction

Parameters:

object - that we want to validate the checksum on

checksum - to validate

Returns:

true if the checksum is good

generateChecksumWithTTL

public String generateChecksumWithTTL(String object,
                                      long duration,
                                      TimeUnit unit)

Specified by:

generateChecksumWithTTL in interface ChecksumFunction