com.tsgrp.opencontent.core.pdf

Class PDFUtil

java.lang.Object

com.tsgrp.opencontent.core.pdf.PDFUtil

public class PDFUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	RANGE_DELIMITER

Constructor Summary

Constructors

Constructor and Description
PDFUtil()

Method Summary

Modifier and Type	Method and Description
static void	addAutoPrint(java.io.InputStream pdfStream, java.io.OutputStream outputStream) Adds a piece of javascript to the PDF, that will cause it to print when opened in a browser's viewer.
static void	addPdfToOutput(com.itextpdf.text.pdf.PdfReader pdfReader, com.itextpdf.text.pdf.PdfCopy writer) Add an entire pdf to an existing pdf writer
static org.apache.commons.io.output.ByteArrayOutputStream	appendPDFSigPage(com.itextpdf.text.pdf.PdfReader content, com.itextpdf.text.pdf.PdfReader sigPage, int legacyNumOfSigPages) Static method that appends a signature page to a document.
static boolean	canBeRead(java.lang.String ticket, java.lang.String objectId) Checks if the content of a pdf can be read.
static void	concatPDFs(java.util.List<com.itextpdf.text.pdf.PdfReader> pdfFileReaders, java.io.OutputStream baos, java.util.Map<java.lang.String,java.lang.String> headers) Static method that combines PDFS into a new file.
static java.io.ByteArrayOutputStream	encryptPdf(java.io.ByteArrayOutputStream os) Encrypts a pdf output stream This function defaults the encrypted document to print permissions and AESx256 encryption.
static java.io.ByteArrayOutputStream	encryptPdf(java.io.ByteArrayOutputStream os, java.lang.String password, int permissions, int algorithm) Encrypts a ByteArrayOutputStream representation of a pdf Sets the encryption password, permissions, and algorithm to the parameter values.
static java.io.InputStream	encryptPdf(java.io.InputStream originalPdf) Encrypts a pdf input stream This function defaults the encrypted document to print permissions and AESx256 encryption.
static void	encryptPdf(java.io.InputStream originalPdf, java.io.OutputStream resp) Encrypts a pdf input stream, and saves content to an output stream Defaults the encrypted document to print permissions and AESx256 encryption.
static java.io.InputStream	encryptPdf(java.io.InputStream originalPdf, java.lang.String password, int permissions, int algorithm) Encrypts a pdf input stream Sets the encryption password, permissions, and algorithm to the parameter values.
static byte[]	flateFilterDecode(byte[] decodedAttachment) Decodes the data with a Flate filter.
static byte[]	flateFilterEncode(byte[] fileContent) Encodes the data with a Flate filter.
static org.apache.commons.io.output.ByteArrayOutputStream	generateTimelinePdf(float duration) Generates a new vertical timeline PDF using the 'one minute per-page' rules.
static com.aspose.pdf.Document	getAsposeDocument(java.lang.String ticket, java.lang.String objectId) Generates an Aspose Document.
static int	getPageCount(java.io.InputStream is) Get the number of pages for a pdf
static org.apache.pdfbox.pdmodel.PDDocument	getPDDcoument(java.lang.String ticket, java.lang.String objectId, long lastModified) Generates a PDDocument for PDFBox operations.
static com.itextpdf.text.pdf.PdfReader	getPdfReader(java.lang.String ticket, java.lang.String objectId, long lastModified) Generates a PDFReader for iText operations.
static org.apache.commons.io.output.ByteArrayOutputStream	getPDFSection(java.io.InputStream is, org.apache.commons.io.output.ByteArrayOutputStream baos, java.lang.String pageRangeString) Splits the pdf given by the input stream according to the page ranges passed in.
static java.util.ArrayList<java.lang.Integer>	getSelectedPageNumbersList(java.lang.String selectedPageNumbers) Build and return a list of page numbers based on the user input.
static org.apache.commons.io.output.ByteArrayOutputStream	getSelectedPagesFromPdf(java.io.InputStream is, java.util.ArrayList<java.lang.Integer> selectedPages) Create a new pdf based off of the selected pages of the passed in pdf
static java.lang.String	getTextByArea(java.lang.String ticket, java.lang.String objectId, int pageNumber, float[][] selectionAreas) A method that will modify the pdf, first by rotating pages, and second by reordering them
byte[]	manipulatePDF(java.lang.String ticket, byte[] ba, EnhancedCompleteObject eco, java.util.Map<java.lang.String,java.lang.Object> params) Hotspot method that allows a user to overwrite and manipulate the PDF as needed.
java.io.InputStream	manipulatePDF(java.lang.String ticket, java.io.InputStream is, EnhancedCompleteObject eco, java.util.Map<java.lang.String,java.lang.Object> params) Hotspot method that allows a user to overwrite and manipulate the PDF as needed.
static java.lang.String	modifyPdf(java.lang.String ticket, java.lang.String objectId, java.util.ArrayList<java.lang.Integer> pageOrder, java.util.ArrayList<java.lang.Integer> pageRotations, java.lang.Boolean newVersion, java.lang.Boolean majorVersion, java.lang.String documentVersion, java.lang.Long lastModified) A method that will modify the pdf, first by rotating pages, and second by reordering them
static org.apache.commons.io.output.ByteArrayOutputStream	removePDFPages(com.itextpdf.text.pdf.PdfReader pdfFileReader, org.apache.commons.io.output.ByteArrayOutputStream result, int startPage, int endPage) Remove pages from pdf within the start and endPages
static void	reorderPages(com.itextpdf.text.pdf.PdfReader reader, java.util.ArrayList<java.lang.Integer> pageOrder) Method to reorder pages in a pdf
static boolean	reorderPdfPages(java.lang.String ticket, java.lang.String objectId, java.util.ArrayList<java.lang.Integer> pages, java.lang.Boolean newVersion, java.lang.Boolean majorVersion, java.lang.Long lastModified) A method that will reorder the pages in a pdf.
static void	rotatePdfPages(com.itextpdf.text.pdf.PdfReader reader, java.util.ArrayList<java.lang.Integer> pageRotations) A method that will rotate some, or all, of the pages of a given pdf
static boolean	rotatePdfPages(java.lang.String ticket, java.lang.String objectId, java.util.ArrayList<java.lang.Integer> pageRotations, java.lang.Boolean newVersion, java.lang.Boolean majorVersion, long lastModified) A method that will rotate some, or all of the pages of an object with PDF content.
static boolean	writeOutput(com.itextpdf.text.pdf.PdfReader reader, java.lang.String ticket, java.lang.String objectId, boolean newVersion, boolean majorVersion) Takes in a PdfReader, and writes the output to the a document in the repository

