azkaban.utils

Enum HashUtils

java.lang.Object

java.lang.Enum<HashUtils>

azkaban.utils.HashUtils

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HashUtils>

public enum HashUtils
extends java.lang.Enum<HashUtils>

Helper class that can find a hash for a file or string.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MD5
SHA1

Method Summary

Modifier and Type	Method and Description
static java.lang.String	bytesHashToString(byte[] a)
byte[]	getHashBytes(java.io.File file)
byte[]	getHashBytes(java.lang.String str)
java.lang.String	getHashStr(java.io.File file)
java.lang.String	getHashStr(java.lang.String str)
java.lang.String	getName()
static boolean	isSameHash(byte[] a, byte[] b)
static boolean	isSameHash(java.lang.String a, byte[] b)
java.lang.String	sanitizeHashStr(java.lang.String raw) Validates and sanitizes a hash string.
static byte[]	stringHashToBytes(java.lang.String a)
static HashUtils	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HashUtils[]	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 HashUtils MD5

SHA1

public static final HashUtils SHA1

Method Detail

values

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

Returns:

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

valueOf

public static HashUtils valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getName

public java.lang.String getName()

getHashStr

public java.lang.String getHashStr(java.lang.String str)

getHashBytes

public byte[] getHashBytes(java.lang.String str)

getHashStr

public java.lang.String getHashStr(java.io.File file)
                            throws java.io.IOException

Throws:

java.io.IOException

getHashBytes

public byte[] getHashBytes(java.io.File file)
                    throws java.io.IOException

Throws:

java.io.IOException

sanitizeHashStr

public java.lang.String sanitizeHashStr(java.lang.String raw)
                                 throws InvalidHashException

Validates and sanitizes a hash string. Ensures the hash does not include any non-alphanumeric characters and ensures it is the correct length for its type. If the hash is valid, a lowercase version is returned.

Parameters:

raw - raw hash string

Returns:

lowercase raw hash string

Throws:

InvalidHashException - if the hash is invalid for any of the reasons described above.

isSameHash

public static boolean isSameHash(java.lang.String a,
                                 byte[] b)
                          throws org.apache.commons.codec.DecoderException

Throws:

org.apache.commons.codec.DecoderException

isSameHash

public static boolean isSameHash(byte[] a,
                                 byte[] b)

stringHashToBytes

public static byte[] stringHashToBytes(java.lang.String a)
                                throws org.apache.commons.codec.DecoderException

Throws:

org.apache.commons.codec.DecoderException

bytesHashToString

public static java.lang.String bytesHashToString(byte[] a)