Package eu.europa.esig.dss.pades.validation

Class PDFDocumentAnalyzer

java.lang.Object

eu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer

eu.europa.esig.dss.pades.validation.PDFDocumentAnalyzer

All Implemented Interfaces:

DocumentAnalyzer

Direct Known Subclasses:

PDFADocumentAnalyzer

public class PDFDocumentAnalyzer
extends DefaultDocumentAnalyzer

Validation of PDF document.

Field Summary

Fields inherited from class eu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer

certificateVerifier, containerContents, detachedContents, detachedEvidenceRecordDocuments, document, manifestFile, signingCertificateSource

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PDFDocumentAnalyzer()	Empty constructor
	PDFDocumentAnalyzer(DSSDocument document)	The default constructor for PDFDocumentValidator.

Method Summary

Modifier and Type	Method	Description
protected List<TimestampToken>	buildDetachedTimestamps()	Builds a list of detached TimestampTokens extracted from the document
protected List<AdvancedSignature>	buildSignatures()	This method build a list of signatures to be extracted from a document
protected List<AdvancedSignature>	getAllSignatures()	Returns a list of all signatures from the validating document
List<TimestampToken>	getDetachedTimestamps()	Retrieves the detached timestamps found in the document
List<PdfDssDict>	getDssDictionaries()	Returns a list of found DSS Dictionaries across different revisions
protected List<PdfDocDssRevision>	getDssRevisions()	This method returns a list of DSS revisions
List<DSSDocument>	getOriginalDocuments(AdvancedSignature advancedSignature)	This method returns the signed document(s) without their signature(s)
protected PAdESTimestampScopeFinder	getPAdESTimestampScopeFinder()	This method returns a PDF timestamp scope finder
protected List<PdfRevision>	getRevisions()	Gets the list of PDF document revisions
<T extends AdvancedSignature> PdfValidationDataContainer	getValidationData(Collection<T> signatures, Collection<TimestampToken> detachedTimestamps)	Extracts a validation data for provided collection of signatures and/or timestamps
protected PdfValidationDataContainer	instantiateValidationDataContainer()	Creates a new instance of ValidationDataContainer
boolean	isSupported(DSSDocument dssDocument)	Checks if the document is supported by the current validator
protected void	postProcessing(List<AdvancedSignature> signatures)	Post-process the extracted signatures NOTE: the method shall be used only for the document validation
protected void	prepareDssDictionaryValidationContext(ValidationContext validationContext, List<PdfDocDssRevision> dssRevisions)	Fills the validateContext with certificate tokens from dssDicts
protected <T extends AdvancedSignature> ValidationContext	prepareValidationContext(Collection<T> signatures, Collection<TimestampToken> detachedTimestamps, Collection<EvidenceRecord> detachedEvidenceRecords, CertificateVerifier certificateVerifier)	Initializes and fills ValidationContext with necessary data sources
void	setPasswordProtection(char[] passwordProtection)	Specify the used password for the encrypted document
void	setPdfObjFactory(IPdfObjFactory pdfObjFactory)	Set the IPdfObjFactory.
protected void	timestampPostProcessing(List<TimestampToken> timestampTokens)	Post-process the extracted detached timestamps NOTE: the method shall be used only for the document validation

Methods inherited from class eu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer

addReference, appendCounterSignatures, appendExternalEvidenceRecords, appendExternalEvidenceRecords, buildDetachedEvidenceRecords, buildEvidenceRecord, coversSignature, createValidationContext, fromDocument, getAllEvidenceRecords, getDetachedEvidenceRecords, getDocument, getEvidenceRecord, getEvidenceRecordScopes, getOriginalDocuments, getSignatureById, getSignaturePolicyProvider, getSignaturePolicyValidatorLoader, getSignatures, getTimestampedReferences, getTimestampReaders, getTokenIdentifierProvider, getValidationData, getValidationTime, isTimestampCoveredByEvidenceRecord, prepareDetachedEvidenceRecordValidationContext, prepareDetachedTimestampValidationContext, prepareSignatureForVerification, prepareSignatureValidationContext, processSignaturesValidation, setCertificateVerifier, setContainerContents, setDetachedContents, setDetachedEvidenceRecordDocuments, setDetachedEvidenceRecords, setManifestFile, setSignaturePolicyProvider, setSigningCertificateSource, setTokenIdentifierProvider, setValidationContextExecutor, setValidationTime, validate, validateContext, validateSignaturePolicy

Methods inherited from class java.lang.Object

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

Constructor Details

PDFDocumentAnalyzer

protected PDFDocumentAnalyzer()

Empty constructor

PDFDocumentAnalyzer

public PDFDocumentAnalyzer(DSSDocument document)

The default constructor for PDFDocumentValidator.

Parameters:

document - DSSDocument

Method Details

isSupported

public boolean isSupported(DSSDocument dssDocument)

Description copied from interface: DocumentAnalyzer

Checks if the document is supported by the current validator

Parameters:

dssDocument - DSSDocument to check

Returns:

TRUE if the document is supported, FALSE otherwise

setPdfObjFactory

public void setPdfObjFactory(IPdfObjFactory pdfObjFactory)

