com.guardtime.ksi.hashing

Enum HashAlgorithm

java.lang.Object

java.lang.Enum<HashAlgorithm>

com.guardtime.ksi.hashing.HashAlgorithm

All Implemented Interfaces:

Serializable, Comparable<HashAlgorithm>

public enum HashAlgorithm
extends Enum<HashAlgorithm>

List of supported hash functions and some convenience functions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HashAlgorithm.Status Support status of the hash algorithm.

Enum Constant Summary

Enum Constants

Enum Constant and Description
RIPEMD_160
SHA1
SHA2_256
SHA2_384
SHA2_512
SHA3_224
SHA3_256
SHA3_384
SHA3_512
SM3

Method Summary

Modifier and Type	Method and Description
void	checkExpiration() Checks that the hash algorithm is NOT marked obsolete or deprecated.
static HashAlgorithm	getById(int id) Gets the hash algorithm by ID.
static HashAlgorithm	getByName(String name) Gets the hash algorithm by name.
Date	getDeprecatedSince()
int	getId() Gets ID for the DataHash.
static List<HashAlgorithm>	getImplementedHashAlgorithms() Returns the list of implemented algorithms.
int	getLength() Gets the length of the hash value for DataHash in octets.
String	getName() Gets the name of the algorithm for DataHash.
Date	getObsoleteSince()
HashAlgorithm.Status	getStatus() Gets the status of the algorithm for DataHash.
boolean	isDeprecated(Date givenDate)
static boolean	isHashAlgorithmId(int id) Checks if the input ID is the hash algorithm ID.
boolean	isImplemented()
boolean	isObsolete(Date givenDate)
static HashAlgorithm	valueOf(String name) Returns the enum constant of this type with the specified name.
static HashAlgorithm[]	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

SHA1

public static final HashAlgorithm SHA1

SHA2_256

public static final HashAlgorithm SHA2_256

RIPEMD_160

public static final HashAlgorithm RIPEMD_160

SHA2_384

public static final HashAlgorithm SHA2_384

SHA2_512

public static final HashAlgorithm SHA2_512

SHA3_224

public static final HashAlgorithm SHA3_224

SHA3_256

public static final HashAlgorithm SHA3_256

SHA3_384

public static final HashAlgorithm SHA3_384

SHA3_512

public static final HashAlgorithm SHA3_512

SM3

public static final HashAlgorithm SM3

Method Detail

values

public static HashAlgorithm[] 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 (HashAlgorithm c : HashAlgorithm.values())
    System.out.println(c);

Returns:

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

valueOf

public static HashAlgorithm 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

getById

public static HashAlgorithm getById(int id)

Gets the hash algorithm by ID.

Parameters:

id - one-byte hash function identifier.

Returns:

HashAlgorithm, if a match is found, otherwise null.

Throws:

IllegalArgumentException - if algorithm is unknown.

isHashAlgorithmId

public static boolean isHashAlgorithmId(int id)

Checks if the input ID is the hash algorithm ID.

Parameters:

id - one-byte hash function identifier.

Returns:

True, if input ID equals the hash algorithm ID.

getByName

public static HashAlgorithm getByName(String name)

Gets the hash algorithm by name.

Parameters:

name - name of the algorithm to look for.

Returns:

HashAlgorithm, if a match is found, otherwise null.

getImplementedHashAlgorithms

public static List<HashAlgorithm> getImplementedHashAlgorithms()

Returns the list of implemented algorithms.

Returns:

List of implemented algorithms with status HashAlgorithm.Status.NORMAL or HashAlgorithm.Status.NOT_TRUSTED

getId

public int getId()

Gets ID for the DataHash.

Returns:

DataHash identifier.

getLength

public int getLength()

Gets the length of the hash value for DataHash in octets.

Returns:

Length of the hash value in octets.

getName

public String getName()

Gets the name of the algorithm for DataHash.

Returns:

Name of the algorithm.

getStatus

public HashAlgorithm.Status getStatus()

Gets the status of the algorithm for DataHash.

Returns:

Status of the algorithm.

getDeprecatedSince

public Date getDeprecatedSince()

Returns:

The date since when the algorithm is set to be deprecated.

getObsoleteSince

public Date getObsoleteSince()

Returns:

The date since when the algorithm is set to be obsolete.

isImplemented

public boolean isImplemented()

Returns:

True, if hash algorithm is implemented.

isDeprecated

public boolean isDeprecated(Date givenDate)

Parameters:

givenDate - date to check against the hash algorithm deprecation date.

Returns:

True, if the given date is after the hash algorithm deprecation date.

isObsolete

public boolean isObsolete(Date givenDate)

Parameters:

givenDate - date to check against the date since when the algorithm is considered obsolete.

Returns:

True, if the given date is after the hash algorithm obsoletion date.

checkExpiration

public void checkExpiration()

Checks that the hash algorithm is NOT marked obsolete or deprecated.