Methods inherited from class java.lang.Object

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

Field Detail

RANGE_DELIMITER

protected static final java.lang.String RANGE_DELIMITER

See Also:

Constant Field Values

Constructor Detail

PDFUtil

public PDFUtil()

Method Detail

concatPDFs

public static void concatPDFs(java.util.List<com.itextpdf.text.pdf.PdfReader> pdfFileReaders,
                              java.io.OutputStream baos,
                              java.util.Map<java.lang.String,java.lang.String> headers)

Static method that combines PDFS into a new file. returns null if an error is found

Parameters:

pdfFileReaders - - The pdfreaders containing pdf files to combine.

baos - - The outputStream of the new PDF

headers - - a map of optional headers to add

removePDFPages

public static org.apache.commons.io.output.ByteArrayOutputStream removePDFPages(com.itextpdf.text.pdf.PdfReader pdfFileReader,
                                                                                org.apache.commons.io.output.ByteArrayOutputStream result,
                                                                                int startPage,
                                                                                int endPage)
                                                                         throws java.lang.Exception

Remove pages from pdf within the start and endPages

Parameters:

pdfFileReader - - The pdfReader with pdf file to remove pages from.

result - - The outputStream of the new PDF

startPage - - The page to start removing pages.

endPage - - The page to end removing pages

Throws:

java.lang.Exception

manipulatePDF

public java.io.InputStream manipulatePDF(java.lang.String ticket,
                                         java.io.InputStream is,
                                         EnhancedCompleteObject eco,
                                         java.util.Map<java.lang.String,java.lang.Object> params)

Hotspot method that allows a user to overwrite and manipulate the PDF as needed. This impl simply returns the inputStream unchanged, clients may override this method.

Parameters:

ticket -

is -

eco -

params -

Returns:

new inputStream

manipulatePDF

public byte[] manipulatePDF(java.lang.String ticket,
                            byte[] ba,
                            EnhancedCompleteObject eco,
                            java.util.Map<java.lang.String,java.lang.Object> params)
                     throws java.io.IOException

