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

Class PDFDocumentValidator

java.lang.Object

eu.europa.esig.dss.validation.SignedDocumentValidator

eu.europa.esig.dss.pades.validation.PDFDocumentValidator

All Implemented Interfaces:

DocumentValidator, ProcessExecutorProvider<DocumentProcessExecutor>

Direct Known Subclasses:

PDFADocumentValidator

public class PDFDocumentValidator
extends SignedDocumentValidator

Validation of PDF document.

Field Summary

Fields inherited from class eu.europa.esig.dss.validation.SignedDocumentValidator

certificateVerifier, containerContents, detachedContents, document, manifestFile, processExecutor, signatureScopeFinder, signingCertificateSource, skipValidationContextExecution

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PDFDocumentValidator()	Empty constructor
	PDFDocumentValidator(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
<T extends AdvancedSignature> void	findSignatureScopes(Collection<T> allSignatures)	Finds and assigns SignatureScopes for a list of signatures
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 PAdESDiagnosticDataBuilder	initializeDiagnosticDataBuilder()	Initializes a relevant DiagnosticDataBuilder for the given implementation
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, CertificateVerifier certificateVerifier)	Initializes and fills ValidationContext with necessary data sources
void	setPasswordProtection(char[] passwordProtection)	Specify the used password for the encrypted document
void	setPasswordProtection(String pwd)	Deprecated. since DSS 5.12.
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.validation.SignedDocumentValidator

addReference, appendCounterSignatures, assertConfigurationValid, createDiagnosticDataBuilder, findTimestampScopes, fromDocument, getDefaultDigestAlgorithm, getDefaultProcessExecutor, getDiagnosticData, getOriginalDocuments, getSignatureById, getSignaturePolicyProvider, getSignaturePolicyValidatorLoader, getSignatures, getTimestampedReferences, getTimestampScopeFinder, getTokenIdentifierProvider, getValidationData, getValidationTime, prepareDetachedTimestampValidationContext, prepareDiagnosticDataBuilder, prepareSignatureForVerification, prepareSignatureScopeFinder, prepareSignatureValidationContext, prepareTimestampScopeFinder, processSignaturesValidation, processValidationPolicy, provideProcessExecutorInstance, setCertificateVerifier, setContainerContents, setDetachedContents, setEnableEtsiValidationReport, setIncludeSemantics, setLocale, setManifestFile, setProcessExecutor, setSignaturePolicyProvider, setSigningCertificateSource, setSkipValidationContextExecution, setTokenExtractionStrategy, setTokenIdentifierProvider, setValidationLevel, setValidationTime, validateContext, validateDocument, validateDocument, validateDocument, validateDocument, validateDocument, validateDocument, validateDocument, validateDocument

Methods inherited from class java.lang.Object

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

Constructor Details

PDFDocumentValidator

protected PDFDocumentValidator()

Empty constructor

PDFDocumentValidator

public PDFDocumentValidator(DSSDocument document)

The default constructor for PDFDocumentValidator.

Parameters:

document - DSSDocument

Method Details

isSupported

public boolean isSupported(DSSDocument dssDocument)

Description copied from class: SignedDocumentValidator

Checks if the document is supported by the current validator

Specified by:

isSupported in class SignedDocumentValidator

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

@Deprecated
public void setPasswordProtection(String pwd)

Deprecated.

since DSS 5.12. Use #setPasswordBinaries(pwd.toCharArray())

Specify the used password for the encrypted document

Parameters:

pwd - the used password

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,
 CertificateVerifier certificateVerifier)

Description copied from class: SignedDocumentValidator

Initializes and fills ValidationContext with necessary data sources

Overrides:

prepareValidationContext in class SignedDocumentValidator

Type Parameters:

T - AdvancedSignature implementation

Parameters:

signatures - a collection of AdvancedSignatures

detachedTimestamps - a collection of detached TimestampTokens

certificateVerifier - CertificateVerifier to be used for the validation

Returns:

ValidationContext

initializeDiagnosticDataBuilder

protected PAdESDiagnosticDataBuilder initializeDiagnosticDataBuilder()

Description copied from class: SignedDocumentValidator

Initializes a relevant DiagnosticDataBuilder for the given implementation

Overrides:

initializeDiagnosticDataBuilder in class SignedDocumentValidator

Returns:

SignedDocumentDiagnosticDataBuilder

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: SignedDocumentValidator

Returns a list of all signatures from the validating document

Overrides:

getAllSignatures in class SignedDocumentValidator

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: DocumentValidator

Retrieves the detached timestamps found in the document

Specified by:

getDetachedTimestamps in interface DocumentValidator

Overrides:

getDetachedTimestamps in class SignedDocumentValidator

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: SignedDocumentValidator

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

Overrides:

buildSignatures in class SignedDocumentValidator

Returns:

a list of AdvancedSignatures

buildDetachedTimestamps

protected List<TimestampToken> buildDetachedTimestamps()

Description copied from class: SignedDocumentValidator

Builds a list of detached TimestampTokens extracted from the document

Overrides:

buildDetachedTimestamps in class SignedDocumentValidator

Returns:

a list of TimestampTokens

findSignatureScopes

public <T extends AdvancedSignature> void findSignatureScopes(Collection<T> allSignatures)

Description copied from class: SignedDocumentValidator

Finds and assigns SignatureScopes for a list of signatures

Specified by:

findSignatureScopes in interface DocumentValidator

Overrides:

findSignatureScopes in class SignedDocumentValidator

Type Parameters:

T - AdvancedSignature implementation

Parameters:

allSignatures - a list of AdvancedSignatures to get a SignatureScope list

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: DocumentValidator

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

Specified by:

getValidationData in interface DocumentValidator

Overrides:

getValidationData in class SignedDocumentValidator

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: SignedDocumentValidator

Creates a new instance of ValidationDataContainer

Overrides:

instantiateValidationDataContainer in class SignedDocumentValidator

Returns:

ValidationDataContainer

getOriginalDocuments

public List<DSSDocument> getOriginalDocuments(AdvancedSignature advancedSignature)

Description copied from interface: DocumentValidator

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

Parameters:

advancedSignature - AdvancedSignature to find signer documents for

Returns:

list of DSSDocuments