Package org.apache.tika.digest

Class DigestDef

java.lang.Object

org.apache.tika.digest.DigestDef

public class DigestDef
extends Object

Defines a digest algorithm with its output encoding.

Example JSON configuration:

 {
   "digests": [
     { "algorithm": "MD5" },
     { "algorithm": "SHA256", "encoding": "BASE32" }
   ]
 }
 

The metadata key format is:

• X-TIKA:digest:MD5 - for HEX encoding (default)
• X-TIKA:digest:SHA256:BASE32 - for non-default encodings

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DigestDef.Algorithm	Supported digest algorithms.
static enum	DigestDef.Encoding	Supported digest output encodings.

Constructor Summary

Constructors

Constructor	Description
DigestDef()
DigestDef(DigestDef.Algorithm algorithm)
DigestDef(DigestDef.Algorithm algorithm, DigestDef.Encoding encoding)

Method Summary

Modifier and Type	Method	Description
DigestDef.Algorithm	getAlgorithm()
DigestDef.Encoding	getEncoding()
String	metadataKey()	Returns the metadata key for storing this digest value.
void	setAlgorithm(DigestDef.Algorithm algorithm)
void	setEncoding(DigestDef.Encoding encoding)

Methods inherited from class java.lang.Object

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

Constructor Details

DigestDef

public DigestDef()

DigestDef

public DigestDef(DigestDef.Algorithm algorithm)

DigestDef

public DigestDef(DigestDef.Algorithm algorithm,
 DigestDef.Encoding encoding)

Method Details

getAlgorithm

public DigestDef.Algorithm getAlgorithm()

setAlgorithm

public void setAlgorithm(DigestDef.Algorithm algorithm)

getEncoding

public DigestDef.Encoding getEncoding()

setEncoding

public void setEncoding(DigestDef.Encoding encoding)

metadataKey

public String metadataKey()

Returns the metadata key for storing this digest value.

For HEX encoding (the default), returns X-TIKA:digest:ALGORITHM. For other encodings, returns X-TIKA:digest:ALGORITHM:ENCODING.

Returns:

the metadata key