com.groupdocs.redaction

Class Redactor

java.lang.Object

com.groupdocs.redaction.Redactor

All Implemented Interfaces:

IPreviewable, Closeable, AutoCloseable

public final class Redactor
extends Object
implements Closeable, IPreviewable

Represents a main class that controls document redaction process, allowing to open, redact and save documents.

Learn more

• More details about applying redactions: Redaction basics
• More advanced redaction topics: Advanced usage

Constructor Summary

Constructors

Constructor and Description
Redactor(InputStream document) Initializes a new instance of Redactor class using stream.
Redactor(InputStream document, LoadOptions loadOptions) Initializes a new instance of Redactor class for a password-protected document using stream.
Redactor(InputStream document, LoadOptions loadOptions, RedactorSettings settings) Initializes a new instance of Redactor class for a password-protected document using stream and settings.
Redactor(String filePath) Initializes a new instance of Redactor class using file path.
Redactor(String filePath, LoadOptions loadOptions) Initializes a new instance of Redactor class for a password-protected document using its path.
Redactor(String filePath, LoadOptions loadOptions, RedactorSettings settings) Initializes a new instance of Redactor class for a password-protected document using its path and settings.

Method Summary

Modifier and Type	Method and Description
RedactorChangeLog	apply(Redaction redaction) Applies a redaction to the document.
RedactorChangeLog	apply(Redaction[] redactions) Applies a set of redactions to the document.
RedactorChangeLog	apply(RedactionPolicy policy) Applies a redaction policy to the document.
void	close() Releases resources.
void	generatePreview(PreviewOptions previewOptions) Generates preview images of specific pages in a given image format.
IDocumentInfo	getDocumentInfo() Gets the general information about the document - size, page count, etc.
String	save() Saves the document to a file with the following options: AddSuffix = true, RasterizeToPDF = true.
void	save(OutputStream document) Saves the document to a stream.
void	save(OutputStream document, RasterizationOptions rasterizationOptions) Saves the document to a stream, including custom location.
String	save(SaveOptions saveOptions) Saves the document to a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

Redactor

public Redactor(InputStream document)
         throws Exception

Initializes a new instance of Redactor class using stream.

Parameters:

document - Source stream of the document

The following example demonstrates how to open a document from stream.

try (InputStream stream = new FileInputStream("C:\\sample.pdf"))
 {
     try (Redactor redactor = new Redactor(stream))
     {
         // Here we can use document instance to perform redactions
     }
 }
  

Throws:

Exception

Redactor

public Redactor(InputStream document,
                LoadOptions loadOptions)
         throws Exception

Initializes a new instance of Redactor class for a password-protected document using stream.

Parameters:

document - Source input stream.

loadOptions - Options, including password.

Throws:

Exception

Redactor

public Redactor(InputStream document,
                LoadOptions loadOptions,
                RedactorSettings settings)
         throws Exception

Initializes a new instance of Redactor class for a password-protected document using stream and settings.

Parameters:

document - Source input stream.

loadOptions - Options, including password.

settings - Default settings for redaction process.

Throws:

Exception

Redactor

public Redactor(String filePath)
         throws Exception

Initializes a new instance of Redactor class using file path.

Parameters:

filePath - Path to the file

The following example demonstrates how to open a document for redaction.

try (Redactor redactor = new Redactor("C:\\sample.pdf"))
 {
     // Here we can use document instance to perform redactions
 }
  

Throws:

Exception

Redactor

public Redactor(String filePath,
                LoadOptions loadOptions)
         throws Exception

Initializes a new instance of Redactor class for a password-protected document using its path.

Parameters:

filePath - Path to file.

loadOptions - Options, including password.

Throws:

Exception

Redactor

public Redactor(String filePath,
                LoadOptions loadOptions,
                RedactorSettings settings)
         throws Exception

Initializes a new instance of Redactor class for a password-protected document using its path and settings.

Parameters:

filePath - Path to file.

loadOptions - File-dependent options, including password.

settings - Default settings for redaction process.

Throws:

Exception

Method Detail

apply

public final RedactorChangeLog apply(Redaction redaction)

Applies a redaction to the document.

Parameters:

redaction - An instance of Redaction to apply

Returns:

Success or failure and error message in this case

apply

public final RedactorChangeLog apply(Redaction[] redactions)

Applies a set of redactions to the document.

Parameters:

redactions - An array of redactions to apply

Returns:

Success or failure and error message in this case

apply

public final RedactorChangeLog apply(RedactionPolicy policy)

Applies a redaction policy to the document.

Parameters:

policy - Redaction policy

Returns:

Success or failure and error message in this case

close

public final void close()

Releases resources.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

generatePreview

public final void generatePreview(PreviewOptions previewOptions)
                           throws Exception

Generates preview images of specific pages in a given image format.

Specified by:

generatePreview in interface IPreviewable

Parameters:

previewOptions - Image properties and page range settings

Throws:

Exception

getDocumentInfo

public final IDocumentInfo getDocumentInfo()
                                    throws Exception

Gets the general information about the document - size, page count, etc.

Specified by:

getDocumentInfo in interface IPreviewable

Returns:

An instance of IDocumentInfo

Throws:

Exception

save

public final String save()
                  throws Exception

Saves the document to a file with the following options: AddSuffix = true, RasterizeToPDF = true.

Returns:

Path to redacted document

Throws:

Exception

save

public final void save(OutputStream document)
                throws Exception

Saves the document to a stream.

Parameters:

document - Target stream

Throws:

Exception

save

public final void save(OutputStream document,
                       RasterizationOptions rasterizationOptions)
                throws Exception

Saves the document to a stream, including custom location.

Parameters:

document - Target stream

rasterizationOptions - Options to rasterize or not and to specify pages for rasterization

Throws:

Exception

save

public final String save(SaveOptions saveOptions)
                  throws Exception

Saves the document to a file.

Parameters:

saveOptions - Options to add suffix or rasterize

Returns:

Path to redacted document

Throws:

Exception