Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add RandomAccessFile digest methods #31

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
39 changes: 39 additions & 0 deletions src/main/java/org/apache/commons/codec/digest/DigestUtils.java
Expand Up @@ -20,9 +20,11 @@
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.RandomAccessFile;
import java.io.IOException;
import java.io.InputStream;
import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;

Expand Down Expand Up @@ -99,6 +101,20 @@ public static byte[] digest(final MessageDigest messageDigest, final File data)
return updateDigest(messageDigest, data).digest();
}

/**
* Reads through a RandomAccessFile using non-blocking-io (NIO) and returns the digest for the data
behrangsa marked this conversation as resolved.
Show resolved Hide resolved
*
* @param messageDigest The MessageDigest to use (e.g. MD5)
* @param data Data to digest
* @return the digest
* @throws IOException On error reading from the stream
* @since 1.14
*/
public static byte[] digest(final MessageDigest messageDigest, final RandomAccessFile data) throws IOException {
data.seek(0);
return updateDigest(messageDigest, data).digest();
}

/**
* Reads through an InputStream and returns the digest for the data
*
Expand Down Expand Up @@ -1207,6 +1223,29 @@ public static MessageDigest updateDigest(final MessageDigest digest, final File
}
}

/**
* Reads through a RandomAccessFile and updates the digest for the data
* using non-blocking-io (NIO)
behrangsa marked this conversation as resolved.
Show resolved Hide resolved
*
* @param digest The MessageDigest to use (e.g. MD5)
* @param data Data to digest
* @return the digest
* @throws IOException On error reading from the stream
* @since 1.14
*/
public static MessageDigest updateDigest(final MessageDigest digest, final RandomAccessFile data) throws IOException {
final FileChannel channel = data.getChannel();
final ByteBuffer buffer = ByteBuffer.allocate(STREAM_BUFFER_LENGTH);

while (channel.read(buffer) > 0) {
buffer.flip();
digest.update(buffer);
buffer.clear();
}

return digest;
}

/**
* Reads through an InputStream and updates the digest for the data
*
Expand Down
19 changes: 19 additions & 0 deletions src/test/java/org/apache/commons/codec/digest/DigestUtilsTest.java
Expand Up @@ -24,6 +24,7 @@
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.RandomAccessFile;
import java.nio.ByteBuffer;
import java.security.MessageDigest;
import java.util.Random;
Expand All @@ -47,6 +48,10 @@ public class DigestUtilsTest {

private File testFile;

private File testRandomAccessFile;

private RandomAccessFile testRandomAccessFileWrapper;

private void assumeJava8() {
Assume.assumeTrue(SystemUtils.isJavaVersionAtLeast(JavaVersion.JAVA_1_8));
}
Expand All @@ -63,20 +68,34 @@ File getTestFile() {
return testFile;
}

RandomAccessFile getTestRandomAccessFile() {
return testRandomAccessFileWrapper;
}

@Before
public void setUp() throws Exception {
new Random().nextBytes(testData);
testFile = File.createTempFile(DigestUtilsTest.class.getName(), ".dat");
try (final FileOutputStream fos = new FileOutputStream(testFile)) {
fos.write(testData);
}

testRandomAccessFile = File.createTempFile(DigestUtilsTest.class.getName(), ".dat");
try (final FileOutputStream fos = new FileOutputStream(testRandomAccessFile)) {
fos.write(testData);
}
testRandomAccessFileWrapper = new RandomAccessFile(testRandomAccessFile, "rw");
}

@After
public void tearDown() {
if (!testFile.delete()) {
testFile.deleteOnExit();
}

if (!testRandomAccessFile.delete()) {
testRandomAccessFile.deleteOnExit();
}
}

@Test(expected=IllegalArgumentException.class)
Expand Down
Expand Up @@ -19,6 +19,7 @@
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;
import java.io.RandomAccessFile;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.nio.ByteBuffer;
Expand Down Expand Up @@ -106,6 +107,10 @@ private File getTestFile() {
return digestUtilsTest.getTestFile();
}

private RandomAccessFile getTestRandomAccessFile() {
return digestUtilsTest.getTestRandomAccessFile();
}

@Before
public void setUp() throws Exception {
digestUtilsTest = new DigestUtilsTest();
Expand Down Expand Up @@ -151,6 +156,25 @@ public void testDigestFile() throws IOException {
Assert.assertArrayEquals(digestTestData(), DigestUtils.digest(DigestUtils.getDigest(messageDigestAlgorithm),getTestFile()));
}

@Test
public void testNonBlockingDigestRandomAccessFile() throws IOException {
Assume.assumeTrue(DigestUtils.isAvailable(messageDigestAlgorithm));

final byte[] expected = digestTestData();

Assert.assertArrayEquals(expected,
behrangsa marked this conversation as resolved.
Show resolved Hide resolved
DigestUtils.digest(
DigestUtils.getDigest(messageDigestAlgorithm), getTestRandomAccessFile()
)
);

Assert.assertArrayEquals(expected,
DigestUtils.digest(
DigestUtils.getDigest(messageDigestAlgorithm), getTestRandomAccessFile()
)
);
}

@Test
public void testDigestInputStream() throws IOException {
Assume.assumeTrue(DigestUtils.isAvailable(messageDigestAlgorithm));
Expand Down