Migration Notes

Why To Migrate?

Here are the key reasons to use the new updated API provided by GroupDocs.Redaction for Java since version 19.6:

  • Redactor class introduced as a single entry point to manage the document redaction process (instead of Documentclass from previous versions).

  • Methods redactWith() of the Document class were replaced with similar apply() methods in Redactor class.

  • Method Document.save(OutputStream, SaveOptions) was replaced with Redactor.save(OutputStream, RasterizationOptions).

  • Constructor LoadOptions(DocumentFormatConfiguration) was removed.

  • RedactionSummary was renamed into RedactorChangeLogRedactionLogRecord into RedactorLogRecordMetadataFilter into MetadataFilters.

  • Obsolete members were removed from Public API.

  • Added a number of new exception classes and base exception class for GroupDocs.Redaction exceptions.

How To Migrate?

The following example demonstrates how to redact Microsoft Office Word document and dumping statuses of applied redactions using old and new API:

Old coding style

// Load the file
Document doc = Redactor.load("Documents/Doc/sample.docx");
//Perform redaction using exact phrase
RedactionSummary summary = doc.redactWith(new ExactPhraseRedaction("John Doe", new ReplacementOptions("[Personal]")));
for (RedactionLogEntry entry : summary.getRedactionLog())
//Save the resultant document
// Close the Document

New coding style

// Load the file
Redactor redactor = new Redactor("Documents/Doc/sample.docx");
//Perform redaction using exact phrase
RedactorChangeLog summary = redactor.apply(new ExactPhraseRedaction("John Doe", new ReplacementOptions("[Personal]")));
for (RedactorLogEntry entry : summary.getRedactionLog())
//Save the resultant document
// Close the Redactor 

For more code examples and specific use cases please refer to our Developer Guide documentation or GitHub samples and showcases.