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>

Direct Known Subclasses:

XMLDocumentForASiCValidator

public class XMLDocumentValidator
extends SignedDocumentValidator

Validator of XML Signed document

Field Summary

Fields

Modifier and Type	Field	Description
protected Document	rootElement
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, manifestFiles, processExecutor, providedSigningCertificateToken, signatureScopeFinder, 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.
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)
List<DSSDocument>	getOriginalDocuments(String signatureId)	This method returns the signed document(s) without their signature(s)
Document	getRootElement()
AdvancedSignature	getSignatureById(String signatureId)	Retrieves a signature based on its Id
List<AdvancedSignature>	getSignatures()	Retrieves the signatures found in the document
List<XAdESPaths>	getXAdESPathsHolder()	This getter returns the XAdESPaths
boolean	isSupported(DSSDocument dssDocument)
void	setDisableXSWProtection(boolean disableXSWProtection)	NOT RECOMMENDED : This parameter allows to disable protection against XML Signature wrapping attacks (XSW).

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

assertConfigurationValid, defineSigningCertificate, findSignatureScopes, fromDocument, getAllSignatures, getDefaultDigestAlgorithm, getDefaultProcessExecutor, getDetachedTimestamps, getDiagnosticDataBuilderConfiguration, getSignaturePolicyProvider, getValidationTime, mergeCertificateSource, mergeCRLSources, mergeOCSPSources, prepareCertificatesAndTimestamps, prepareCertificateVerifier, prepareDetachedTimestampValidationContext, prepareDiagnosticDataBuilder, prepareSignatureValidationContext, processSignaturesValidation, processValidationPolicy, provideProcessExecutorInstance, setCertificateVerifier, setContainerContents, setDetachedContents, setEnableEtsiValidationReport, setIncludeSemantics, setLocale, setManifestFiles, setProcessExecutor, setSignaturePolicyProvider, setSignedScopeFinderDefaultDigestAlgorithm, setSkipValidationContextExecution, setTokenExtractionStategy, 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

Field Details

xadesPathsHolders

protected List<XAdESPaths> xadesPathsHolders

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

rootElement

protected Document rootElement

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)

Specified by:

isSupported in class SignedDocumentValidator

setDisableXSWProtection

public void setDisableXSWProtection(boolean disableXSWProtection)

NOT RECOMMENDED : This parameter allows to disable 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

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

getSignatureById

public AdvancedSignature getSignatureById(String signatureId) throws DSSException

Retrieves a signature based on its Id

Parameters:

signatureId - the given Id

Returns:

the corresponding XAdESSignature

Throws:

DSSException - in case no Id is provided, or in case no signature was found for the given Id

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

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

getXAdESPathsHolder

public List<XAdESPaths> getXAdESPathsHolder()

This getter returns the XAdESPaths

Returns:

addXAdESPathsHolder

public void addXAdESPathsHolder(XAdESPaths xadesPathsHolder)

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

Parameters:

xadesPathsHolder -

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: