Package eu.europa.esig.dss.pdf.pdfbox

Class PdfBoxUtils

java.lang.Object

eu.europa.esig.dss.pdf.pdfbox.PdfBoxUtils

public final class PdfBoxUtils
extends Object

Contains a set of utils for PdfBox implementation

Method Summary

Modifier and Type	Method	Description
static org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary	createSignatureAppearanceDictionary(org.apache.pdfbox.pdmodel.PDDocument pdDocument, org.apache.pdfbox.pdmodel.common.PDRectangle pdRectangle)	This method creates a generic Appearance dictionary, containing a Normal Appearance
static BufferedImage	generateBufferedImageScreenshot(DSSDocument pdfDocument, char[] passwordProtection, int page)	Deprecated. since DSS 6.2.
static BufferedImage	generateBufferedImageScreenshot(DSSDocument pdfDocument, String passwordProtection, int page)	Deprecated. since DSS 6.2.
static DSSDocument	generateScreenshot(DSSDocument pdfDocument, char[] passwordProtection, int page)	Deprecated. since DSS 6.2.
static DSSDocument	generateScreenshot(DSSDocument pdfDocument, char[] passwordProtection, int page, DSSResourcesHandler dssResourcesHandler)	Deprecated. since DSS 6.2.
static DSSDocument	generateScreenshot(DSSDocument pdfDocument, int page)	Deprecated. since DSS 6.2.
static DSSDocument	generateScreenshot(DSSDocument pdfDocument, String passwordProtection, int page)	Deprecated. since DSS 6.2.
static DSSDocument	generateScreenshot(DSSDocument pdfDocument, String passwordProtection, int page, DSSResourcesHandler dssResourcesHandler)	Deprecated. since DSS 6.2.
static DSSDocument	generateSubtractionImage(DSSDocument document1, char[] passwordDocument1, int pageDocument1, DSSDocument document2, char[] passwordDocument2, int pageDocument2)	Deprecated. since DSS 6.2.
static DSSDocument	generateSubtractionImage(DSSDocument document1, char[] passwordDocument1, int pageDocument1, DSSDocument document2, char[] passwordDocument2, int pageDocument2, DSSResourcesHandler dssResourcesHandler)	Deprecated. since DSS 6.2.
static DSSDocument	generateSubtractionImage(DSSDocument document1, DSSDocument document2, int page)	Deprecated. since DSS 6.2.
static DSSDocument	generateSubtractionImage(DSSDocument document1, String passwordDocument1, int pageDocument1, DSSDocument document2, String passwordDocument2, int pageDocument2)	Deprecated. since DSS 6.2.
static DSSDocument	generateSubtractionImage(DSSDocument document1, String passwordDocument1, int pageDocument1, DSSDocument document2, String passwordDocument2, int pageDocument2, DSSResourcesHandler dssResourcesHandler)	Deprecated. since DSS 6.2.
static DSSDocument	generateSubtractionImage(BufferedImage screenshotDoc1, BufferedImage screenshotDoc2)	This method returns an image representing a subtraction result between screenshotDoc1 and screenshotDoc2.
static DSSDocument	generateSubtractionImage(BufferedImage screenshotDoc1, BufferedImage screenshotDoc2, DSSResourcesHandler dssResourcesHandler)	This method returns an image representing a subtraction result between screenshotDoc1 and screenshotDoc2.
static org.apache.pdfbox.io.MemoryUsageSetting	getMemoryUsageSetting(PdfMemoryUsageSetting pdfMemoryUsageSetting)	It converts generic PdfMemoryUsageSetting to PDF Box domain

Methods inherited from class java.lang.Object

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

Method Details

generateScreenshot

@Deprecated
public static DSSDocument generateScreenshot(DSSDocument pdfDocument,
 int page)

Deprecated.

since DSS 6.2. Please use a corresponding method in PdfBoxScreenshotBuilder instead.

Generates a screenshot image of the specified page for the given PDF document

Parameters:

pdfDocument - DSSDocument to generate screenshot for

page - a page number

Returns:

DSSDocument PNG screenshot

generateScreenshot

@Deprecated
public static DSSDocument generateScreenshot(DSSDocument pdfDocument,
 String passwordProtection,
 int page)

Deprecated.

since DSS 6.2. Please use a corresponding method in PdfBoxScreenshotBuilder instead.

Generates a screenshot image of the specified page for the given PDF document

Parameters:

pdfDocument - DSSDocument to generate screenshot for

passwordProtection - String a PDF password protection phrase

page - a page number

Returns:

DSSDocument PNG screenshot

generateScreenshot

@Deprecated
public static DSSDocument generateScreenshot(DSSDocument pdfDocument,
 char[] passwordProtection,
 int page)

Deprecated.

since DSS 6.2. Please use a corresponding method in PdfBoxScreenshotBuilder instead.

