eu.europa.esig.dss.validation

Interface DocumentValidator

All Known Implementing Classes:

SignedDocumentValidator

public interface DocumentValidator

This is the interface to be used when implementing different signature validators.

Method Summary

Methods

Modifier and Type	Method and Description
void	defineSigningCertificate(CertificateToken x509Certificate) This method allows to define the signing certificate.
List<DSSDocument>	getOriginalDocuments(String signatureId) This method returns the signed document(s) without their signature(s)
List<AdvancedSignature>	getSignatures() Retrieves the signatures found in the document
List<AdvancedSignature>	processSignaturesValidation(ValidationContext validationContext, boolean structuralValidation)
void	setCertificateVerifier(CertificateVerifier certVerifier) Provides a CertificateVerifier to be used during the validation process.
void	setDetachedContents(List<DSSDocument> detachedContent) Sets the List of DSSDocument containing the original contents to sign, for detached signature scenarios.
void	setProcessExecutor(ProcessExecutor processExecutor) This method provides the possibility to set the specific ProcessExecutor
void	setSignaturePolicyProvider(SignaturePolicyProvider signaturePolicyProvider) This method allows to set a provider for Signature policies
void	setValidationLevel(ValidationLevel validationLevel)
eu.europa.esig.dss.validation.reports.Reports	validateDocument() Validates the document and all its signatures.
eu.europa.esig.dss.validation.reports.Reports	validateDocument(eu.europa.esig.jaxb.policy.ConstraintsParameters validationPolicyJaxb) Validates the document and all its signatures.
eu.europa.esig.dss.validation.reports.Reports	validateDocument(File policyFile) Validates the document and all its signatures.
eu.europa.esig.dss.validation.reports.Reports	validateDocument(InputStream policyDataStream) Validates the document and all its signatures.
eu.europa.esig.dss.validation.reports.Reports	validateDocument(String policyResourcePath) Validates the document and all its signatures.
eu.europa.esig.dss.validation.reports.Reports	validateDocument(URL validationPolicyURL) Validates the document and all its signatures.
eu.europa.esig.dss.validation.reports.Reports	validateDocument(ValidationPolicy validationPolicy) Validates the document and all its signatures.

Method Detail

getSignatures

List<AdvancedSignature> getSignatures()

Retrieves the signatures found in the document

Returns:

a list of AdvancedSignatures for validation purposes

setCertificateVerifier

void setCertificateVerifier(CertificateVerifier certVerifier)

Provides a CertificateVerifier to be used during the validation process.

Parameters:

certVerifier - CertificateVerifier

setDetachedContents

void setDetachedContents(List<DSSDocument> detachedContent)

Sets the List of DSSDocument containing the original contents to sign, for detached signature scenarios.

Parameters:

detachedContent - the List of DSSDocument to set

defineSigningCertificate

void defineSigningCertificate(CertificateToken x509Certificate)

This method allows to define the signing certificate. It is useful in the case of ,non AdES signatures.

Parameters:

x509Certificate -

setValidationLevel

void setValidationLevel(ValidationLevel validationLevel)

setProcessExecutor

void setProcessExecutor(ProcessExecutor processExecutor)

This method provides the possibility to set the specific ProcessExecutor

Parameters:

processExecutor -

setSignaturePolicyProvider

void setSignaturePolicyProvider(SignaturePolicyProvider signaturePolicyProvider)

This method allows to set a provider for Signature policies

Parameters:

signaturePolicyProvider -

validateDocument

eu.europa.esig.dss.validation.reports.Reports validateDocument()

Validates the document and all its signatures. The default constraint file is used.

Returns:

Reports: diagnostic data, detailed report and simple report

validateDocument

eu.europa.esig.dss.validation.reports.Reports validateDocument(URL validationPolicyURL)

Validates the document and all its signatures. If the validation policy URL is set then the policy constraints are retrieved from this location. If null or empty the default file is used.

Parameters:

validationPolicyURL -

Returns:

Reports: diagnostic data, detailed report and simple report

validateDocument

eu.europa.esig.dss.validation.reports.Reports validateDocument(String policyResourcePath)

Validates the document and all its signatures. The policyResourcePath specifies the constraint file. If null or empty the default file is used.

Parameters:

policyResourcePath - is located against the classpath (getClass().getResourceAsStream), and NOT the filesystem

Returns:

Reports: diagnostic data, detailed report and simple report

validateDocument

eu.europa.esig.dss.validation.reports.Reports validateDocument(File policyFile)

Validates the document and all its signatures. The File parameter specifies the constraint file. If null or empty the default file is used.

Parameters:

policyFile - contains the validation policy (xml) as File

Returns:

Reports: diagnostic data, detailed report and simple report

validateDocument

eu.europa.esig.dss.validation.reports.Reports validateDocument(InputStream policyDataStream)

Validates the document and all its signatures. The policyDataStream contains the constraint file. If null or empty the default file is used.

Parameters:

policyDataStream - contains the validation policy (xml) as InputStream

Returns:

Reports: diagnostic data, detailed report and simple report

validateDocument

eu.europa.esig.dss.validation.reports.Reports validateDocument(eu.europa.esig.jaxb.policy.ConstraintsParameters validationPolicyJaxb)

Validates the document and all its signatures. The validationPolicyJaxb contains the constraint file. If null or empty the default file is used.

Parameters:

validationPolicyJaxb - ConstraintsParameters

Returns:

validateDocument

eu.europa.esig.dss.validation.reports.Reports validateDocument(ValidationPolicy validationPolicy)

Validates the document and all its signatures. The validationPolicy contains the constraint file. If null or empty the default file is used.

Parameters:

validationPolicy - ValidationPolicy

Returns:

getOriginalDocuments

List<DSSDocument> getOriginalDocuments(String signatureId)
                                       throws DSSException

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

Parameters:

signatureId - the id of the signature to be removed.

Throws:

DSSException - the exception is thrown when the removal is not possible.

processSignaturesValidation

List<AdvancedSignature> processSignaturesValidation(ValidationContext validationContext,
                                                  boolean structuralValidation)