org.apache.tika.parser.utils

Class CommonsDigester

java.lang.Object

org.apache.tika.parser.utils.CommonsDigester

All Implemented Interfaces:

DigestingParser.Digester

public class CommonsDigester
extends java.lang.Object
implements DigestingParser.Digester

Implementation of DigestingParser.Digester that relies on commons.codec.digest.DigestUtils to calculate digest hashes.

This digester tries to use the regular mark/reset protocol on the InputStream. However, this wraps an internal BoundedInputStream, and if the InputStream is not fully read, then this will reset the stream and spool the InputStream to disk (via TikaInputStream) and then digest the file.

If a TikaInputStream is passed in and it has an underlying file that is longer than the markLimit, then this digester digests the file directly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommonsDigester.DigestAlgorithm
private class	CommonsDigester.SimpleBoundedInputStream Very slight modification of Commons' BoundedInputStream so that we can figure out if this hit the bound or not.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<CommonsDigester.DigestAlgorithm>	algorithms
private int	markLimit

Constructor Summary

Constructors

Constructor and Description
CommonsDigester(int markLimit, CommonsDigester.DigestAlgorithm... algorithms)

Method Summary

Modifier and Type	Method and Description
void	digest(java.io.InputStream is, Metadata m, ParseContext parseContext) Digests an InputStream and sets the appropriate value(s) in the metadata.
private boolean	digestEach(CommonsDigester.DigestAlgorithm algorithm, java.io.InputStream is, Metadata metadata)
private void	digestFile(java.io.File f, Metadata m)
static CommonsDigester.DigestAlgorithm[]	parse(java.lang.String s)

Methods inherited from class java.lang.Object

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

Field Detail

algorithms

private final java.util.List<CommonsDigester.DigestAlgorithm> algorithms

markLimit

private final int markLimit

Constructor Detail

CommonsDigester

public CommonsDigester(int markLimit,
                       CommonsDigester.DigestAlgorithm... algorithms)

Method Detail

digest

public void digest(java.io.InputStream is,
                   Metadata m,
                   ParseContext parseContext)
            throws java.io.IOException

Description copied from interface: DigestingParser.Digester

Digests an InputStream and sets the appropriate value(s) in the metadata. The Digester is also responsible for marking and resetting the stream.

The given stream is guaranteed to support the mark feature and the detector is expected to mark the stream before reading any bytes from it, and to reset the stream before returning. The stream must not be closed by the detector.

Specified by:

digest in interface DigestingParser.Digester

Parameters:

is - InputStream to digest

m - Metadata to set the values for

parseContext - ParseContext

Throws:

java.io.IOException

digestFile

private void digestFile(java.io.File f,
                        Metadata m)
                 throws java.io.IOException

Throws:

java.io.IOException

digestEach

private boolean digestEach(CommonsDigester.DigestAlgorithm algorithm,
                           java.io.InputStream is,
                           Metadata metadata)
                    throws java.io.IOException

Parameters:

algorithm - algo to use

is - input stream to read from

metadata - metadata for reporting the digest

Returns:

whether or not this finished the input stream

Throws:

java.io.IOException

parse

public static CommonsDigester.DigestAlgorithm[] parse(java.lang.String s)

Parameters:

s - comma-delimited (no space) list of algorithms to use: md5,sha256

Returns: