org.kocakosm.pitaya.security

Interface Digest

public interface Digest

A digest engine. Note that implementations of this interface are not meant to be thread-safe.

Author:

Osman KOCAK

See Also:

Digests

Method Summary

Modifier and Type	Method and Description
byte[]	digest() Completes the hash computation.
byte[]	digest(byte... input) Performs a final update on the digest using the specified array of bytes, then completes the digest computation.
byte[]	digest(byte[] input, int off, int len) Performs a final update on the digest using the specified data bytes, then completes the digest computation.
int	length() Returns the digest's length (in bytes).
Digest	reset() Resets the engine.
Digest	update(byte... input) Updates the digest using the specified array of bytes.
Digest	update(byte input) Updates the digest using the given byte.
Digest	update(byte[] input, int off, int len) Updates the digest using the specified number of bytes from the given array of bytes, starting at the specified offset.

Method Detail

length

int length()

Returns the digest's length (in bytes).

Returns:

the digest's length (in bytes).

reset

Digest reset()

Resets the engine.

Returns:

this object.

update

Digest update(byte input)

Updates the digest using the given byte.

Parameters:

input - the byte with which to update the digest.

Returns:

this object.

update

Digest update(byte... input)

Updates the digest using the specified array of bytes.

Parameters:

input - the array of bytes with which to update the digest.

Returns:

this object.

Throws:

NullPointerException - if input is null.

update

Digest update(byte[] input,
              int off,
              int len)

Updates the digest using the specified number of bytes from the given array of bytes, starting at the specified offset.

Parameters:

input - the array of bytes.

off - the offset to start from in the array of bytes, inclusive.

len - the number of bytes to use, starting at off.

Returns:

this object.

Throws:

NullPointerException - if input is null.

IndexOutOfBoundsException - if off is negative or if off + len is greater than input's length.

digest

byte[] digest()

Completes the hash computation. Note that the engine is reset after this call is made.

Returns:

the resulting digest.

digest

byte[] digest(byte... input)

Performs a final update on the digest using the specified array of bytes, then completes the digest computation. That is, this method first calls update(byte...), passing the input array to the update method, then calls digest(). Note that the engine is reset after this call is made.

Parameters:

input - the array of bytes with which to update the digest before completing its computation.

Returns:

the resulting digest.

Throws:

NullPointerException - if input is null.

digest

byte[] digest(byte[] input,
              int off,
              int len)

Performs a final update on the digest using the specified data bytes, then completes the digest computation. That is, this method first calls update(byte[], int, int), passing the input array to the update method, then calls digest(). Note that the engine is reset after this call is made.

Parameters:

input - the array of bytes.

off - the offset to start from in the array of bytes, inclusive.

len - the number of bytes to use, starting at off.

Returns:

the resulting digest.

Throws:

NullPointerException - if input is null.

IndexOutOfBoundsException - if off is negative or if off + len is greater than input's length.