Package eu.europa.esig.dss.validation
Interface DocumentValidator
-
- All Known Subinterfaces:
ASiCSignatureValidator
- All Known Implementing Classes:
AbstractASiCContainerValidator,ASiCContainerWithCAdESValidator,ASiCContainerWithXAdESValidator,ASiCEWithCAdESTimestampValidator,CMSDocumentForASiCValidator,CMSDocumentValidator,CMSTimestampValidator,PDFDocumentValidator,SignedDocumentValidator,XMLDocumentForASiCValidator,XMLDocumentValidator
public interface DocumentValidatorThis is the interface to be used when implementing different signature validators.
-
-
Method Summary
Modifier and Type Method Description voiddefineSigningCertificate(CertificateToken x509Certificate)This method allows to define the signing certificate.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)List<AdvancedSignature>getSignatures()Retrieves the signatures found in the documentList<AdvancedSignature>prepareSignatureValidationContext(ValidationContext validationContext)Prepares and fillsvalidationContextfor the signature validationList<AdvancedSignature>processSignaturesValidation(ValidationContext validationContext, List<AdvancedSignature> allSignatureList, boolean structuralValidation)This method process the signature validation on the givenallSignatureListvoidsetCertificateVerifier(CertificateVerifier certVerifier)Provides aCertificateVerifierto be used during the validation process.voidsetContainerContents(List<DSSDocument> archiveContents)Sets theListofDSSDocumentcontaining the original container content for ASiC signatures.voidsetDetachedContents(List<DSSDocument> detachedContent)Sets theListofDSSDocumentcontaining the original contents to sign, for detached signature scenarios.voidsetEnableEtsiValidationReport(boolean enableEtsiValidationReport)This method allows to specify if the ETSI Validation Report must be generated.voidsetManifestFiles(List<ManifestFile> manifestFiles)Sets theListofManifestFiles found in the signature file.voidsetSignaturePolicyProvider(SignaturePolicyProvider signaturePolicyProvider)This method allows to set a provider for Signature policiesvoidsetValidationLevel(ValidationLevel validationLevel)This method allows to specify the validation level (Basic / Timestamp / Long Term / Archival).ReportsvalidateDocument()Validates the document and all its signatures.ReportsvalidateDocument(ConstraintsParameters validationPolicyJaxb)Validates the document and all its signatures.ReportsvalidateDocument(ValidationPolicy validationPolicy)Validates the document and all its signatures.ReportsvalidateDocument(File policyFile)Validates the document and all its signatures.ReportsvalidateDocument(InputStream policyDataStream)Validates the document and all its signatures.ReportsvalidateDocument(String policyResourcePath)Validates the document and all its signatures.ReportsvalidateDocument(URL validationPolicyURL)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 aCertificateVerifierto be used during the validation process.- Parameters:
certVerifier-CertificateVerifier
-
setDetachedContents
void setDetachedContents(List<DSSDocument> detachedContent)
Sets theListofDSSDocumentcontaining the original contents to sign, for detached signature scenarios.- Parameters:
detachedContent- theListofDSSDocumentto set
-
setContainerContents
void setContainerContents(List<DSSDocument> archiveContents)
Sets theListofDSSDocumentcontaining the original container content for ASiC signatures.- Parameters:
archiveContents- theListofDSSDocumentto set
-
setManifestFiles
void setManifestFiles(List<ManifestFile> manifestFiles)
Sets theListofManifestFiles found in the signature file.- Parameters:
manifestFiles- theListofManifestFileto 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)
This method allows to specify the validation level (Basic / Timestamp / Long Term / Archival). By default, the selected validation is ARCHIVAL- Parameters:
validationLevel-ValidationLevel
-
setEnableEtsiValidationReport
void setEnableEtsiValidationReport(boolean enableEtsiValidationReport)
This method allows to specify if the ETSI Validation Report must be generated. By default the value if TRUE (the ETSI Validation report will be generated).- Parameters:
enableEtsiValidationReport- - TRUE if the report must be generated, FALSE otherwise
-
setSignaturePolicyProvider
void setSignaturePolicyProvider(SignaturePolicyProvider signaturePolicyProvider)
This method allows to set a provider for Signature policies- Parameters:
signaturePolicyProvider-
-
validateDocument
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
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
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
Reports validateDocument(File policyFile)
Validates the document and all its signatures. TheFileparameter specifies the constraint file. If null or empty the default file is used.- Parameters:
policyFile- contains the validation policy (xml) asFile- Returns:
Reports: diagnostic data, detailed report and simple report
-
validateDocument
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) asInputStream- Returns:
Reports: diagnostic data, detailed report and simple report
-
validateDocument
Reports validateDocument(ConstraintsParameters validationPolicyJaxb)
Validates the document and all its signatures. ThevalidationPolicyJaxbcontains the constraint file. If null or empty the default file is used.- Parameters:
validationPolicyJaxb-ConstraintsParameters- Returns:
-
validateDocument
Reports validateDocument(ValidationPolicy validationPolicy)
Validates the document and all its signatures. ThevalidationPolicycontains the constraint file. If null or empty the default file is used.- Parameters:
validationPolicy-ValidationPolicy- Returns:
-
getOriginalDocuments
List<DSSDocument> getOriginalDocuments(String signatureId)
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
-
getOriginalDocuments
List<DSSDocument> getOriginalDocuments(AdvancedSignature advancedSignature)
This method returns the signed document(s) without their signature(s)- Parameters:
advancedSignature-AdvancedSignatureto find signer documents for
-
prepareSignatureValidationContext
List<AdvancedSignature> prepareSignatureValidationContext(ValidationContext validationContext)
Prepares and fillsvalidationContextfor the signature validation- Parameters:
validationContext-ValidationContextto prepare- Returns:
- list of
AdvancedSignatures to be validated
-
processSignaturesValidation
List<AdvancedSignature> processSignaturesValidation(ValidationContext validationContext, List<AdvancedSignature> allSignatureList, boolean structuralValidation)
This method process the signature validation on the givenallSignatureList- Parameters:
validationContext- prepared and filledValidationContextallSignatureList- list ofAdvancedSignatures to be validatedstructuralValidation- specifies if structure of the signature must be validated- Returns:
- list of validated
AdvancedSignatures
-
-