Package eu.europa.esig.dss.xades.tsl

Class AbstractTrustedListSignatureParametersBuilder

java.lang.Object

eu.europa.esig.dss.signature.AbstractSignatureParametersBuilder<XAdESSignatureParameters>

eu.europa.esig.dss.xades.tsl.AbstractTrustedListSignatureParametersBuilder

All Implemented Interfaces:

SignatureParametersBuilder<XAdESSignatureParameters>

Direct Known Subclasses:

TrustedListV5SignatureParametersBuilder, TrustedListV6SignatureParametersBuilder

public abstract class AbstractTrustedListSignatureParametersBuilder
extends AbstractSignatureParametersBuilder<XAdESSignatureParameters>

This class contains common methods for signature parameters creation for an XML Trusted List signature

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTrustedListSignatureParametersBuilder(CertificateToken signingCertificate, DSSDocument tlXmlDocument)	The constructor to build Signature Parameters for a Trusted List signing with respect to ETSI TS 119 612

Method Summary

Modifier and Type	Method	Description
void	assertConfigurationIsValid()	This method helps to determine whether the chosen signature parameters builders is applicable to the given document.
XAdESSignatureParameters	build()	Creates a Signature Parameters instance
protected DSSReference	getEnvelopedSignatureReference()	Creates the enveloped-signature ds:Reference
protected List<DSSReference>	getReferences()	Returns a list of ds:References to be incorporated within the signature
protected abstract Integer	getTargetTLVersion()	This method returns the target XML Trusted List version to be signed
protected XAdESSignatureParameters	initParameters()	Initialize and return empty signature parameters
protected abstract boolean	isEn319132()	Gets whether the created XAdES signature shall be conformant to ETSI EN 319 132 standard
AbstractTrustedListSignatureParametersBuilder	setReferenceDigestAlgorithm(DigestAlgorithm digestAlgorithm)	Sets an Enveloped Reference DigestAlgorithm to use
AbstractTrustedListSignatureParametersBuilder	setReferenceId(String referenceId)	Sets an Enveloped Reference Id to use

Methods inherited from class eu.europa.esig.dss.signature.AbstractSignatureParametersBuilder

bLevel, setBLevelParams, setDigestAlgorithm, setEncryptionAlgorithm

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractTrustedListSignatureParametersBuilder

protected AbstractTrustedListSignatureParametersBuilder(CertificateToken signingCertificate,
 DSSDocument tlXmlDocument)

The constructor to build Signature Parameters for a Trusted List signing with respect to ETSI TS 119 612

Parameters:

signingCertificate - CertificateToken to be used for a signature creation

tlXmlDocument - DSSDocument Trusted List XML document to be signed

Method Details

setReferenceId

public AbstractTrustedListSignatureParametersBuilder setReferenceId(String referenceId)

Sets an Enveloped Reference Id to use

Default: "ref-enveloped-signature"

Parameters:

referenceId - String reference Id

Returns:

this builder

setReferenceDigestAlgorithm

public AbstractTrustedListSignatureParametersBuilder setReferenceDigestAlgorithm(DigestAlgorithm digestAlgorithm)

Sets an Enveloped Reference DigestAlgorithm to use

Parameters:

digestAlgorithm - DigestAlgorithm to be used

Returns:

this builder

initParameters

protected XAdESSignatureParameters initParameters()

Description copied from class: AbstractSignatureParametersBuilder

Initialize and return empty signature parameters

Specified by:

initParameters in class AbstractSignatureParametersBuilder<XAdESSignatureParameters>

Returns:

SP signature parameters

build

public XAdESSignatureParameters build()

Description copied from interface: SignatureParametersBuilder

Creates a Signature Parameters instance

Specified by:

build in interface SignatureParametersBuilder<XAdESSignatureParameters>

Overrides:

build in class AbstractSignatureParametersBuilder<XAdESSignatureParameters>

Returns:

SP signature parameters

isEn319132

protected abstract boolean isEn319132()

Gets whether the created XAdES signature shall be conformant to ETSI EN 319 132 standard

Returns:

TRUE if the created signature shall be conformant to ETSI EN 319 132 standard (new XAdES), FALSE otherwise

getReferences

protected List<DSSReference> getReferences()

Returns a list of ds:References to be incorporated within the signature

Returns:

a list of DSSReferences

getEnvelopedSignatureReference

protected DSSReference getEnvelopedSignatureReference()

Creates the enveloped-signature ds:Reference

Returns:

DSSReference

assertConfigurationIsValid

public void assertConfigurationIsValid()
                                throws IllegalInputException

This method helps to determine whether the chosen signature parameters builders is applicable to the given document. Thus, it verifies whether the provided document representing the XML Trusted List is conformant to the definition and the target version. NOTE: this method requires 'dss-validation' module.

Throws:

IllegalInputException - if the provided XML Trusted List has invalid structure

DSSException - is other error occurred during the processing

getTargetTLVersion

protected abstract Integer getTargetTLVersion()

This method returns the target XML Trusted List version to be signed

Returns:

Integer