com.tsgrp.opencontent.universal.redaction

Class RedactionUtil

java.lang.Object

com.tsgrp.opencontent.universal.redaction.RedactionUtil

public class RedactionUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
RedactionUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	addRedactions(java.lang.String ticket, java.lang.String objectId, EnhancedCompleteObject redactedECO, java.lang.Boolean newVersion, java.lang.Boolean majorVersion) Updates the document represented by objectId with the redactedECO
static com.aspose.pdf.Document	applyRedactionRectangles(EnhancedObjectContent unRedactedPdf, java.lang.String ticket, java.lang.String objectId, Redaction[] redactions, java.util.List<Redaction> failedRedactions, java.lang.String redactionFont) Function that both burns in redaction rectangles and scrubs the text behind said rectangles
static java.lang.String	checkForPreviousRedaction(java.lang.String ticket, java.lang.String objectId, RedactionConfig redactionConfig) Helper-method that determines whether or not the passed in objectId has any previous redactions associated with it
static EnhancedCompleteObject	createRedactedECO(java.io.ByteArrayOutputStream baos) Helper-method that returns an object representing our redacted content
static Redaction[]	createRedactionsFromAnnotations(Annotation[] annotations) Helper method for creation redaction objects from annotation objects
static void	drawRedaction(java.awt.image.BufferedImage buffImg, Redaction redaction, com.itextpdf.text.Rectangle pageRect, float widthScale, float heightScale, int rotation) Helper-method that draws a redactions onto a buffered image.
static com.aspose.pdf.Document	drawTextRedact(com.aspose.pdf.TextFragmentCollection textFragmentCollection, java.lang.String replacement, com.aspose.pdf.Document pdfDocument) Helper that redacts a textFragment from a PDF
static java.lang.String	getReplacementString(java.lang.String toRedact) Helper takes an input string and returns an estimated equal redaction string of asterisks
static java.lang.String	processPermanentRedaction(java.lang.String ticket, java.lang.String redactedDocumentId, java.io.ByteArrayOutputStream baos, java.lang.Boolean newVersion, java.lang.Boolean majorVersion) Redacts in-place the document passed in
static java.lang.String	processRedactedAsCopy(java.lang.String ticket, java.lang.String objectId, java.lang.String parentId, java.io.ByteArrayOutputStream baos, RedactionConfig redactionConfig, java.lang.Boolean newVersion, java.lang.Boolean majorVersion) Returns a string that represents the object that was redacted.
static java.lang.String	processUnredactedAsCopy(java.lang.String ticket, java.lang.String objectId, java.lang.String parentId, java.io.ByteArrayOutputStream baos, RedactionConfig redactionConfig, java.lang.Boolean newVersion, java.lang.Boolean majorVersion) Returns a string that represents the object that was redacted.

Methods inherited from class java.lang.Object

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

Constructor Detail

RedactionUtil

public RedactionUtil()

Method Detail

createRedactionsFromAnnotations

public static Redaction[] createRedactionsFromAnnotations(Annotation[] annotations)

Helper method for creation redaction objects from annotation objects

Parameters:

annotations - an array of annotation objects

Returns:

an array of redaction objects

processUnredactedAsCopy

public static java.lang.String processUnredactedAsCopy(java.lang.String ticket,
                                                       java.lang.String objectId,
                                                       java.lang.String parentId,
                                                       java.io.ByteArrayOutputStream baos,
                                                       RedactionConfig redactionConfig,
                                                       java.lang.Boolean newVersion,
                                                       java.lang.Boolean majorVersion)

Returns a string that represents the object that was redacted. In this case, the redaction mode being used creates a copy of the document, which becomes the unredacted document, and then redacts the original document.

Parameters:

ticket - A valid OC ticket.

objectId - The objectId of the PDF object to create redactions for.

parentId - The objectId of the parent of the PDF object to create redactions for.

baos - The ByteArrayOutputStream representing the PDF object containing our redactions.

redactionConfig - The redactionConfig providing the configuration options for redaction.

newVersion - true if the update will be saved to a new version, otherwise false.

majorVersion - true if the update will be saved to a major version, otherwise false.

Returns:

A string of the objectId that was redacted

processRedactedAsCopy

public static java.lang.String processRedactedAsCopy(java.lang.String ticket,
                                                     java.lang.String objectId,
                                                     java.lang.String parentId,
                                                     java.io.ByteArrayOutputStream baos,
                                                     RedactionConfig redactionConfig,
                                                     java.lang.Boolean newVersion,
                                                     java.lang.Boolean majorVersion)

Returns a string that represents the object that was redacted. In this case, the redaction mode being used creates a copy of the document, which becomes the redacted document, and leaves the original as the unredacted.

Parameters:

ticket - A valid OC ticket.

