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>

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

Constructor	Description
PDFDocumentValidator(DSSDocument document)	The default constructor for PDFDocumentValidator.

Method Summary

Modifier and Type	Method	Description
List<TimestampToken>	getDetachedTimestamps()	Retrieves the detached timestamps found in the document
List<PdfDssDict>	getDssDictionaries()	Returns a list of found DSS Dictionaries across different revisions
List<DSSDocument>	getOriginalDocuments(AdvancedSignature advancedSignature)	This method returns the signed document(s) without their signature(s)
List<DSSDocument>	getOriginalDocuments(String signatureId)	This method returns the signed document(s) without their signature(s)
protected List<PdfRevision>	getRevisions()	Gets the list of PDF document revisions
List<AdvancedSignature>	getSignatures()	Retrieves the signatures found in the document
protected PAdESDiagnosticDataBuilder	initializeDiagnosticDataBuilder()	Initializes a relevant DiagnosticDataBuilder for the given implementation
boolean	isSupported(DSSDocument dssDocument)	Checks if the document is supported by the current validator
protected ListCertificateSource	mergeCertificateSource(Collection<AdvancedSignature> allSignatureList, Collection<TimestampToken> detachedTimestamps, List<PdfDssDict> dssDictionaries)	Merges the certificate tokens sources
protected ListRevocationSource<CRL>	mergeCRLSources(Collection<AdvancedSignature> allSignatures, Collection<TimestampToken> timestampTokens, Collection<PdfDssDict> dssDictionaries)	Merges the CRL sources
protected ListRevocationSource<OCSP>	mergeOCSPSources(Collection<AdvancedSignature> allSignatures, Collection<TimestampToken> timestampTokens, Collection<PdfDssDict> dssDictionaries)	Merges the OCSP sources
protected void	populateFromDssDictionaries(ValidationContext validationContext, List<PdfDssDict> dssDicts)	Fills the validateContext with certificate tokens from dssDicts
protected DiagnosticDataBuilder	prepareDiagnosticDataBuilder(ValidationContext validationContext)	Creates a DiagnosticDataBuilder
void	setPasswordProtection(String pwd)	Specify the used password for the encrypted document
void	setPdfObjFactory(IPdfObjFactory pdfObjFactory)	Set the IPdfObjFactory.

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

appendCounterSignatures, assertConfigurationValid, createDiagnosticDataBuilder, defineSigningCertificate, findSignatureScopes, fromDocument, getAllSignatures, getDefaultDigestAlgorithm, getDefaultProcessExecutor, getSignaturePolicyProvider, getValidationTime, mergeCertificateSource, mergeCRLSources, mergeOCSPSources, prepareCertificatesAndTimestamps, prepareCertificateVerifier, prepareDetachedTimestampValidationContext, prepareSignatureValidationContext, processSignaturesValidation, processValidationPolicy, provideProcessExecutorInstance, setCertificateVerifier, setContainerContents, setDetachedContents, setEnableEtsiValidationReport, setIncludeSemantics, setLocale, setManifestFile, setProcessExecutor, setSignaturePolicyProvider, setSignedScopeFinderDefaultDigestAlgorithm, setSigningCertificateSource, setSkipValidationContextExecution, setTokenExtractionStrategy, setValidationLevel, setValidationTime, validateContext, 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

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

public void setPasswordProtection(String pwd)

Specify the used password for the encrypted document

Parameters:

pwd - the used password

prepareDiagnosticDataBuilder

protected DiagnosticDataBuilder prepareDiagnosticDataBuilder(ValidationContext validationContext)

Description copied from class: SignedDocumentValidator

Creates a DiagnosticDataBuilder

Overrides:

prepareDiagnosticDataBuilder in class SignedDocumentValidator

Parameters:

validationContext - ValidationContext

Returns:

DiagnosticDataBuilder

initializeDiagnosticDataBuilder

protected PAdESDiagnosticDataBuilder initializeDiagnosticDataBuilder()

Description copied from class: SignedDocumentValidator

Initializes a relevant DiagnosticDataBuilder for the given implementation

Overrides:

initializeDiagnosticDataBuilder in class SignedDocumentValidator

Returns:

SignedDocumentDiagnosticDataBuilder

mergeCRLSources

protected ListRevocationSource<CRL> mergeCRLSources(Collection<AdvancedSignature> allSignatures,
Collection<TimestampToken> timestampTokens,
Collection<PdfDssDict> dssDictionaries)

Merges the CRL sources

Parameters:

allSignatures - a collection of AdvancedSignatures

timestampTokens - a collection of TimestampTokens

dssDictionaries - a collection of PdfDssDicts

Returns:

merged ListRevocationSource

mergeOCSPSources

protected ListRevocationSource<OCSP> mergeOCSPSources(Collection<AdvancedSignature> allSignatures,
Collection<TimestampToken> timestampTokens,
Collection<PdfDssDict> dssDictionaries)

Merges the OCSP sources

Parameters:

allSignatures - a collection of AdvancedSignatures

timestampTokens - a collection of TimestampTokens

dssDictionaries - a collection of PdfDssDicts

Returns:

merged ListRevocationSource

populateFromDssDictionaries

protected void populateFromDssDictionaries(ValidationContext validationContext,
List<PdfDssDict> dssDicts)

Fills the validateContext with certificate tokens from dssDicts

Parameters:

validationContext - ValidationContext to enrich

dssDicts - a list of PdfDssDicts

mergeCertificateSource

protected ListCertificateSource mergeCertificateSource(Collection<AdvancedSignature> allSignatureList,
Collection<TimestampToken> detachedTimestamps,
List<PdfDssDict> dssDictionaries)

Merges the certificate tokens sources

Parameters:

allSignatureList - a collection of AdvancedSignatures

detachedTimestamps - a collection of TimestampTokens

dssDictionaries - a collection of PdfDssDicts

Returns:

merged ListRevocationSource

getSignatures

public List<AdvancedSignature> getSignatures()

Description copied from interface: DocumentValidator

Retrieves the signatures found in the document

Specified by:

getSignatures in interface DocumentValidator

Overrides:

getSignatures in class SignedDocumentValidator

Returns:

a list of AdvancedSignatures for validation purposes

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

getDssDictionaries

public List<PdfDssDict> getDssDictionaries()

Returns a list of found DSS Dictionaries across different revisions

Returns:

list of PdfDssDicts

getRevisions

protected List<PdfRevision> getRevisions()

Gets the list of PDF document revisions

Returns:

a list of PdfRevisions

getOriginalDocuments

public List<DSSDocument> getOriginalDocuments(String signatureId)

Description copied from interface: DocumentValidator

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

Parameters:

signatureId - the DSS ID of the signature to extract original signer data for

Returns:

list of DSSDocuments

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