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

Class XMLDocumentAnalyzer

java.lang.Object

eu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer

eu.europa.esig.dss.xades.validation.XMLDocumentAnalyzer

All Implemented Interfaces:

DocumentAnalyzer

public class XMLDocumentAnalyzer
extends DefaultDocumentAnalyzer

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<XAdESPath>	xadesPathsHolders	This variable contains the list of XAdESPaths adapted to the specific signature schema.

Fields inherited from class eu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer

certificateVerifier, containerContents, detachedContents, detachedEvidenceRecordDocuments, document, manifestFile, signingCertificateSource

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addXAdESPathsHolder(XAdESPath 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 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
List<XAdESPath>	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.spi.validation.analyzer.DefaultDocumentAnalyzer

addReference, appendCounterSignatures, appendExternalEvidenceRecords, appendExternalEvidenceRecords, buildDetachedEvidenceRecords, buildDetachedTimestamps, buildEvidenceRecord, coversSignature, createValidationContext, fromDocument, getAllEvidenceRecords, getAllSignatures, getDetachedEvidenceRecords, getDetachedTimestamps, getDocument, getEvidenceRecord, getEvidenceRecordScopes, getOriginalDocuments, getSignatureById, getSignaturePolicyProvider, getSignatures, getTimestampedReferences, getTimestampReaders, getTokenIdentifierProvider, getValidationData, getValidationData, getValidationTime, instantiateValidationDataContainer, isTimestampCoveredByEvidenceRecord, prepareDetachedEvidenceRecordValidationContext, prepareDetachedTimestampValidationContext, prepareSignatureForVerification, prepareSignatureValidationContext, prepareValidationContext, processSignaturesValidation, setCertificateVerifier, setContainerContents, setDetachedContents, setDetachedEvidenceRecordDocuments, setDetachedEvidenceRecords, setManifestFile, setSignaturePolicyProvider, setSigningCertificateSource, setTokenIdentifierProvider, setValidationContextExecutor, setValidationTime, validate, validateContext, validateSignaturePolicy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

xadesPathsHolders

protected List<XAdESPath> 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

XMLDocumentAnalyzer

public XMLDocumentAnalyzer(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 interface: DocumentAnalyzer

Checks if the document is supported by the current validator

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: DefaultDocumentAnalyzer

This method build a list of signatures to be extracted from a document

Overrides:

buildSignatures in class DefaultDocumentAnalyzer

Returns:

a list of AdvancedSignatures

getOriginalDocuments

public List<DSSDocument> getOriginalDocuments(AdvancedSignature advancedSignature)

Description copied from interface: DocumentAnalyzer

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<XAdESPath> getXAdESPathsHolder()

This getter returns the XAdESPaths

Returns:

a list of XAdESPath

addXAdESPathsHolder

public void addXAdESPathsHolder(XAdESPath xadesPathsHolder)

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

Parameters:

xadesPathsHolder - XAdESPath

clearQueryHolders

public void clearQueryHolders()

Removes all 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: DefaultDocumentAnalyzer

Returns an instance of a corresponding to the format SignaturePolicyValidatorLoader

Overrides:

getSignaturePolicyValidatorLoader in class DefaultDocumentAnalyzer

Returns:

SignaturePolicyValidatorLoader