Package eu.europa.esig.dss.xades.signature

Class XAdESBuilder

java.lang.Object

eu.europa.esig.dss.xades.signature.XAdESBuilder

Direct Known Subclasses:

ExtensionBuilder, XAdESSignatureBuilder

public abstract class XAdESBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected CertificateVerifier	certificateVerifier	Reference to the object in charge of certificates validation
protected Document	documentDom	This is the variable which represents the root XML document root (with signature).
protected XAdESSignatureParameters	params
static String	REFERENCED_DATA
static String	SIGNATURE
static String	TARGET
static String	URI
protected XAdESPaths	xadesPaths	This variable holds the XAdESPaths which contains all constants and queries needed to cope with the default signature schema.

Constructor Summary

Constructors

Constructor	Description
XAdESBuilder(CertificateVerifier certificateVerifier)	The default constructor.

Method Summary

Modifier and Type	Method	Description
protected abstract void	alignNodes()
protected DSSDocument	createXmlDocument()	Creates DSSDocument from the current documentDom
protected XAdESElement	getCurrentXAdESElements()
protected XAdESPaths	getCurrentXAdESPaths()
protected DSSNamespace	getXades141Namespace()	This method returns the current used XAdES 1.4.1 namespace.
protected DSSNamespace	getXadesNamespace()	This method returns the current used XAdES namespace.
protected DSSNamespace	getXmldsigNamespace()	This method returns the current used XMLDSig namespace.
protected Element	incorporateCert(Element parentDom, CertificateToken certificate)	Creates Cert DOM object:
protected void	incorporateCertificateRef(Element signingCertificateDom, Set<CertificateToken> certificates)	Incorporates the certificate's references as a child of the given parent node.
protected void	incorporateDigestMethod(Element parentDom, DigestAlgorithm digestAlgorithm)	This method creates the ds:DigestMethod DOM object
protected void	incorporateDigestValue(Element parentDom, DigestAlgorithm digestAlgorithm, Token token)	This method creates the ds:DigestValue DOM object.
protected void	incorporateDigestValue(Element parentDom, DSSReference dssReference, DigestAlgorithm digestAlgorithm, DSSDocument originalDocument)	This method creates the ds:DigestValue DOM object.
protected void	incorporateIssuerV1(Element parentDom, CertificateToken certificate)
protected void	incorporateIssuerV2(Element parentDom, CertificateToken certificate)

Methods inherited from class java.lang.Object

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

Field Details

REFERENCED_DATA

public static final String REFERENCED_DATA

See Also:

Constant Field Values

SIGNATURE

public static final String SIGNATURE

See Also:

Constant Field Values

TARGET

public static final String TARGET

See Also:

Constant Field Values

URI

public static final String URI

See Also:

Constant Field Values

xadesPaths

protected XAdESPaths xadesPaths

This variable holds the XAdESPaths which contains all constants and queries needed to cope with the default signature schema.

params

protected XAdESSignatureParameters params

documentDom

protected Document documentDom

This is the variable which represents the root XML document root (with signature).

certificateVerifier

protected CertificateVerifier certificateVerifier

Reference to the object in charge of certificates validation

Constructor Details

XAdESBuilder

public XAdESBuilder(CertificateVerifier certificateVerifier)

The default constructor.

Parameters:

certificateVerifier - CertificateVerifier

Method Details

incorporateDigestMethod

protected void incorporateDigestMethod(Element parentDom, DigestAlgorithm digestAlgorithm)

This method creates the ds:DigestMethod DOM object

 
 		<ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
 
 

Parameters:

parentDom - the parent element

digestAlgorithm - the digest algorithm xml identifier

incorporateDigestValue

protected void incorporateDigestValue(Element parentDom, DSSReference dssReference, DigestAlgorithm digestAlgorithm, DSSDocument originalDocument)

This method creates the ds:DigestValue DOM object.

 
 		<ds:DigestValue>fj8SJujSXU4fi342bdtiKVbglA0=</ds:DigestValue>
 
 

Parameters:

parentDom - the parent element

dssReference - the current reference to incorporate

digestAlgorithm - the digest algorithm to be used

originalDocument - the document to be digested

incorporateDigestValue

protected void incorporateDigestValue(Element parentDom, DigestAlgorithm digestAlgorithm, Token token)

This method creates the ds:DigestValue DOM object.

 
 		<ds:DigestValue>fj8SJujSXU4fi342bdtiKVbglA0=</ds:DigestValue>
 
 

Parameters:

parentDom - the parent element

digestAlgorithm - the digest algorithm to use

token - the token to be digested

incorporateCertificateRef

protected void incorporateCertificateRef(Element signingCertificateDom, Set<CertificateToken> certificates)

Incorporates the certificate's references as a child of the given parent node. The first element of the X509Certificate List MUST be the signing certificate.

Parameters:

signingCertificateDom - DOM parent element

certificates - List of the certificates to be incorporated

incorporateCert

protected Element incorporateCert(Element parentDom, CertificateToken certificate)

Creates Cert DOM object:

 
 		<Cert>
 			<CertDigest>
 				<ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
 				<ds:DigestValue>fj8SJujSXU4fi342bdtiKVbglA0=</ds:DigestValue>
 			</CertDigest>
 			<IssuerSerial>
 				<ds:X509IssuerName>CN=ICA A,O=DSS,C=AA</ds:X509IssuerName>
 				<ds:X509SerialNumber>4</ds:X509SerialNumber>
			</IssuerSerial>
		</Cert>
 
 

Parameters:

parentDom - the parent element

certificate - the certificate to be added

incorporateIssuerV1

protected void incorporateIssuerV1(Element parentDom, CertificateToken certificate)

incorporateIssuerV2

protected void incorporateIssuerV2(Element parentDom, CertificateToken certificate)

createXmlDocument

protected DSSDocument createXmlDocument()

Creates DSSDocument from the current documentDom

Returns:

DSSDocument

alignNodes

protected abstract void alignNodes()

getXmldsigNamespace

protected DSSNamespace getXmldsigNamespace()

This method returns the current used XMLDSig namespace. Try to determine from the signature, from the parameters or the default value

getXadesNamespace

protected DSSNamespace getXadesNamespace()

This method returns the current used XAdES namespace. Try to determine from the signature, from the parameters or the default value

getXades141Namespace

protected DSSNamespace getXades141Namespace()

This method returns the current used XAdES 1.4.1 namespace. Try to determine from the signature, from the parameters or the default value

getCurrentXAdESElements

protected XAdESElement getCurrentXAdESElements()

getCurrentXAdESPaths

protected XAdESPaths getCurrentXAdESPaths()