Interface PasswordProvider

All Superinterfaces:

Serializable

All Known Implementing Classes:

SimplePasswordProvider

public interface PasswordProvider
extends Serializable

Interface for providing a password to a Parser for handling Encrypted and Password Protected Documents. An implementation of this should be set on the ParseContext supplied to

invalid reference

Parser#parse(java.io.InputStream, org.xml.sax.ContentHandler, Metadata, ParseContext)

to provide a way to get the document password. An implementation of this interface defines some specific selection or lookup criteria, to be applied against the document metadata passed to the getPassword(Metadata) method.

Since:

Apache Tika 1.1

Method Summary

Modifier and Type	Method	Description
String	getPassword(Metadata metadata)	Looks up the password for a document with the given metadata, and returns it for the Parser.

Method Details

getPassword

String getPassword(Metadata metadata)

Looks up the password for a document with the given metadata, and returns it for the Parser. If no password is available for the document, will return null.

Parameters:

metadata - document metadata

Returns:

The document decryption password, or null if not known