org.waarp.common.digest

Class FilesystemBasedDigest

java.lang.Object

org.waarp.common.digest.FilesystemBasedDigest

public class FilesystemBasedDigest
extends Object

Class implementing digest like MD5, SHA1, SHAxxx.

Some performance reports: (done using java -server option)

• File based only:
• If ADLER32 is the referenced time ADLER32=1, CRC32=2.5, MD5=4, SHA1=7, SHA256=11, SHA512=25
• Buffer based only:
• JVM version is the fastest (+20%).
• If ADLER32 is the referenced time ADLER32=1, CRC32=2.5, MD5=4, SHA1=8, SHA256=13, SHA384=29, SHA512=31

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilesystemBasedDigest.DigestAlgo All Algo that Digest Class could handle

Field Summary

Fields

Modifier and Type	Field and Description
protected static byte[]	EMPTY
static Charset	UTF8 Format used for Files
static int	ZERO_COPY_CHUNK_SIZE

Constructor Summary

Constructors

Constructor and Description
FilesystemBasedDigest(FilesystemBasedDigest.DigestAlgo algo) Constructor of an independent Digest

Method Summary

Modifier and Type	Method and Description
static boolean	digestEquals(byte[] dig1, byte[] dig2)
static boolean	digestEquals(String dig1, byte[] dig2)
static boolean	equalPasswd(byte[] pwd, byte[] cryptPwd)
static boolean	equalPasswd(String pwd, String cryptPwd)
byte[]	Final()
FilesystemBasedDigest.DigestAlgo	getAlgo()
byte[]	getBytes(io.netty.buffer.ByteBuf buffer) One should call getOffset since offset within array could not 0
static byte[]	getFromHex(String hex) Get the array of bytes representation of the hexadecimal String
static byte[]	getHash(byte[] buffer, FilesystemBasedDigest.DigestAlgo algo) Get hash with given byte array
static byte[]	getHash(byte[] buffer, int length, FilesystemBasedDigest.DigestAlgo algo) Get hash with given byte array
static byte[]	getHash(io.netty.buffer.ByteBuf buffer, FilesystemBasedDigest.DigestAlgo algo) Get hash with given ByteBuf (from Netty)
static byte[]	getHash(File f, boolean nio, FilesystemBasedDigest.DigestAlgo algo) Get the Digest for the file using the specified algorithm using access through NIO or not
static byte[]	getHash(InputStream stream, FilesystemBasedDigest.DigestAlgo algo) Get the Digest for the file using the specified algorithm using access through NIO or not
static byte[]	getHashMd5(io.netty.buffer.ByteBuf buffer) Get hash with given ByteBuf (from Netty)
static byte[]	getHashMd5(File f) get the byte array of the MD5 for the given FileInterface using standard access
static byte[]	getHashMd5Nio(File f) get the byte array of the MD5 for the given FileInterface using Nio access
static String	getHex(byte[] hash) Get the hexadecimal representation as a String of the array of bytes
int	getOffset(io.netty.buffer.ByteBuf buffer)
void	initialize() (Re)Initialize the digest
void	initialize(FilesystemBasedDigest.DigestAlgo algo) (Re)Initialize the digest
static byte[]	passwdCrypt(byte[] pwd) Crypt a password
static String	passwdCrypt(String pwd) Crypt a password
void	Update(byte[] buffer) Update the digest with new buffer
void	Update(byte[] bytes, int offset, int length) Update the digest with new bytes
void	Update(io.netty.buffer.ByteBuf buffer) Update the digest with new buffer

Methods inherited from class java.lang.Object

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

Field Detail

UTF8

public static final Charset UTF8

Format used for Files

EMPTY

protected static final byte[] EMPTY

ZERO_COPY_CHUNK_SIZE

public static final int ZERO_COPY_CHUNK_SIZE

See Also:

Constant Field Values

Constructor Detail

FilesystemBasedDigest

public FilesystemBasedDigest(FilesystemBasedDigest.DigestAlgo algo)
                      throws NoSuchAlgorithmException

Constructor of an independent Digest

Parameters:

algo -

Throws:

NoSuchAlgorithmException

Method Detail

initialize

public final void initialize()
                      throws NoSuchAlgorithmException

(Re)Initialize the digest

Throws:

NoSuchAlgorithmException

initialize

public final void initialize(FilesystemBasedDigest.DigestAlgo algo)
                      throws NoSuchAlgorithmException

(Re)Initialize the digest

Parameters:

algo -

Throws:

NoSuchAlgorithmException

getAlgo

