Package eu.europa.esig.dss.xades.validation

Class XMLDocumentValidator

java.lang.Object

eu.europa.esig.dss.validation.SignedDocumentValidator

eu.europa.esig.dss.xades.validation.XMLDocumentValidator

All Implemented Interfaces:

DocumentValidator, ProcessExecutorProvider<DocumentProcessExecutor>

public class XMLDocumentValidator
extends SignedDocumentValidator

Validator of XML Signed document

Field Summary

Fields

Modifier and Type	Field	Description
protected Document	rootElement	The root element of the document to validate
protected List<XAdESPaths>	xadesPathsHolders	This variable contains the list of XAdESPaths adapted to the specific signature schema.

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

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

Constructor Summary

Constructors

Constructor	Description
XMLDocumentValidator(DSSDocument dssDocument)	The default constructor for XMLDocumentValidator.

Method Summary

Modifier and Type	Method	Description
void	addXAdESPathsHolder(XAdESPaths xadesPathsHolder)	This adds a XAdESPaths.
protected List<AdvancedSignature>	buildSignatures()	This method build a list of signatures to be extracted from a document
void	clearQueryHolders()	Removes all of the elements from the list of query holders.
List<DSSDocument>	getOriginalDocuments(AdvancedSignature advancedSignature)	This method returns the signed document(s) without their signature(s)
Document	getRootElement()	Returns the root element of the validating document
SignaturePolicyValidatorLoader	getSignaturePolicyValidatorLoader()	Returns an instance of a corresponding to the format SignaturePolicyValidatorLoader
protected EncapsulatedTimestampScopeFinder	getTimestampScopeFinder()	This method returns a timestamp scope finder
List<XAdESPaths>	getXAdESPathsHolder()	This getter returns the XAdESPaths
boolean	isSupported(DSSDocument dssDocument)	Checks if the document is supported by the current validator
void	setDisableXSWProtection(boolean disableXSWProtection)	NOT RECOMMENDED : This parameter allows disabling protection against XML Signature wrapping attacks (XSW).

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

addReference, appendCounterSignatures, assertConfigurationValid, buildDetachedTimestamps, createDiagnosticDataBuilder, findSignatureScopes, findTimestampScopes, fromDocument, getAllSignatures, getDefaultDigestAlgorithm, getDefaultProcessExecutor, getDetachedTimestamps, getDiagnosticData, getOriginalDocuments, getSignatureById, getSignaturePolicyProvider, getSignatures, getTimestampedReferences, getTokenIdentifierProvider, getValidationData, getValidationData, getValidationTime, initializeDiagnosticDataBuilder, instantiateValidationDataContainer, prepareDetachedTimestampValidationContext, prepareDiagnosticDataBuilder, prepareSignatureForVerification, prepareSignatureScopeFinder, prepareSignatureValidationContext, prepareTimestampScopeFinder, prepareValidationContext, 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

Field Details

xadesPathsHolders

protected List<XAdESPaths> xadesPathsHolders

This variable contains the list of XAdESPaths adapted to the specific signature schema.

rootElement

protected Document rootElement

The root element of the document to validate

Constructor Details

XMLDocumentValidator

public XMLDocumentValidator(DSSDocument dssDocument)

The default constructor for XMLDocumentValidator. The created instance is initialised with default XAdESPaths .

Parameters:

dssDocument - The instance of DSSDocument to validate

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

setDisableXSWProtection

public void setDisableXSWProtection(boolean disableXSWProtection)

NOT RECOMMENDED : This parameter allows disabling protection against XML Signature wrapping attacks (XSW). It disables the research by XPath expression for defined Type attributes.

Parameters:

disableXSWProtection - true to disable the protection

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

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

getXAdESPathsHolder

public List<XAdESPaths> getXAdESPathsHolder()

This getter returns the XAdESPaths

Returns:

a list of XAdESPaths

addXAdESPathsHolder

public void addXAdESPathsHolder(XAdESPaths xadesPathsHolder)

This adds a XAdESPaths. This is useful when the signature follows a particular schema.

Parameters:

xadesPathsHolder - XAdESPaths

clearQueryHolders

public void clearQueryHolders()

Removes all of the elements from the list of query holders. The list will be empty after this call returns.

getRootElement

public Document getRootElement()

Returns the root element of the validating document

Returns:

Document

getSignaturePolicyValidatorLoader

public SignaturePolicyValidatorLoader getSignaturePolicyValidatorLoader()

Description copied from class: SignedDocumentValidator

Returns an instance of a corresponding to the format SignaturePolicyValidatorLoader

Overrides:

getSignaturePolicyValidatorLoader in class SignedDocumentValidator

Returns:

SignaturePolicyValidatorLoader

getTimestampScopeFinder

protected EncapsulatedTimestampScopeFinder getTimestampScopeFinder()

Description copied from class: SignedDocumentValidator

This method returns a timestamp scope finder

Overrides:

getTimestampScopeFinder in class SignedDocumentValidator

Returns:

TimestampScopeFinder