Package eu.europa.esig.dss.signature

Class AbstractSignatureParameters<TP extends SerializableTimestampParameters>

java.lang.Object

eu.europa.esig.dss.model.AbstractSerializableSignatureParameters<TP>

eu.europa.esig.dss.signature.AbstractSignatureParameters<TP>

Type Parameters:

TP - implementation of certain format signature parameters

All Implemented Interfaces:

SerializableSignatureParameters, Serializable

Direct Known Subclasses:

CAdESSignatureParameters, JAdESSignatureParameters, XAdESSignatureParameters

public abstract class AbstractSignatureParameters<TP extends SerializableTimestampParameters>
extends AbstractSerializableSignatureParameters<TP>

Parameters for a Signature creation/extension

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ProfileParameters	context	The internal signature processing variable

Fields inherited from class eu.europa.esig.dss.model.AbstractSerializableSignatureParameters

archiveTimestampParameters, contentTimestampParameters, signatureTimestampParameters

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSignatureParameters()	Default constructor instantiating object with null values

Method Summary

Modifier and Type	Method	Description
List<CertificateToken>	getCertificateChain()	Set the certificate chain
List<TimestampToken>	getContentTimestamps()	Returns the list of the TimestampToken to be incorporated within the signature and representing the content-timestamp.
ProfileParameters	getContext()	Gets the signature creation context (internal variable)
List<DSSDocument>	getDetachedContents()	This method returns the documents to sign.
String	getDeterministicId()	The deterministic identifier used for unique identification of a created signature (used in XAdES and PAdES).
byte[]	getSignedData()	Get signed data
CertificateToken	getSigningCertificate()	Get the signing certificate
void	reinit()	This method re-inits signature parameters to clean temporary settings
void	setCertificateChain(CertificateToken... certificateChainArray)	This method sets the list of certificates which constitute the chain.
void	setCertificateChain(List<CertificateToken> certificateChain)	Set the certificate chain
void	setContentTimestamps(List<TimestampToken> contentTimestamps)	Sets a list of content timestamps to be included into the signature
void	setDetachedContents(List<DSSDocument> detachedContents)	When signing this method is internally invoked by the AbstractSignatureService and the related variable detachedContent is overwritten by the service parameter.
void	setSignedData(byte[] signedData)	Set signed data
void	setSigningCertificate(CertificateToken signingCertificate)	Set the signing certificate.

Methods inherited from class eu.europa.esig.dss.model.AbstractSerializableSignatureParameters

bLevel, equals, getArchiveTimestampParameters, getContentTimestampParameters, getDigestAlgorithm, getEncryptionAlgorithm, getMaskGenerationFunction, getReferenceDigestAlgorithm, getSignatureAlgorithm, getSignatureLevel, getSignaturePackaging, getSignatureTimestampParameters, hashCode, isCheckCertificateRevocation, isGenerateTBSWithoutCertificate, isSignWithExpiredCertificate, isSignWithNotYetValidCertificate, setArchiveTimestampParameters, setBLevelParams, setCheckCertificateRevocation, setContentTimestampParameters, setDigestAlgorithm, setEncryptionAlgorithm, setGenerateTBSWithoutCertificate, setMaskGenerationFunction, setReferenceDigestAlgorithm, setSignatureLevel, setSignaturePackaging, setSignatureTimestampParameters, setSignWithExpiredCertificate, setSignWithNotYetValidCertificate, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

context

protected ProfileParameters context

The internal signature processing variable

Constructor Details

AbstractSignatureParameters

protected AbstractSignatureParameters()

Default constructor instantiating object with null values

Method Details

getContentTimestamps

public List<TimestampToken> getContentTimestamps()

Returns the list of the TimestampToken to be incorporated within the signature and representing the content-timestamp.

Returns:

List of TimestampToken

setContentTimestamps

public void setContentTimestamps(List<TimestampToken> contentTimestamps)

Sets a list of content timestamps to be included into the signature

Parameters:

contentTimestamps - a list of TimestampTokens

getDetachedContents

public List<DSSDocument> getDetachedContents()

This method returns the documents to sign. In the case of the DETACHED signature this is the detached document.

Returns:

the list of detached documents

setDetachedContents

public void setDetachedContents(List<DSSDocument> detachedContents)

When signing this method is internally invoked by the AbstractSignatureService and the related variable detachedContent is overwritten by the service parameter. In the case of the DETACHED signature this is the detached document. In the case of ASiC-S this is the document to be signed.

When extending this method must be invoked to indicate the detachedContent.

Parameters:

detachedContents - the list of detached documents

getSigningCertificate

public CertificateToken getSigningCertificate()

Get the signing certificate

Returns:

the signing certificate

setSigningCertificate

public void setSigningCertificate(CertificateToken signingCertificate)

Set the signing certificate. The encryption algorithm is also set from the public key. Note: This method overwrites the encryptionAlgorithm value by extracting the encryption algorithm from the provided signing-certificate. In order to enforce a specific encryption algorithm (when supported by the key), please execute #setEncryptionAlgorithm method after this method.

Parameters:

signingCertificate - the signing certificate

getSignedData

public byte[] getSignedData()

Get signed data

Returns:

signed data binaries

setSignedData

public void setSignedData(byte[] signedData)

Set signed data

Parameters:

signedData - data that was used when creating the signature value.

getCertificateChain

public List<CertificateToken> getCertificateChain()

Set the certificate chain

Returns:

the certificate chain

setCertificateChain

public void setCertificateChain(List<CertificateToken> certificateChain)

Set the certificate chain

Parameters:

certificateChain - the List of CertificateTokens

setCertificateChain

public void setCertificateChain(CertificateToken... certificateChainArray)

This method sets the list of certificates which constitute the chain. If the certificate is already present in the array then it is ignored.

Parameters:

certificateChainArray - the array containing all certificates composing the chain

getDeterministicId

public String getDeterministicId()

The deterministic identifier used for unique identification of a created signature (used in XAdES and PAdES). The identifier shall be built in a deterministic way to ensure the same value on both method calls during the signature creation.

Returns:

the unique ID for the current signature or a document

getContext

public ProfileParameters getContext()

Gets the signature creation context (internal variable)

Returns:

ProfileParameters

reinit

public void reinit()

This method re-inits signature parameters to clean temporary settings