public final FilesystemBasedDigest.DigestAlgo getAlgo()

Update

public final void Update(byte[] bytes,
                         int offset,
                         int length)

Update the digest with new bytes

Parameters:

bytes -

offset -

length -

getBytes

public final byte[] getBytes(io.netty.buffer.ByteBuf buffer)

One should call getOffset since offset within array could not 0

Parameters:

buffer -

Returns:

the array corresponding to this buffer (may be copied)

getOffset

public final int getOffset(io.netty.buffer.ByteBuf buffer)

Parameters:

buffer -

Returns:

the offset for the getBytes array

Update

public final void Update(io.netty.buffer.ByteBuf buffer)

Update the digest with new buffer

Update

public final void Update(byte[] buffer)

Update the digest with new buffer

Final

public final byte[] Final()

Returns:

the digest in array of bytes

digestEquals

public static boolean digestEquals(byte[] dig1,
                                   byte[] dig2)

Parameters:

dig1 -

dig2 -

Returns:

True if the two digest are equals

digestEquals

public static boolean digestEquals(String dig1,
                                   byte[] dig2)

Parameters:

dig1 -

dig2 -

Returns:

True if the two digest are equals

getHashMd5Nio

public static byte[] getHashMd5Nio(File f)
                            throws IOException

get the byte array of the MD5 for the given FileInterface using Nio access

Parameters:

f -

Returns:

the byte array representing the MD5

Throws:

IOException

getHashMd5

public static byte[] getHashMd5(File f)
                         throws IOException

get the byte array of the MD5 for the given FileInterface using standard access

Parameters:

f -

Returns:

the byte array representing the MD5

Throws:

IOException

getHash

public static byte[] getHash(File f,
                             boolean nio,
                             FilesystemBasedDigest.DigestAlgo algo)
                      throws IOException

Get the Digest for the file using the specified algorithm using access through NIO or not

Parameters:

f -

nio -

algo -

Returns:

the digest

Throws:

IOException

getHash

public static byte[] getHash(InputStream stream,
                             FilesystemBasedDigest.DigestAlgo algo)
                      throws IOException

Get the Digest for the file using the specified algorithm using access through NIO or not

Parameters:

stream - will be closed at the end of this call

algo -

Returns:

the digest

Throws:

IOException

getHash

public static byte[] getHash(io.netty.buffer.ByteBuf buffer,
                             FilesystemBasedDigest.DigestAlgo algo)
                      throws IOException

Get hash with given ByteBuf (from Netty)

Parameters:

buffer - this buffer will not be changed

algo -

Returns:

the hash

Throws:

IOException

getHash

public static byte[] getHash(byte[] buffer,
                             FilesystemBasedDigest.DigestAlgo algo)
                      throws IOException

Get hash with given byte array

Parameters:

buffer - this buffer will not be changed

algo -

Returns:

the hash

Throws:

IOException

getHash

public static byte[] getHash(byte[] buffer,
                             int length,
                             FilesystemBasedDigest.DigestAlgo algo)
                      throws IOException

Get hash with given byte array

Parameters:

buffer - this buffer will not be changed

length - the real size of the buffer

algo -

Returns:

the hash

Throws:

IOException

getHashMd5

public static byte[] getHashMd5(io.netty.buffer.ByteBuf buffer)

Get hash with given ByteBuf (from Netty)

Parameters:

buffer - ByteBuf to use to get the hash and this buffer will not be changed

Returns:

the hash

getHex

public static String getHex(byte[] hash)

Get the hexadecimal representation as a String of the array of bytes

Parameters:

hash -

Returns:

the hexadecimal representation as a String of the array of bytes

getFromHex

public static byte[] getFromHex(String hex)

Get the array of bytes representation of the hexadecimal String

Parameters:

hex -

Returns:

the array of bytes representation of the hexadecimal String

passwdCrypt

public static String passwdCrypt(String pwd)

Crypt a password

Parameters:

pwd - to crypt

Returns:

the crypted password

passwdCrypt

public static byte[] passwdCrypt(byte[] pwd)

Crypt a password

Parameters:

pwd - to crypt

Returns:

the crypted password

equalPasswd

public static boolean equalPasswd(String pwd,
                                  String cryptPwd)

Parameters:

pwd -

cryptPwd -

Returns:

True if the pwd is comparable with the cryptPwd

equalPasswd

public static boolean equalPasswd(byte[] pwd,
                                  byte[] cryptPwd)

Parameters:

pwd -

cryptPwd -

Returns:

True if the pwd is comparable with the cryptPwd