Metadata redactions

Filter metadata

Base functionality for all redactions, derived from MetadataRedaction base class is metadata filtering and it is mandatory for metadata redactions. It uses flagged enumeration MetadataFilters, containing items for most frequent metadata entries. You can set the filter to All, or any combination of metadata. For instance, the example below sets filter to AuthorManager and NameOfApplication - for textual redaction or cleaning them out:

// redaction derived from MetadataRedaction
redaction.setFilter(MetadataFilters.Author | MetadataFilters.Manager | MetadataFilters.NameOfApplication);

Below is the table with full list of MetadataFilters items:

FilterNumeric valueDescription
None0Empty filter setting, matches no metadata items
Author1Author of the document
Category2Category of the document
Comments4Document comment
Company8Company of the Author
ContentStatus16Content status
CreatedTime32Created time
HyperlinkBase64Hyperlink base
LastPrinted128Last printed date and time
LastSavedBy256Last saved by user
LastSavedTime1024Last saved date and time
NameOfApplication2048Name of application where the document was created
Manager4096Author’s manager name
RevisionNumber8192Revision number
Subject16384Subject of the document
Template32768Document template name
Title65536Document title
TotalEditingTime131072Total editing time
Version262144Document’s version
Description524288Document’s description
Keywords1048576Document’s keywords
ContentType2097152Content type
All2147483647All types of the metadata items

Clean metadata

You can replace all or specific metadata in the document with empty (blank or minimal) values. The example below blanks out all properties of the document:

final Redactor redactor  = new Redactor("Sample.docx");
try 
{
    redactor.apply(new EraseMetadataRedaction(MetadataFilters.All));
    SaveOptions options = new  SaveOptions();
    options.setAddSuffix(true);
    options.setRasterizeToPDF(false);
    // Save the document to "*_Redacted.*" file in original format
    redactor.save(options);
}
finally { redactor.close(); }

You can specify MetadataFilter.All or use default constructor to blank out all metadata within given document, Custom - to clear all custom metadata entries.

Redact metadata

You can use MetadataSearchRedaction to remove sensitive data from document’s metadata using regular expressions. For instance, we can remove any mention of “Company Ltd.":

final Redactor redactor  = new Redactor("Sample.docx");
try 
{
    redactor.apply(new MetadataSearchRedaction("Company Ltd.", "--company--"));
    SaveOptions options = new SaveOptions();
    options.setAddSuffix(true);
    options.setRasterizeToPDF(false);
    // Save the document to "*_Redacted.*" file in original format
    redactor.save(options);
}
finally { redactor.close(); }

First argument is regular expression, second is a replacement string. You can also set scope for redaction by setting filter, e.g. to MetadataFilter.Company. - it will leave the regular expressions matches undone in all metadata items, except “Company” property:

final Redactor redactor  = new Redactor("Sample.docx");
try 
{
    MetadataSearchRedaction redaction = new MetadataSearchRedaction("Company Ltd.", "--company--");
    redaction.setFilter(MetadataFilters.Company);
    redactor.apply(redaction);
    SaveOptions options = new SaveOptions();
    options.setAddSuffix(true);
    options.setRasterizeToPDF(false);
    // Save the document to "*_Redacted.*" file in original format
    redactor.save(options);
}
finally { redactor.close(); }

Metadata redaction status

All metadata redactions apply to each metadata item separately, and even if metadata item redaction fails, the rest of the metadata items will be updated. You can find a list of failed, skipped (rejected) metadata items and reasons for that in ErrorMessage property of RedactorLogEntry.Result.