Generates a screenshot image of the specified page for the given PDF document

Parameters:

pdfDocument - DSSDocument to generate screenshot for

passwordProtection - a PDF password protection phrase

page - a page number

Returns:

DSSDocument PNG screenshot

generateScreenshot

@Deprecated
public static DSSDocument generateScreenshot(DSSDocument pdfDocument,
 String passwordProtection,
 int page,
 DSSResourcesHandler dssResourcesHandler)

Deprecated.

since DSS 6.2. Please use a corresponding method in PdfBoxScreenshotBuilder instead.

Generates a screenshot image of the specified page for the given PDF document using a provided eu.europa.esig.dss.signature.resources.DSSResourcesHandler

Parameters:

pdfDocument - DSSDocument to generate screenshot for

passwordProtection - String a PDF password protection phrase

page - a page number

dssResourcesHandler - DSSResourcesHandler

Returns:

DSSDocument PNG screenshot

generateScreenshot

@Deprecated
public static DSSDocument generateScreenshot(DSSDocument pdfDocument,
 char[] passwordProtection,
 int page,
 DSSResourcesHandler dssResourcesHandler)

Deprecated.

since DSS 6.2. Please use a corresponding method in PdfBoxScreenshotBuilder instead.

Generates a screenshot image of the specified page for the given PDF document using a provided eu.europa.esig.dss.signature.resources.DSSResourcesHandler

Parameters:

pdfDocument - DSSDocument to generate screenshot for

passwordProtection - a PDF password protection phrase

page - a page number

dssResourcesHandler - DSSResourcesHandler

Returns:

DSSDocument PNG screenshot

generateBufferedImageScreenshot

@Deprecated
public static BufferedImage generateBufferedImageScreenshot(DSSDocument pdfDocument,
 String passwordProtection,
 int page)

Deprecated.

since DSS 6.2. Please use a corresponding method in PdfBoxScreenshotBuilder instead.

The method generates a BufferedImage for the specified page of the document with String password

Parameters:

pdfDocument - DSSDocument to generate screenshot for

passwordProtection - String a PDF password protection phrase

page - a page number to be generates (starts from 1)

Returns:

BufferedImage

generateBufferedImageScreenshot

@Deprecated
public static BufferedImage generateBufferedImageScreenshot(DSSDocument pdfDocument,
 char[] passwordProtection,
 int page)

Deprecated.

since DSS 6.2. Please use a corresponding method in PdfBoxScreenshotBuilder instead.

The method generates a BufferedImage for the specified page of the document

Parameters:

pdfDocument - DSSDocument to generate screenshot for

passwordProtection - a PDF password protection phrase

page - a page number to be generates (starts from 1)

Returns:

BufferedImage

generateSubtractionImage

@Deprecated
public static DSSDocument generateSubtractionImage(DSSDocument document1,
 DSSDocument document2,
 int page)

Deprecated.

since DSS 6.2. Please use PdfBoxScreenshotBuilder to generate BufferedImage screenshots for document pages and compare them using generateSubtractionImage(BufferedImage screenshotDoc1, BufferedImage screenshotDoc2, DSSResourcesHandler dssResourcesHandler) method

This method returns an image representing a subtraction result between document1 and document2 for the given page number

Parameters:

document1 - DSSDocument

document2 - DSSDocument

page - page number

Returns:

DSSDocument subtraction result

generateSubtractionImage

@Deprecated
public static DSSDocument generateSubtractionImage(DSSDocument document1,
 String passwordDocument1,
 int pageDocument1,
 DSSDocument document2,
 String passwordDocument2,
 int pageDocument2)

Deprecated.

since DSS 6.2. Please use PdfBoxScreenshotBuilder to generate BufferedImage screenshots for document pages and compare them using generateSubtractionImage(BufferedImage screenshotDoc1, BufferedImage screenshotDoc2, DSSResourcesHandler dssResourcesHandler) method

This method returns an image representing a subtraction result between document1 and document2 for the defined pages

Parameters:

document1 - DSSDocument the first document

passwordDocument1 - String a password protection for the document1 when applicable (can be null)

pageDocument1 - page number identifying a page of the document1 to be proceeded

document2 - DSSDocument the second document

passwordDocument2 - String a password protection for the document2 when applicable (can be null)

pageDocument2 - page number identifying a page of the document2 to be proceeded

Returns:

DSSDocument subtraction result

generateSubtractionImage

@Deprecated
public static DSSDocument generateSubtractionImage(DSSDocument document1,
 char[] passwordDocument1,
 int pageDocument1,
 DSSDocument document2,
 char[] passwordDocument2,
 int pageDocument2)

Deprecated.

since DSS 6.2. Please use PdfBoxScreenshotBuilder to generate BufferedImage screenshots for document pages and compare them using generateSubtractionImage(BufferedImage screenshotDoc1, BufferedImage screenshotDoc2, DSSResourcesHandler dssResourcesHandler) method