Hotspot method that allows a user to overwrite and manipulate the PDF as needed. converts the given byte[] to an input stream and calls manipulatePDF(String, InputStream, EnhancedCompleteObject, Map) and returns the byte[] unchanged. This method should not normally be overwritten by client impls, manipulatePDF(String, InputStream, EnhancedCompleteObject, Map) should be the method to overwrite.

Parameters:

ticket -

ba -

eco -

params -

Returns:

new byte[]

Throws:

java.io.IOException

getPDFSection

public static org.apache.commons.io.output.ByteArrayOutputStream getPDFSection(java.io.InputStream is,
                                                                               org.apache.commons.io.output.ByteArrayOutputStream baos,
                                                                               java.lang.String pageRangeString)

Splits the pdf given by the input stream according to the page ranges passed in. Retuns only the content of the specified pages (or null if there was an error).

Parameters:

is - InputStream of the base pdf to get pages from

baos - Output stream to write pages to

pageRangeString - Range of pages to read

Returns:

appendPDFSigPage

public static org.apache.commons.io.output.ByteArrayOutputStream appendPDFSigPage(com.itextpdf.text.pdf.PdfReader content,
                                                                                  com.itextpdf.text.pdf.PdfReader sigPage,
                                                                                  int legacyNumOfSigPages)

Static method that appends a signature page to a document. If there is already a sig page removes it and adds the new one.

Parameters:

content - - The pdfreader containing the pdf file of the document.

sigPage - - The pdfreader containing the pdf file of the signature page

legacyNumOfSigPages - - number of signature pages that already exist grabbed from the docInfo (legacy). Pass in 0 if this is not legacy or the doc has no legacy sig page.

Returns:

getPageCount

public static int getPageCount(java.io.InputStream is)

Get the number of pages for a pdf

Parameters:

is - pdf input stream

Returns:

the number of pages in the pdf

getSelectedPagesFromPdf

public static org.apache.commons.io.output.ByteArrayOutputStream getSelectedPagesFromPdf(java.io.InputStream is,
                                                                                         java.util.ArrayList<java.lang.Integer> selectedPages)

Create a new pdf based off of the selected pages of the passed in pdf

Parameters:

is - - Input stream of the pdf

selectedPages - - list of page numbers to get from the pdf

Returns:

ByteArrayOutputStream a new pdf with the selected pages of passed in pdf

getSelectedPageNumbersList

public static java.util.ArrayList<java.lang.Integer> getSelectedPageNumbersList(java.lang.String selectedPageNumbers)

Build and return a list of page numbers based on the user input. Currently supports page ranges and individual pages separated by commas ex: 1,2,3,5-10

Parameters:

selectedPageNumbers - - user input for selected pages

Returns:

list of the selected pages

addPdfToOutput

public static void addPdfToOutput(com.itextpdf.text.pdf.PdfReader pdfReader,
                                  com.itextpdf.text.pdf.PdfCopy writer)

Add an entire pdf to an existing pdf writer

Parameters:

pdfReader -

writer -

generateTimelinePdf

public static org.apache.commons.io.output.ByteArrayOutputStream generateTimelinePdf(float duration)

Generates a new vertical timeline PDF using the 'one minute per-page' rules.

Parameters:

duration - - The total amount of time to generate a PDF for

getPdfReader

public static com.itextpdf.text.pdf.PdfReader getPdfReader(java.lang.String ticket,
                                                           java.lang.String objectId,
                                                           long lastModified)

Generates a PDFReader for iText operations.

Parameters:

ticket - A valid OC ticket.

objectId - The id of the repo object we want a PDFReader for.

lastModified - The last modified date of the content we're fetching. Used for caching purposes.

Returns:

An iText PDFReader

writeOutput

public static boolean writeOutput(com.itextpdf.text.pdf.PdfReader reader,
                                  java.lang.String ticket,
                                  java.lang.String objectId,
                                  boolean newVersion,
                                  boolean majorVersion)

Takes in a PdfReader, and writes the output to the a document in the repository

Parameters:

reader - - PdfReader a PdfReader for the document to be modified

ticket - - String a valid OC ticket

objectId - - String the id of the object to be modified

newVersion - - boolean when true, the object will be updated to a new, minor version

majorVersion - - boolean when true, the object will be updated to a major version

