org.apache.tika.parser.digest

Class InputStreamDigester

java.lang.Object

org.apache.tika.parser.digest.InputStreamDigester

All Implemented Interfaces:

DigestingParser.Digester

Direct Known Subclasses:

BouncyCastleDigester.BCInputStreamDigester

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	InputStreamDigester.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.lang.String	algorithm
private java.lang.String	algorithmKeyName
private DigestingParser.Encoder	encoder
private int	markLimit

Constructor Summary

Constructors

Constructor and Description
InputStreamDigester(int markLimit, java.lang.String algorithm, DigestingParser.Encoder encoder)
InputStreamDigester(int markLimit, java.lang.String algorithm, java.lang.String algorithmKeyName, DigestingParser.Encoder encoder)

Method Summary

Modifier and Type	Method and Description
void	digest(java.io.InputStream is, Metadata metadata, ParseContext parseContext) Digests an InputStream and sets the appropriate value(s) in the metadata.
private void	digestFile(java.io.File f, Metadata m)
private boolean	digestStream(java.io.InputStream is, Metadata metadata)
private java.lang.String	getMetadataKey()
protected java.security.Provider	getProvider() When subclassing this, becare to ensure that your provider is thread-safe (not likely) or return a new provider with each call.
private java.security.MessageDigest	newMessageDigest()
private static java.security.MessageDigest	updateDigest(java.security.MessageDigest digest, java.io.InputStream data) Copied from commons-codec

Methods inherited from class java.lang.Object

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

Field Detail

algorithm

private final java.lang.String algorithm

algorithmKeyName

private final java.lang.String algorithmKeyName

encoder

private final DigestingParser.Encoder encoder

markLimit

private final int markLimit

Constructor Detail

InputStreamDigester

public InputStreamDigester(int markLimit,
                           java.lang.String algorithm,
                           DigestingParser.Encoder encoder)

InputStreamDigester

public InputStreamDigester(int markLimit,
                           java.lang.String algorithm,
                           java.lang.String algorithmKeyName,
                           DigestingParser.Encoder encoder)

Parameters:

markLimit - limit in bytes to allow for mark/reset. If the inputstream is longer than this limit, the stream will be reset and then spooled to a temporary file. Throws IllegalArgumentException if < 0.

algorithm - name of the digest algorithm to retrieve from the Provider

algorithmKeyName - name of the algorithm to store as part of the key in the metadata when digest(InputStream, Metadata, ParseContext) is called

encoder - encoder to convert the byte array returned from the digester to a string

Method Detail

newMessageDigest

private java.security.MessageDigest newMessageDigest()

getProvider

protected java.security.Provider getProvider()

When subclassing this, becare to ensure that your provider is thread-safe (not likely) or return a new provider with each call.

Returns:

provider to use to get the MessageDigest from the algorithm name. Default is to return null.

digest

public void digest(java.io.InputStream is,
                   Metadata metadata,
                   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. Best to use a TikaInputStream because of potential need to spool to disk. InputStream must support mark/reset.

metadata - metadata in which to store the digest information

parseContext - ParseContext -- not actually used yet, but there for future expansion

Throws:

java.io.IOException - on IO problem or IllegalArgumentException if algorithm couldn't be found

getMetadataKey

private java.lang.String getMetadataKey()

digestFile

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

Throws:

java.io.IOException

digestStream

private boolean digestStream(java.io.InputStream is,
                             Metadata metadata)
                      throws java.io.IOException

Parameters:

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

updateDigest

private static java.security.MessageDigest updateDigest(java.security.MessageDigest digest,
                                                        java.io.InputStream data)
                                                 throws java.io.IOException

Copied from commons-codec

Throws:

java.io.IOException