This method returns an image representing a subtraction result between document1 and document2 for the defined pages

Parameters:

document1 - DSSDocument the first document

passwordDocument1 - a password protection for the document1 when applicable (can be null)

pageDocument1 - page number identifying a page of the document1 to be proceeded

document2 - DSSDocument the second document

passwordDocument2 - a password protection for the document2 when applicable (can be null)

pageDocument2 - page number identifying a page of the document2 to be proceeded

Returns:

DSSDocument subtraction result

generateSubtractionImage

@Deprecated
public static DSSDocument generateSubtractionImage(DSSDocument document1,
 String passwordDocument1,
 int pageDocument1,
 DSSDocument document2,
 String passwordDocument2,
 int pageDocument2,
 DSSResourcesHandler dssResourcesHandler)

Deprecated.

since DSS 6.2. Please use PdfBoxScreenshotBuilder to generate BufferedImage screenshots for document pages and compare them using generateSubtractionImage(BufferedImage screenshotDoc1, BufferedImage screenshotDoc2, DSSResourcesHandler dssResourcesHandler) method

This method returns an image representing a subtraction result between document1 and document2 for the defined pages. This method uses a provided DSSResourcesHandler

Parameters:

document1 - DSSDocument the first document

passwordDocument1 - String a password protection for the document1 when applicable (can be null)

pageDocument1 - page number identifying a page of the document1 to be proceeded

document2 - DSSDocument the second document

passwordDocument2 - String a password protection for the document2 when applicable (can be null)

pageDocument2 - page number identifying a page of the document2 to be proceeded

dssResourcesHandler - DSSResourcesHandler to be used

Returns:

DSSDocument subtraction result

generateSubtractionImage

@Deprecated
public static DSSDocument generateSubtractionImage(DSSDocument document1,
 char[] passwordDocument1,
 int pageDocument1,
 DSSDocument document2,
 char[] passwordDocument2,
 int pageDocument2,
 DSSResourcesHandler dssResourcesHandler)

Deprecated.

since DSS 6.2. Please use PdfBoxScreenshotBuilder to generate BufferedImage screenshots for document pages and compare them using generateSubtractionImage(BufferedImage screenshotDoc1, BufferedImage screenshotDoc2, DSSResourcesHandler dssResourcesHandler) method

This method returns an image representing a subtraction result between document1 and document2 for the defined pages. This method uses a provided DSSResourcesHandler

Parameters:

document1 - DSSDocument the first document

passwordDocument1 - a password protection for the document1 when applicable (can be null)

pageDocument1 - page number identifying a page of the document1 to be proceeded

document2 - DSSDocument the second document

passwordDocument2 - a password protection for the document2 when applicable (can be null)

pageDocument2 - page number identifying a page of the document2 to be proceeded

dssResourcesHandler - DSSResourcesHandler to be used

Returns:

DSSDocument subtraction result

generateSubtractionImage

public static DSSDocument generateSubtractionImage(BufferedImage screenshotDoc1,
 BufferedImage screenshotDoc2)

This method returns an image representing a subtraction result between screenshotDoc1 and screenshotDoc2. This method uses a default in-memory DSSResourcesHandler

Parameters:

screenshotDoc1 - BufferedImage the first screenshot to compare

screenshotDoc2 - BufferedImage the second screenshot to compare with

Returns:

DSSDocument subtraction result

generateSubtractionImage

public static DSSDocument generateSubtractionImage(BufferedImage screenshotDoc1,
 BufferedImage screenshotDoc2,
 DSSResourcesHandler dssResourcesHandler)

This method returns an image representing a subtraction result between screenshotDoc1 and screenshotDoc2. This method uses a provided DSSResourcesHandler.

Parameters:

screenshotDoc1 - BufferedImage the first screenshot to compare

screenshotDoc2 - BufferedImage the second screenshot to compare with

dssResourcesHandler - DSSResourcesHandler to be used

Returns:

DSSDocument subtraction result

createSignatureAppearanceDictionary

public static org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary createSignatureAppearanceDictionary(org.apache.pdfbox.pdmodel.PDDocument pdDocument,
 org.apache.pdfbox.pdmodel.common.PDRectangle pdRectangle)

This method creates a generic Appearance dictionary, containing a Normal Appearance

Parameters:

pdDocument - PDDocument to create a new Appearance dictionary in

pdRectangle - PDRectangle used for annotation dictionary

Returns:

PDAppearanceDictionary

getMemoryUsageSetting

public static org.apache.pdfbox.io.MemoryUsageSetting getMemoryUsageSetting(PdfMemoryUsageSetting pdfMemoryUsageSetting)

It converts generic PdfMemoryUsageSetting to PDF Box domain

Parameters:

pdfMemoryUsageSetting - PdfMemoryUsageSetting

Returns:

MemoryUsageSetting