Returns:

boolean indicating if updating the object was successfull

rotatePdfPages

public static boolean rotatePdfPages(java.lang.String ticket,
                                     java.lang.String objectId,
                                     java.util.ArrayList<java.lang.Integer> pageRotations,
                                     java.lang.Boolean newVersion,
                                     java.lang.Boolean majorVersion,
                                     long lastModified)

A method that will rotate some, or all of the pages of an object with PDF content.

Parameters:

ticket - - A valid OC ticket.

objectId - - The object id of the object whose pages we want to rotate. Must have PDF content.

pageRotations - - An array of integers, one per page of the PDF, specifying how many degrees clockwise to rotate it.

newVersion - -true if the a new version of the document will be created when the document is modified. if false, the document in the repository will remain the same version when modified

majorVersion - - true if the a major version of the document will be created when the document is modified. if false, the document in the repository will default to a minor version when modified

Throws:

com.itextpdf.text.DocumentException

rotatePdfPages

public static void rotatePdfPages(com.itextpdf.text.pdf.PdfReader reader,
                                  java.util.ArrayList<java.lang.Integer> pageRotations)

A method that will rotate some, or all, of the pages of a given pdf

Parameters:

reader - - a pdfreader that will be used to rotate the page

pageRotations - - An array of integers, one per page of the PDF, specifying how many degrees clockwise to rotate it.

reorderPdfPages

public static boolean reorderPdfPages(java.lang.String ticket,
                                      java.lang.String objectId,
                                      java.util.ArrayList<java.lang.Integer> pages,
                                      java.lang.Boolean newVersion,
                                      java.lang.Boolean majorVersion,
                                      java.lang.Long lastModified)

A method that will reorder the pages in a pdf.

Parameters:

ticket - - A valid OC ticket.

objectId - - The object id of the object whose pages we want to rotate. Must have PDF content.

pages -

newVersion - -true if the a new version of the document will be created when the document is modified. if false, the document in the repository will remain the same version when modified

majorVersion - - true if the a major version of the document will be created when the document is modified. if false, the document in the repository will default to a minor version when modified

lastModified -

Returns:

reorderPages

public static void reorderPages(com.itextpdf.text.pdf.PdfReader reader,
                                java.util.ArrayList<java.lang.Integer> pageOrder)

Method to reorder pages in a pdf

Parameters:

reader - - A PdfReader that will change the order of our pages

pageOrder - - An arraylist containing the new pdf order

modifyPdf

public static java.lang.String modifyPdf(java.lang.String ticket,
                                         java.lang.String objectId,
                                         java.util.ArrayList<java.lang.Integer> pageOrder,
                                         java.util.ArrayList<java.lang.Integer> pageRotations,
                                         java.lang.Boolean newVersion,
                                         java.lang.Boolean majorVersion,
                                         java.lang.String documentVersion,
                                         java.lang.Long lastModified)

A method that will modify the pdf, first by rotating pages, and second by reordering them

Parameters:

ticket - - A valid OC ticket

objectId - - The object id for the object we will be modifying

pageOrder - - An arraylist of all the pages of the document in their new order

pageRotations - - An arraylist with a value for each page that indicates how much that page will be rotated

newVersion - - true if the a new version of the document will be created when the document is modified. if false, the document in the repository will remain the same version when modified

majorVersion - - true if the a major version of the document will be created when the document is modified. if false, the document in the repository will default to a minor version when modified

Returns:

- a boolean if the modification was successful

getTextByArea

public static java.lang.String getTextByArea(java.lang.String ticket,
                                             java.lang.String objectId,
                                             int pageNumber,
                                             float[][] selectionAreas)

A method that will modify the pdf, first by rotating pages, and second by reordering them

Parameters:

ticket - - A valid OC ticket

objectId - - The object id for the object we will be modifying

pageNumber - - The page number that the text we are looking to get is on

selectionAreas - - A multidimensional array that contains sets of rectangles

addAutoPrint

public static void addAutoPrint(java.io.InputStream pdfStream,
                                java.io.OutputStream outputStream)

Adds a piece of javascript to the PDF, that will cause it to print when opened in a browser's viewer.

Parameters:

pdfStream - - The byte stream containing the PDF Data.

outputStream - - The byte stream that the new PDF will be written to.

getPDDcoument

