Document passwords

The PasswordDictionary class is designed to store passwords for documents to be indexed. Information on indexing password protected documents is presented on the Indexing password protected documents page.

To get the number of passwords in the dictionary, use the getCount method.

To get the password for a document from the dictionary, the getPassword method is used, passing the path to the document as an argument.

The clear method is used to remove all passwords from the dictionary.

To check for the presence of a password in the dictionary for the specified document, the contains method is used.

To add a password to the dictionary, use the add method. The key is the path to the document.

To remove a password from the dictionary, use the remove method.

The following example demonstrates the use of methods of the password dictionary.

String indexFolder = "c:\\MyIndex\\";
// Creating an index from in specified folder
Index index = new Index(indexFolder);
if (index.getDictionaries().getDocumentPasswords().getCount() > 0) {
    // Removing all passwords from the dictionary
String path = "c:\\MyIndex\\Protected.pdf";
if (index.getDictionaries().getDocumentPasswords().contains(path)) {
    // Getting a password for a document
    String password = index.getDictionaries().getDocumentPasswords().getPassword(path);
    System.out.println("\tPassword: " + password);
    // Deleting the password from the dictionary
// Adding a password for a document
index.getDictionaries().getDocumentPasswords().add(path, "123456");

More resources

GitHub examples

You may easily run the code from documentation articles and see the features in action in our GitHub examples:

Free online document search App

Along with full featured .NET library we provide simple, but powerful free Apps.

You are welcome to search over your PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX and more with our free online Free Online Document Search App.