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

Class PdfBoxDocumentReader

java.lang.Object

eu.europa.esig.dss.pdf.pdfbox.PdfBoxDocumentReader

All Implemented Interfaces:

PdfDocumentReader, Closeable, AutoCloseable

public class PdfBoxDocumentReader
extends Object
implements PdfDocumentReader

Constructor Summary

Constructors

Constructor	Description
PdfBoxDocumentReader(byte[] binaries, String passwordProtection)	The PDFBox implementation of the Reader
PdfBoxDocumentReader(DSSDocument dssDocument)	Default constructor of the PDFBox implementation of the Reader
PdfBoxDocumentReader(DSSDocument dssDocument, String passwordProtection)	The PDFBox implementation of the Reader

Method Summary

Modifier and Type	Method	Description
void	close()
Map<PdfSignatureDictionary,List<String>>	extractSigDictionaries()	Extracts PdfSignatureSictionaries present in the signature
PdfDssDict	getDSSDictionary()	Loads the last DSS dictionary from the document if exists NOTE: can return null if DSS dictionary is not present
boolean	isSignatureCoversWholeDocument(PdfSignatureDictionary signatureDictionary)	Checks if a signature for the given PDF Signature Dictionary covers the whole document

Methods inherited from class java.lang.Object

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

Constructor Details

PdfBoxDocumentReader

public PdfBoxDocumentReader(DSSDocument dssDocument) throws IOException, InvalidPasswordException

Default constructor of the PDFBox implementation of the Reader

Parameters:

dssDocument - DSSDocument to read

Throws:

IOException - if an exception occurs

InvalidPasswordException - if the password is not provided or invalid for a protected document

PdfBoxDocumentReader

public PdfBoxDocumentReader(DSSDocument dssDocument, String passwordProtection) throws IOException, InvalidPasswordException

The PDFBox implementation of the Reader

Parameters:

dssDocument - DSSDocument to read

passwordProtection - String a password to open a protected document

Throws:

IOException - if an exception occurs

InvalidPasswordException - if the password is not provided or invalid for a protected document

PdfBoxDocumentReader

public PdfBoxDocumentReader(byte[] binaries, String passwordProtection) throws IOException, InvalidPasswordException

The PDFBox implementation of the Reader

Parameters:

binaries - a byte array of a PDF to read

passwordProtection - String a password to open a protected document

Throws:

IOException - if an exception occurs

InvalidPasswordException - if the password is not provided or invalid for a protected document

Method Details

getDSSDictionary

public PdfDssDict getDSSDictionary()

Description copied from interface: PdfDocumentReader

Loads the last DSS dictionary from the document if exists NOTE: can return null if DSS dictionary is not present

Specified by:

getDSSDictionary in interface PdfDocumentReader

Returns:

PdfDssDict

extractSigDictionaries

public Map<PdfSignatureDictionary,List<String>> extractSigDictionaries() throws IOException

Description copied from interface: PdfDocumentReader

Extracts PdfSignatureSictionaries present in the signature

Specified by:

extractSigDictionaries in interface PdfDocumentReader

Returns:

a map between PdfSignatureDictionary and related field names

Throws:

IOException - if an exception occurs

isSignatureCoversWholeDocument

public boolean isSignatureCoversWholeDocument(PdfSignatureDictionary signatureDictionary)

Description copied from interface: PdfDocumentReader

Checks if a signature for the given PDF Signature Dictionary covers the whole document

Specified by:

isSignatureCoversWholeDocument in interface PdfDocumentReader

Parameters:

signatureDictionary - PdfSignatureDictionary to check the result for

Returns:

TRUE if the signature covers the whole document, false otherwise

close

public void close() throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException