org.cryptacular.bean

Class EncodingHashBean

java.lang.Object

org.cryptacular.bean.AbstractHashBean

org.cryptacular.bean.EncodingHashBean

All Implemented Interfaces:

HashBean<String>

public class EncodingHashBean
extends AbstractHashBean
implements HashBean<String>

Computes a hash in an encoded format, e.g. hex, base64.

Author:

Middleware Services

Constructor Summary

Constructors

Constructor and Description
EncodingHashBean() Creates a new instance.
EncodingHashBean(Spec<Codec> codecSpec, Spec<org.bouncycastle.crypto.Digest> digestSpec, int iterations) Creates a new instance by specifying all properties.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	compare(String hash, Object... data) Compares a known hash value with the hash of the given data.
Spec<Codec>	getCodecSpec()
String	hash(Object... data) Hashes the given data.
void	setCodecSpec(Spec<Codec> codecSpec) Sets the codec specification that determines the encoding applied to the hash output bytes.

Methods inherited from class org.cryptacular.bean.AbstractHashBean

compareInternal, getDigestSpec, getIterations, hashInternal, setDigestSpec, setIterations

Methods inherited from class java.lang.Object

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

Constructor Detail

EncodingHashBean

public EncodingHashBean()

Creates a new instance.

EncodingHashBean

public EncodingHashBean(Spec<Codec> codecSpec,
                Spec<org.bouncycastle.crypto.Digest> digestSpec,
                int iterations)

Creates a new instance by specifying all properties.

Parameters:

codecSpec - Digest specification.

digestSpec - Digest specification.

iterations - Number of hash rounds.

Method Detail

getCodecSpec

public Spec<Codec> getCodecSpec()

Returns:

Codec specification that determines the encoding applied to the hash output bytes.

setCodecSpec

public void setCodecSpec(Spec<Codec> codecSpec)

Sets the codec specification that determines the encoding applied to the hash output bytes.

Parameters:

codecSpec - Codec specification, e.g. CodecSpec.BASE64, CodecSpec.HEX.

hash

public String hash(Object... data)

Hashes the given data.

Specified by:

hash in interface HashBean<String>

Parameters:

data - Data to hash. Callers should expect support for at least the following types: byte[], CharSequence, InputStream, and Resource. Unless otherwise noted, character data is processed in the UTF-8 character set; if another character set is desired, the caller should convert to byte[] and provide the resulting bytes.

Returns:

Digest output.

compare

public boolean compare(String hash,
              Object... data)

Compares a known hash value with the hash of the given data.

Specified by:

compare in interface HashBean<String>

Parameters:

hash - Known encoded hash value. If the length of the hash bytes after decoding is greater than the length of the digest output, anything beyond the digest length is considered salt data that is hashed after the input data.

data - Data to hash.

Returns:

True if the hashed data matches the given hash, false otherwise.