Set the IPdfObjFactory. Allow to set the used implementation. Cannot be null.

Parameters:

pdfObjFactory - the implementation to be used.

setPasswordProtection

public void setPasswordProtection(char[] passwordProtection)

Specify the used password for the encrypted document

Parameters:

passwordProtection - the used password

prepareValidationContext

protected <T extends AdvancedSignature>
ValidationContext prepareValidationContext(Collection<T> signatures,
 Collection<TimestampToken> detachedTimestamps,
 Collection<EvidenceRecord> detachedEvidenceRecords,
 CertificateVerifier certificateVerifier)

Description copied from class: DefaultDocumentAnalyzer

Initializes and fills ValidationContext with necessary data sources

Overrides:

prepareValidationContext in class DefaultDocumentAnalyzer

Type Parameters:

T - AdvancedSignature implementation

Parameters:

signatures - a collection of AdvancedSignatures

detachedTimestamps - a collection of detached TimestampTokens

detachedEvidenceRecords - a collection of detached EvidenceRecords

certificateVerifier - CertificateVerifier to be used for the validation

Returns:

ValidationContext

prepareDssDictionaryValidationContext

protected void prepareDssDictionaryValidationContext(ValidationContext validationContext,
 List<PdfDocDssRevision> dssRevisions)

Fills the validateContext with certificate tokens from dssDicts

Parameters:

validationContext - ValidationContext to enrich

dssRevisions - a list of PdfDocDssRevisions

getAllSignatures

protected List<AdvancedSignature> getAllSignatures()

Description copied from class: DefaultDocumentAnalyzer

Returns a list of all signatures from the validating document

Overrides:

getAllSignatures in class DefaultDocumentAnalyzer

Returns:

a list of AdvancedSignatures

postProcessing

protected void postProcessing(List<AdvancedSignature> signatures)

Post-process the extracted signatures NOTE: the method shall be used only for the document validation

Parameters:

signatures - a list of AdvancedSignatures

getDetachedTimestamps

public List<TimestampToken> getDetachedTimestamps()

Description copied from interface: DocumentAnalyzer

Retrieves the detached timestamps found in the document

Specified by:

getDetachedTimestamps in interface DocumentAnalyzer

Overrides:

getDetachedTimestamps in class DefaultDocumentAnalyzer

Returns:

a list of TimestampToken for validation purposes

timestampPostProcessing

protected void timestampPostProcessing(List<TimestampToken> timestampTokens)

Post-process the extracted detached timestamps NOTE: the method shall be used only for the document validation

Parameters:

timestampTokens - a list of TimestampTokens

buildSignatures

protected List<AdvancedSignature> buildSignatures()

Description copied from class: DefaultDocumentAnalyzer

This method build a list of signatures to be extracted from a document

Overrides:

buildSignatures in class DefaultDocumentAnalyzer

Returns:

a list of AdvancedSignatures

buildDetachedTimestamps

protected List<TimestampToken> buildDetachedTimestamps()

Description copied from class: DefaultDocumentAnalyzer

Builds a list of detached TimestampTokens extracted from the document

Overrides:

buildDetachedTimestamps in class DefaultDocumentAnalyzer

Returns:

a list of TimestampTokens

getPAdESTimestampScopeFinder

protected PAdESTimestampScopeFinder getPAdESTimestampScopeFinder()

This method returns a PDF timestamp scope finder

Returns:

PAdESTimestampScopeFinder

getDssDictionaries

public List<PdfDssDict> getDssDictionaries()

Returns a list of found DSS Dictionaries across different revisions

Returns:

list of PdfDssDicts

getDssRevisions

protected List<PdfDocDssRevision> getDssRevisions()

This method returns a list of DSS revisions

Returns:

a list of PdfDocDssRevisions

getRevisions

protected List<PdfRevision> getRevisions()

Gets the list of PDF document revisions

Returns:

a list of PdfRevisions

getValidationData

public <T extends AdvancedSignature>
PdfValidationDataContainer getValidationData(Collection<T> signatures,
 Collection<TimestampToken> detachedTimestamps)

Description copied from interface: DocumentAnalyzer

Extracts a validation data for provided collection of signatures and/or timestamps

Specified by:

getValidationData in interface DocumentAnalyzer

Overrides:

getValidationData in class DefaultDocumentAnalyzer

Type Parameters:

T - AdvancedSignature implementation

Parameters:

signatures - a collection of AdvancedSignatures

detachedTimestamps - a collection of detached TimestampTokens

Returns:

ValidationDataContainer

instantiateValidationDataContainer

protected PdfValidationDataContainer instantiateValidationDataContainer()

Description copied from class: DefaultDocumentAnalyzer

Creates a new instance of ValidationDataContainer

Overrides:

instantiateValidationDataContainer in class DefaultDocumentAnalyzer

Returns:

ValidationDataContainer

getOriginalDocuments

public List<DSSDocument> getOriginalDocuments(AdvancedSignature advancedSignature)

Description copied from interface: DocumentAnalyzer

This method returns the signed document(s) without their signature(s)

Parameters:

advancedSignature - AdvancedSignature to find signer documents for

Returns:

list of DSSDocuments