objectId - The objectId of the PDF object to create redactions for.

parentId - The objectId of the parent of the PDF object to create redactions for.

baos - The ByteArrayOutputStream representing the PDF object containing our redactions.

redactionConfig - The redactionConfig providing the configuration options for redaction.

newVersion - true if the update will be saved to a new version, otherwise false.

majorVersion - true if the update will be saved to a major version, otherwise false.

Returns:

A string of the objectId that was redacted

processPermanentRedaction

public static java.lang.String processPermanentRedaction(java.lang.String ticket,
                                                         java.lang.String redactedDocumentId,
                                                         java.io.ByteArrayOutputStream baos,
                                                         java.lang.Boolean newVersion,
                                                         java.lang.Boolean majorVersion)

Redacts in-place the document passed in

Parameters:

ticket - A valid OC ticket.

redactedDocumentId - The objectId associated with the document being redacted.

baos - The ByteArrayOutputStream representing the PDF object containing our redactions.

newVersion - true if the update will be saved to a new version, otherwise false.

majorVersion - true if the update will be saved to a major version, otherwise false.

addRedactions

public static java.lang.String addRedactions(java.lang.String ticket,
                                             java.lang.String objectId,
                                             EnhancedCompleteObject redactedECO,
                                             java.lang.Boolean newVersion,
                                             java.lang.Boolean majorVersion)

Updates the document represented by objectId with the redactedECO

Parameters:

ticket - A valid OC ticket.

objectId - The objectId of the PDF object that is being updated with redactions.

redactedECO - The EnhancedCompleteObject representing our redacted content.

newVersion - true if the update will be saved to a new version, otherwise false.

majorVersion - true if the update will be saved to a major version, otherwise false.

Returns:

objectId the object id of the redacted document because in certain repos redacting a document can change the object id

createRedactedECO

public static EnhancedCompleteObject createRedactedECO(java.io.ByteArrayOutputStream baos)

Helper-method that returns an object representing our redacted content

Parameters:

baos - The ByteArrayOutputStream representing the PDF object containing our redactions.

Returns:

A EnhancedCompleteObject that represents our redacted content

drawRedaction

public static void drawRedaction(java.awt.image.BufferedImage buffImg,
                                 Redaction redaction,
                                 com.itextpdf.text.Rectangle pageRect,
                                 float widthScale,
                                 float heightScale,
                                 int rotation)

Helper-method that draws a redactions onto a buffered image.

Parameters:

buffImg - - The image to be written on to

redaction - - An Annotation object representing the redaction to be drawn

pageRect - - The rectangle representing the area of the page

widthScale - - Factor by which to scale the final image's width

heightScale - - Factor by which to scale the final image's height

rotation - - the rotation of the document from its original orientation

checkForPreviousRedaction

public static java.lang.String checkForPreviousRedaction(java.lang.String ticket,
                                                         java.lang.String objectId,
                                                         RedactionConfig redactionConfig)

Helper-method that determines whether or not the passed in objectId has any previous redactions associated with it

Parameters:

ticket - A valid OC ticket.

objectId - The objectId of the PDF object to create redactions for.

redactionConfig - The redactionConfig providing the configuration options for redaction.

Returns:

A string of the objectId that was previously redacted, blank string if no previous redaction was found

drawTextRedact

public static com.aspose.pdf.Document drawTextRedact(com.aspose.pdf.TextFragmentCollection textFragmentCollection,
                                                     java.lang.String replacement,
                                                     com.aspose.pdf.Document pdfDocument)

Helper that redacts a textFragment from a PDF

Parameters:

textFragmentCollection - - the collection of textFragments that we will redact from the pdfDocument

replacement - - the String replacement that will be used to replace the textFragment

pdfDocument - - the Document that will be redacted

Returns:

the redacted pdfDocument

applyRedactionRectangles

public static com.aspose.pdf.Document applyRedactionRectangles(EnhancedObjectContent unRedactedPdf,
                                                               java.lang.String ticket,
                                                               java.lang.String objectId,
                                                               Redaction[] redactions,
                                                               java.util.List<Redaction> failedRedactions,
                                                               java.lang.String redactionFont)

Function that both burns in redaction rectangles and scrubs the text behind said rectangles

Parameters:

unRedactedPdf - - EnhancedObjectContent of unredacted PDF

ticket - - a valid OC ticket

objectId - - the objectId of the document being redacted

redactions - - an array of redactions that will be iterated over and burned in

redaction - font - font to use for redaction

Returns:

the pdfDocument that has had the rectangles burned in

getReplacementString

public static java.lang.String getReplacementString(java.lang.String toRedact)

Helper takes an input string and returns an estimated equal redaction string of asterisks

Parameters:

toRedact - - the string that will be replaced by asterisks

Returns:

replacement string of equal width