Package org.apache.tika.digest

Class DigestHelper

java.lang.Object

org.apache.tika.digest.DigestHelper

public class DigestHelper
extends Object

Utility class for computing digests on streams.

The DigesterFactory is retrieved from ParseContext. Configure it via the "parse-context" section in tika-config.json:

 "parse-context": {
   "commons-digester-factory": {
     "digests": [{ "algorithm": "SHA256" }],
     "skipContainerDocumentDigest": true
   }
 }
 

Constructor Summary

Constructors

Constructor	Description
DigestHelper()

Method Summary

Modifier and Type	Method	Description
static void	maybeDigest(TikaInputStream tis, Metadata metadata, ParseContext context)	Computes digests on the stream if a DigesterFactory is configured in ParseContext.

Methods inherited from class java.lang.Object

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

Constructor Details

DigestHelper

public DigestHelper()

Method Details

maybeDigest

public static void maybeDigest(TikaInputStream tis,
 Metadata metadata,
 ParseContext context)
                        throws IOException

Computes digests on the stream if a DigesterFactory is configured in ParseContext.

This is called directly from AutoDetectParser.parse() before type detection.

Parameters:

tis - the TikaInputStream to digest

metadata - metadata to read depth from and write digests to

context - parse context (should contain DigesterFactory, may contain SkipContainerDocumentDigest marker)

Throws:

IOException - if an I/O error occurs