public static org.apache.pdfbox.pdmodel.PDDocument getPDDcoument(java.lang.String ticket,
                                                                 java.lang.String objectId,
                                                                 long lastModified)

Generates a PDDocument for PDFBox operations.

Parameters:

ticket - A valid OC ticket.

objectId - The id of the repo object we want a PDDocument for.

lastModified - The last modified date of the content we're fetching. Used for caching purposes.

Returns:

An PDFBox PDDocument

getAsposeDocument

public static com.aspose.pdf.Document getAsposeDocument(java.lang.String ticket,
                                                        java.lang.String objectId)

Generates an Aspose Document.

Parameters:

ticket - A valid OC ticket.

objectId - The id of the repo object we want an Aspose Document for.

Returns:

An Aspose Document

canBeRead

public static boolean canBeRead(java.lang.String ticket,
                                java.lang.String objectId)
                         throws OCObjectLockedException,
                                OCContentFormatException,
                                OCRuntimeException

Checks if the content of a pdf can be read. Catches password protected, corrupt, and other general errors

Parameters:

ticket, - a valid OC ticket

objectId, - the id of the pdf we want to read

Returns:

true, if the pdf was successfully read

Throws:

OCObjectLockedException, - if the pdf is password protected

OCContentFormatException, - if the pdf is corrupt

OCRuntimeException, - if there were other errors when trying to read the pdf

OCObjectLockedException

OCContentFormatException

OCRuntimeException

encryptPdf

public static java.io.InputStream encryptPdf(java.io.InputStream originalPdf)

Encrypts a pdf input stream This function defaults the encrypted document to print permissions and AESx256 encryption. Note: the stream will NOT be encrypted if the password is blank

Parameters:

originalPdf - - the stream containing the pdf to be considered for encryption

Returns:

an encrypted version of the original stream

encryptPdf

public static java.io.InputStream encryptPdf(java.io.InputStream originalPdf,
                                             java.lang.String password,
                                             int permissions,
                                             int algorithm)

Encrypts a pdf input stream Sets the encryption password, permissions, and algorithm to the parameter values. Note: the stream will NOT be encrypted if the password is blank

Parameters:

originalPdf - - the InputStream of the pdf to be encrypted

password - - password used to lock/unlock the document

permissions - - document permissions for user without a password

algorithm - - algorithm to be used for encryption

Returns:

an InputStream containing the pdf content

encryptPdf

public static java.io.ByteArrayOutputStream encryptPdf(java.io.ByteArrayOutputStream os)

Encrypts a pdf output stream This function defaults the encrypted document to print permissions and AESx256 encryption. Note: the stream will NOT be encrypted if the password is blank

Parameters:

os - - the stream containing the pdf to be considered for encryption

Returns:

a ByteArrayOutputStream containing the pdf content (encrypted if enabled)

encryptPdf

public static java.io.ByteArrayOutputStream encryptPdf(java.io.ByteArrayOutputStream os,
                                                       java.lang.String password,
                                                       int permissions,
                                                       int algorithm)

Encrypts a ByteArrayOutputStream representation of a pdf Sets the encryption password, permissions, and algorithm to the parameter values. Note: the stream will NOT be encrypted if the password is blank

Parameters:

os - - a ByteArrayOutputStream containing the pdf content

password - - password used to unlock the document

permissions - - document permissions for user without a password

algorithm - - algorithm to be used for encryption

Returns:

a ByteArrayOutputStream containing the pdf content (encrypted if enabled)

encryptPdf

public static void encryptPdf(java.io.InputStream originalPdf,
                              java.io.OutputStream resp)

Encrypts a pdf input stream, and saves content to an output stream Defaults the encrypted document to print permissions and AESx256 encryption. Note: the stream will NOT be encrypted if the password is blank

Parameters:

originalPdf - - byte array stream containing pdf data

resp - - the stream where the encrypted data will be written

flateFilterEncode

public static byte[] flateFilterEncode(byte[] fileContent)

Encodes the data with a Flate filter.

Parameters:

fileContent - Byte[] that needs to be encoded.

Returns:

The byte[] of the filtered encoded attachment.

flateFilterDecode

public static byte[] flateFilterDecode(byte[] decodedAttachment)

Decodes the data with a Flate filter.

Parameters:

decodedAttachment - Byte[] that is decoded.

Returns:

The byte[] of the filtered decoded attachment.