Package eu.europa.esig.dss.pdf

Class AbstractPDFSignatureService

java.lang.Object

eu.europa.esig.dss.pdf.AbstractPDFSignatureService

All Implemented Interfaces:

PDFSignatureService

Direct Known Subclasses:

ITextPDFSignatureService, PdfBoxSignatureService

public abstract class AbstractPDFSignatureService
extends Object
implements PDFSignatureService

Field Summary

Fields

Modifier and Type	Field	Description
protected PDFServiceMode	serviceMode
protected SignatureDrawerFactory	signatureDrawerFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPDFSignatureService(PDFServiceMode serviceMode, SignatureDrawerFactory signatureDrawerFactory)	Constructor for the PDFSignatureService

Method Summary

Modifier and Type	Method	Description
DSSDocument	addDssDictionary(DSSDocument document, List<DSSDictionaryCallback> callbacks)	This method adds the DSS dictionary (Baseline-LT)
DSSDocument	addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters)	This method allows to add a new signature field to an existing pdf document
protected Map<String,Long>	buildKnownObjects(List<DSSDictionaryCallback> callbacks)	This method builds a Map of known Objects (extracted from previous DSS Dictionaries).
protected abstract void	checkDocumentPermissions(DSSDocument toSignDocument, String pwd)	This method checks if the document is not encrypted or with limited edition rights
protected byte[]	extractBeforeSignatureValue(ByteRange byteRange, byte[] signedContent)
List<String>	getAvailableSignatureFields(DSSDocument document)	This method returns not signed signature-fields
List<PdfRevision>	getRevisions(DSSDocument document, String pwd)	Retrieves revisions from a PDF document
protected byte[]	getSignatureValue(DSSDocument dssDocument, ByteRange byteRange)
protected String	getTokenDigest(Token token)
protected String	getType()
protected boolean	isContentValueEqualsByteRangeExtraction(DSSDocument document, ByteRange byteRange, byte[] cms, List<String> signatureFieldNames)
protected boolean	isDocTimestamp(PdfSignatureDictionary pdfSigDict)	Checks if the given signature dictionary represents a DocTimeStamp
protected boolean	isDocumentTimestampLayer()
protected boolean	isSignature(PdfSignatureDictionary pdfSigDict)	Checks if the given signature dictionary represents a Signature
protected abstract PdfDocumentReader	loadPdfDocumentReader(byte[] binaries, String passwordProtection)	Loads PdfDocumentReader instance
protected abstract PdfDocumentReader	loadPdfDocumentReader(DSSDocument dssDocument, String passwordProtection)	Loads PdfDocumentReader instance

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.europa.esig.dss.pdf.PDFSignatureService

addDssDictionary, addNewSignatureField, digest, getAvailableSignatureFields, sign

Field Details

serviceMode

protected final PDFServiceMode serviceMode

signatureDrawerFactory

protected final SignatureDrawerFactory signatureDrawerFactory

Constructor Details

AbstractPDFSignatureService

protected AbstractPDFSignatureService(PDFServiceMode serviceMode, SignatureDrawerFactory signatureDrawerFactory)

Constructor for the PDFSignatureService

Parameters:

serviceMode - current instance is used to generate DocumentTypestamp or Signature signature layer

signatureDrawerFactory - the factory of SignatureDrawer

Method Details

isDocumentTimestampLayer

protected boolean isDocumentTimestampLayer()

getType

protected String getType()

checkDocumentPermissions

protected abstract void checkDocumentPermissions(DSSDocument toSignDocument, String pwd)

This method checks if the document is not encrypted or with limited edition rights

Parameters:

toSignDocument - the document which will be modified

pwd - String password protection phrase used to encrypt the document

getRevisions

public List<PdfRevision> getRevisions(DSSDocument document, String pwd)

Description copied from interface: PDFSignatureService

Retrieves revisions from a PDF document

Specified by:

getRevisions in interface PDFSignatureService

Parameters:

document - the document to extract revisions from

pwd - the password protection phrase used to encrypt the PDF document use 'null' value for not an encrypted document

Returns:

list of extracted PdfRevisions

addDssDictionary

public DSSDocument addDssDictionary(DSSDocument document, List<DSSDictionaryCallback> callbacks)

Description copied from interface: PDFSignatureService

This method adds the DSS dictionary (Baseline-LT)

Specified by:

addDssDictionary in interface PDFSignatureService

Parameters:

document - the document to be extended

callbacks - the callbacks to retrieve the revocation data,...

Returns:

the pdf document with the added dss dictionary

getAvailableSignatureFields

public List<String> getAvailableSignatureFields(DSSDocument document)

Description copied from interface: PDFSignatureService

This method returns not signed signature-fields

Specified by:

getAvailableSignatureFields in interface PDFSignatureService

Parameters:

document - the pdf document

Returns:

the list of empty signature fields

addNewSignatureField

public DSSDocument addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters)

Description copied from interface: PDFSignatureService

This method allows to add a new signature field to an existing pdf document

Specified by:

addNewSignatureField in interface PDFSignatureService

Parameters:

document - the pdf document

parameters - the parameters with the coordinates,... of the signature field

Returns:

the pdf document with the new added signature field

loadPdfDocumentReader

protected abstract PdfDocumentReader loadPdfDocumentReader(DSSDocument dssDocument, String passwordProtection) throws IOException, InvalidPasswordException

Loads PdfDocumentReader instance

Parameters:

dssDocument - DSSDocument to read

passwordProtection - String the password used to protect the document

Throws:

IOException - in case of loading error

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

loadPdfDocumentReader

protected abstract PdfDocumentReader loadPdfDocumentReader(byte[] binaries, String passwordProtection) throws IOException, InvalidPasswordException

Loads PdfDocumentReader instance

Parameters:

binaries - a byte array

passwordProtection - String the password used to protect the document

Throws:

IOException - in case of loading error

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

isContentValueEqualsByteRangeExtraction

protected boolean isContentValueEqualsByteRangeExtraction(DSSDocument document, ByteRange byteRange, byte[] cms, List<String> signatureFieldNames)

getSignatureValue

protected byte[] getSignatureValue(DSSDocument dssDocument, ByteRange byteRange) throws IOException

Throws:

IOException

extractBeforeSignatureValue

protected byte[] extractBeforeSignatureValue(ByteRange byteRange, byte[] signedContent)

isDocTimestamp

protected boolean isDocTimestamp(PdfSignatureDictionary pdfSigDict)

Checks if the given signature dictionary represents a DocTimeStamp

Parameters:

pdfSigDict - PdfSignatureDictionary to check

Returns:

TRUE if the signature dictionary represents a DocTimeStamp, FALSE otherwise

isSignature

protected boolean isSignature(PdfSignatureDictionary pdfSigDict)

Checks if the given signature dictionary represents a Signature

Parameters:

pdfSigDict - PdfSignatureDictionary to check

Returns:

TRUE if the signature dictionary represents a Signature, FALSE otherwise

buildKnownObjects

protected Map<String,Long> buildKnownObjects(List<DSSDictionaryCallback> callbacks)

This method builds a Map of known Objects (extracted from previous DSS Dictionaries). This map will be used to avoid duplicate the same objects between layers.

Parameters:

callbacks -

Returns:

getTokenDigest

protected String getTokenDigest(Token token)