org.apache.tika.parser.utils

Class CommonsDigester

java.lang.Object

org.apache.tika.parser.digest.CompositeDigester

org.apache.tika.parser.utils.CommonsDigester

All Implemented Interfaces:

DigestingParser.Digester

public class CommonsDigester
extends CompositeDigester

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	CommonsDigester.Base32Encoder
static class	CommonsDigester.DigestAlgorithm
private static class	CommonsDigester.HexEncoder

Constructor Summary

Constructors

Constructor and Description
CommonsDigester(int markLimit, CommonsDigester.DigestAlgorithm... algorithms) Deprecated. use CommonsDigester(int, String)
CommonsDigester(int markLimit, java.lang.String algorithmString) Include a string representing the comma-separated algorithms to run: e.g.

Method Summary

Modifier and Type	Method and Description
private static DigestingParser.Digester[]	buildDigesters(int markLimit, CommonsDigester.DigestAlgorithm[] algorithms)
private static DigestingParser.Digester[]	buildDigesters(int markLimit, java.lang.String digesterDef)
private static CommonsDigester.DigestAlgorithm	getDigestAlgorithm(java.lang.String algoString)
static CommonsDigester.DigestAlgorithm[]	parse(java.lang.String s) Deprecated. use the CommonsDigester(int, String) instead

Methods inherited from class org.apache.tika.parser.digest.CompositeDigester

digest

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonsDigester

public CommonsDigester(int markLimit,
                       java.lang.String algorithmString)

Include a string representing the comma-separated algorithms to run: e.g. "md5,sha1". If you want base 32 encoding instead of hexadecimal, add ":32" to the algorithm, e.g. "md5,sha1:32"

Will throw an IllegalArgumentException if an algorithm isn't supported

Parameters:

markLimit -

algorithmString -

CommonsDigester

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

Deprecated. use CommonsDigester(int, String)

Parameters:

markLimit - limit for mark/reset; after this limit is hit, the stream is reset and spooled to disk

algorithms - algorithms to run

Method Detail

buildDigesters

private static DigestingParser.Digester[] buildDigesters(int markLimit,
                                                         CommonsDigester.DigestAlgorithm[] algorithms)

parse

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

Deprecated. use the CommonsDigester(int, String) instead

This returns digest algorithms only. It does not understand the encoding syntax, e.g. "MD5:32" (base 32 encoding of MD5). To parse those, see CommonsDigester(int, String).

Parameters:

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

Returns:

getDigestAlgorithm

private static CommonsDigester.DigestAlgorithm getDigestAlgorithm(java.lang.String algoString)

buildDigesters

private static DigestingParser.Digester[] buildDigesters(int markLimit,
                                                         java.lang.String digesterDef)