com.perforce.p4java.impl.mapbased.rpc.func.helper

Class MD5Digester

java.lang.Object

com.perforce.p4java.impl.mapbased.rpc.func.helper.MD5Digester

public class MD5Digester
extends Object

Provide MD5 digest methods for the rest of the RPC implementation. Basically just a wrapper around the normal Java stuff, with a useful added method to finalise the digest as a hex string.

Author:

Sean Shou - clean code & unit test

Constructor Summary

Constructors

Constructor and Description
MD5Digester()
MD5Digester(int bufferSize)

Method Summary

Modifier and Type	Method and Description
String	digestAs32ByteHex() Return the finalised digest as a 32 byte hex string.
byte[]	digestAsBytes()
String	digestFileAs32ByteHex(File file) Return the results of digesting an arbitrary file with this digester.
String	digestFileAs32ByteHex(File file, Charset charset) Return the results of digesting an arbitrary file with this digester.
String	digestFileAs32ByteHex(File file, Charset charset, boolean doesNeedConvertLineEndings) Return the results of digesting an arbitrary file with this digester.
String	digestFileAs32ByteHex(File file, Charset charset, boolean isRequireLineEndingConvert, ClientLineEnding clientLineEnding) Return the results of digesting an arbitrary file with this digester and a specific client line ending.
void	reset()
void	update(byte[] bytes)
void	update(byte[] bytes, int off, int len)
void	update(ByteBuffer byteBuf) Deprecated.
void	update(String str)

Methods inherited from class java.lang.Object

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

Constructor Detail

MD5Digester

public MD5Digester()
            throws P4JavaError

Throws:

P4JavaError

MD5Digester

public MD5Digester(@Nonnull
                   int bufferSize)

Method Detail

digestAsBytes

public byte[] digestAsBytes()

digestFileAs32ByteHex

@Nullable
public String digestFileAs32ByteHex(@Nonnull
                                              File file)

Return the results of digesting an arbitrary file with this digester.

Returns null if it can't read or digest the file for whatever reason; otherwise the finalized digest is returned as a 32 byte hex string.

Returns:

- computed digest or null if computation failed

reset

public void reset()

update

public void update(byte[] bytes,
                   int off,
                   int len)

digestAs32ByteHex

public String digestAs32ByteHex()

Return the finalised digest as a 32 byte hex string. It's important elsewhere and in the server that the string be exactly 32 bytes long, so we stitch it up if possible to make it that long...

digestFileAs32ByteHex

@Nullable
public String digestFileAs32ByteHex(@Nonnull
                                              File file,
                                              @Nullable
                                              Charset charset)

Return the results of digesting an arbitrary file with this digester.

Returns null if it can't read or digest the file for whatever reason; otherwise the finalized digest is returned as a 32 byte hex string.

Returns:

- computed digest or null if computation failed

digestFileAs32ByteHex

@Nullable
public String digestFileAs32ByteHex(@Nonnull
                                              File file,
                                              @Nullable
                                              Charset charset,
                                              boolean doesNeedConvertLineEndings)

Return the results of digesting an arbitrary file with this digester.

Returns null if it can't read or digest the file for whatever reason; otherwise the finalized digest is returned as a 32 byte hex string.

Returns:

- computed digest or null if computation failed

digestFileAs32ByteHex

@Nullable
public String digestFileAs32ByteHex(@Nonnull
                                              File file,
                                              @Nullable
                                              Charset charset,
                                              boolean isRequireLineEndingConvert,
                                              @Nullable
                                              ClientLineEnding clientLineEnding)

Return the results of digesting an arbitrary file with this digester and a specific client line ending.

Returns null if it can't read or digest the file for whatever reason; otherwise the finalized digest is returned as a 32 byte hex string.

Returns:

- computed digest or null if computation failed

update

public void update(String str)

update

public void update(byte[] bytes)

update

@Deprecated
public void update(ByteBuffer byteBuf)

Deprecated.

NOTE: side effects!! It will be removed from next release