Package eu.europa.esig.dss.ws.signature.dto.parameters

Class RemoteSignatureParameters

java.lang.Object

eu.europa.esig.dss.ws.signature.dto.parameters.RemoteSignatureParameters

All Implemented Interfaces:

Serializable

public class RemoteSignatureParameters
extends Object
implements Serializable

The parameters for a signature creation

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RemoteSignatureParameters()	Default constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
RemoteTimestampParameters	getArchiveTimestampParameters()	Get the parameters for achive timestamp (Baseline-LTA)
ASiCContainerType	getAsicContainerType()	Gets ASiC container type
RemoteBLevelParameters	getBLevelParams()	Get Baseline B parameters (signed properties)
List<RemoteCertificate>	getCertificateChain()	Gets the certificate chain
RemoteTimestampParameters	getContentTimestampParameters()	Get the parameters for content timestamp (Baseline-B)
List<TimestampDTO>	getContentTimestamps()	Gets a list of content timestamps
List<RemoteDocument>	getDetachedContents()	Gets the detached contents
DigestAlgorithm	getDigestAlgorithm()	Get the digest algorithm
EncryptionAlgorithm	getEncryptionAlgorithm()	Get the encryption algorithm
RemoteSignatureImageParameters	getImageParameters()	Get the image information to be included (PAdES).
JWSSerializationType	getJwsSerializationType()	Gets JWSSerializationType NOTE: used only for JAdES
MaskGenerationFunction	getMaskGenerationFunction()	Deprecated. since DSS 6.1.
DigestAlgorithm	getReferenceDigestAlgorithm()	Get the digest algorithm for ds:Reference or message-digest attribute
SigDMechanism	getSigDMechanism()	Gets SigDMechanism NOTE: used only for JAdES with DETACHED packaging
SignatureAlgorithm	getSignatureAlgorithm()	Deprecated. since DSS 6.1.
String	getSignatureIdToCounterSign()	Returns a signature Id being counter signed
SignatureLevel	getSignatureLevel()	Get signature level: XAdES_BASELINE_T, CAdES_BASELINE_LTA...
SignaturePackaging	getSignaturePackaging()	Get Signature packaging
RemoteTimestampParameters	getSignatureTimestampParameters()	Get the parameters for signature timestamp (Baseline-T)
RemoteCertificate	getSigningCertificate()	Gets the signing certificate
int	hashCode()
boolean	isBase64UrlEncodedEtsiUComponents()	Gets whether etsiU header components shall be base64url encoded NOTE: used only for JAdES
boolean	isBase64UrlEncodedPayload()	Gets whether a payload shall be base64url encoded NOTE: used only for JAdES
boolean	isEmbedXML()	Returns if original XML document shall be embedded into ENVELOPING signature in its clear XML representation
boolean	isGenerateTBSWithoutCertificate()	Indicates if it is possible to generate ToBeSigned data without the signing certificate.
boolean	isManifestSignature()	Returns if a manifest signature should be created
boolean	isSignWithExpiredCertificate()	Deprecated. since DSS 6.1.
void	setArchiveTimestampParameters(RemoteTimestampParameters archiveTimestampParameters)	Set the parameters to produce the archive timestamp (Baseline-LTA)
void	setAsicContainerType(ASiCContainerType asicContainerType)	Sets ASiCContainerType for ASiC format creation
void	setBase64UrlEncodedEtsiUComponents(boolean base64UrlEncodedEtsiUComponents)	Sets whether etsiU header components shall be base64url encoded NOTE: used only for JAdES
void	setBase64UrlEncodedPayload(boolean base64UrlEncodedPayload)	Sets whether a payload shall be base64url encoded NOTE: used only for JAdES
void	setBLevelParams(RemoteBLevelParameters bLevelParams)	Set the Baseline B parameters (signed properties)
void	setCertificateChain(List<RemoteCertificate> certificateChain)	Sets the certificate chain of the signing certificate
void	setContentTimestampParameters(RemoteTimestampParameters contentTimestampParameters)	Set the parameters to produce the content timestamp (Baseline-B)
void	setContentTimestamps(List<TimestampDTO> contentTimestamps)	Sets a list of content timestamps to be added into the signature
void	setDetachedContents(List<RemoteDocument> detachedContents)	Sets a list of signed detached documents
void	setDigestAlgorithm(DigestAlgorithm digestAlgorithm)	Set the digest algorithm
void	setEmbedXML(boolean embedXML)	Sets whether the original XML document shall be embedded in its XML representation NOTE: used only for XAdES
void	setEncryptionAlgorithm(EncryptionAlgorithm encryptionAlgorithm)	This setter should be used only when dealing with web services (or when signing in three steps).
void	setGenerateTBSWithoutCertificate(boolean generateTBSWithoutCertificate)	Allows to change the default behaviour regarding the requirements of signing certificate to generate ToBeSigned data.
void	setImageParameters(RemoteSignatureImageParameters imageParameters)	Set the image information to be included (PAdES).
void	setJwsSerializationType(JWSSerializationType jwsSerializationType)	Sets JWSSerializationType
void	setManifestSignature(boolean manifestSignature)	Sets whether a manifest signature shall be created NOTE: used only for XAdES
void	setMaskGenerationFunction(MaskGenerationFunction maskGenerationFunction)	Deprecated. since DSS 6.1.
void	setReferenceDigestAlgorithm(DigestAlgorithm referenceDigestAlgorithm)	Sets the digest algorithm for ds:Reference or message-digest attribute
void	setSigDMechanism(SigDMechanism sigDMechanism)	Sets SigDMechanism NOTE: used only for JAdES with DETACHED packaging
void	setSignatureAlgorithm(SignatureAlgorithm signatureAlgorithm)	Deprecated. since DSS 6.1.
void	setSignatureIdToCounterSign(String signatureIdToCounterSign)	Sets the signature Id to counter sign
void	setSignatureLevel(SignatureLevel signatureLevel)	Set signature level.
void	setSignaturePackaging(SignaturePackaging signaturePackaging)	Set Signature packaging
void	setSignatureTimestampParameters(RemoteTimestampParameters signatureTimestampParameters)	Set the parameters to produce the signature timestamp (Baseline-T)
void	setSigningCertificate(RemoteCertificate signingCertificate)	Sets the signing certificate
void	setSignWithExpiredCertificate(boolean signWithExpiredCertificate)	Deprecated. since DSS 6.1.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

RemoteSignatureParameters

public RemoteSignatureParameters()

Default constructor

Method Details

getSigningCertificate

public RemoteCertificate getSigningCertificate()

Gets the signing certificate

Returns:

RemoteCertificate

setSigningCertificate

public void setSigningCertificate(RemoteCertificate signingCertificate)

Sets the signing certificate

Parameters:

signingCertificate - RemoteCertificate

getCertificateChain

public List<RemoteCertificate> getCertificateChain()

Gets the certificate chain

Returns:

a list of RemoteCertificates

setCertificateChain

public void setCertificateChain(List<RemoteCertificate> certificateChain)

Sets the certificate chain of the signing certificate

Parameters:

certificateChain - a list of RemoteCertificates

getDetachedContents

public List<RemoteDocument> getDetachedContents()

Gets the detached contents

Returns:

a list of RemoteDocuments

setDetachedContents

public void setDetachedContents(List<RemoteDocument> detachedContents)

Sets a list of signed detached documents

Parameters:

detachedContents - a ist of RemoteDocuments

getAsicContainerType

public ASiCContainerType getAsicContainerType()

Gets ASiC container type

Returns:

ASiCContainerType

setAsicContainerType

public void setAsicContainerType(ASiCContainerType asicContainerType)

Sets ASiCContainerType for ASiC format creation

Parameters:

asicContainerType - ASiCContainerType

getSignatureLevel

public SignatureLevel getSignatureLevel()

Get signature level: XAdES_BASELINE_T, CAdES_BASELINE_LTA...

Returns:

the expected signature level

setSignatureLevel

public void setSignatureLevel(SignatureLevel signatureLevel)

Set signature level. This field cannot be null.

Parameters:

signatureLevel - the expected signature level

isEmbedXML

public boolean isEmbedXML()

Returns if original XML document shall be embedded into ENVELOPING signature in its clear XML representation

Returns:

TRUE if the original document shall be embedded in its XML representation, FALSE of base64 encoded

setEmbedXML

public void setEmbedXML(boolean embedXML)

Sets whether the original XML document shall be embedded in its XML representation NOTE: used only for XAdES

Parameters:

embedXML - whether the original object shall be embedded as XML

isManifestSignature

public boolean isManifestSignature()

Returns if a manifest signature should be created

Returns:

TRUE if a signature signs an XML Manifest, FALSE otherwise

setManifestSignature

public void setManifestSignature(boolean manifestSignature)

Sets whether a manifest signature shall be created NOTE: used only for XAdES

Parameters:

manifestSignature - whether a manifest signature shall be created

getJwsSerializationType

public JWSSerializationType getJwsSerializationType()

Gets JWSSerializationType NOTE: used only for JAdES

Returns:

JWSSerializationType

setJwsSerializationType

public void setJwsSerializationType(JWSSerializationType jwsSerializationType)

Sets JWSSerializationType

Parameters:

jwsSerializationType - JWSSerializationType to use

getSigDMechanism

public SigDMechanism getSigDMechanism()

Gets SigDMechanism NOTE: used only for JAdES with DETACHED packaging

Returns:

SigDMechanism

setSigDMechanism

public void setSigDMechanism(SigDMechanism sigDMechanism)

Sets SigDMechanism NOTE: used only for JAdES with DETACHED packaging

Parameters:

sigDMechanism - SigDMechanism to use

isBase64UrlEncodedPayload

public boolean isBase64UrlEncodedPayload()

Gets whether a payload shall be base64url encoded NOTE: used only for JAdES

Returns:

whether a JAdES payload shall be base64url encoded

setBase64UrlEncodedPayload

public void setBase64UrlEncodedPayload(boolean base64UrlEncodedPayload)

Sets whether a payload shall be base64url encoded NOTE: used only for JAdES

Parameters:

base64UrlEncodedPayload - whether a JAdES payload shall be base64url encoded

isBase64UrlEncodedEtsiUComponents

public boolean isBase64UrlEncodedEtsiUComponents()

Gets whether etsiU header components shall be base64url encoded NOTE: used only for JAdES

Returns:

whether JAdES etsiU header components shall be base64url encoded

setBase64UrlEncodedEtsiUComponents

public void setBase64UrlEncodedEtsiUComponents(boolean base64UrlEncodedEtsiUComponents)

Sets whether etsiU header components shall be base64url encoded NOTE: used only for JAdES

Parameters:

base64UrlEncodedEtsiUComponents - whether JAdES etsiU header components shall be base64url encoded

getReferenceDigestAlgorithm

public DigestAlgorithm getReferenceDigestAlgorithm()

Get the digest algorithm for ds:Reference or message-digest attribute

Returns:

the digest algorithm for ds:Reference or message-digest attribute

setReferenceDigestAlgorithm

public void setReferenceDigestAlgorithm(DigestAlgorithm referenceDigestAlgorithm)

Sets the digest algorithm for ds:Reference or message-digest attribute

Parameters:

referenceDigestAlgorithm - DigestAlgorithm

getBLevelParams

public RemoteBLevelParameters getBLevelParams()

Get Baseline B parameters (signed properties)

Returns:

the Baseline B parameters

setBLevelParams

public void setBLevelParams(RemoteBLevelParameters bLevelParams)

Set the Baseline B parameters (signed properties)

Parameters:

bLevelParams - the baseline B properties

getSignaturePackaging

public SignaturePackaging getSignaturePackaging()

Get Signature packaging

Returns:

the expected signature packaging

setSignaturePackaging

public void setSignaturePackaging(SignaturePackaging signaturePackaging)

Set Signature packaging

Parameters:

signaturePackaging - the expected signature packaging

getSignatureAlgorithm

@Deprecated
public SignatureAlgorithm getSignatureAlgorithm()

Deprecated.

since DSS 6.1. Please use SignatureAlgorithm.getAlgorithm(getEncryptionAlgorithm(), getDigestAlgorithm())

Gets the signature algorithm.

Returns:

the signature algorithm

setSignatureAlgorithm

@Deprecated
public void setSignatureAlgorithm(SignatureAlgorithm signatureAlgorithm)

Deprecated.

since DSS 6.1. Please use #setDigestAlgorithm and #setEncryptionAlgorithm methods

Sets the signature algorithm

Parameters:

signatureAlgorithm - SignatureAlgorithm

getDigestAlgorithm

public DigestAlgorithm getDigestAlgorithm()

Get the digest algorithm

Returns:

the digest algorithm

setDigestAlgorithm

public void setDigestAlgorithm(DigestAlgorithm digestAlgorithm)

Set the digest algorithm

Parameters:

digestAlgorithm - the digest algorithm to set

getEncryptionAlgorithm

public EncryptionAlgorithm getEncryptionAlgorithm()

Get the encryption algorithm

Returns:

the encryption algorithm.

setEncryptionAlgorithm

public void setEncryptionAlgorithm(EncryptionAlgorithm encryptionAlgorithm)

This setter should be used only when dealing with web services (or when signing in three steps). Usually the encryption algorithm is automatically extrapolated from the private key.

Parameters:

encryptionAlgorithm - the encryption algorithm to use

getMaskGenerationFunction

@Deprecated
public MaskGenerationFunction getMaskGenerationFunction()

Deprecated.

since DSS 6.1. Please use #getEncryptionAlgorithm to differentiate between MGF1 (EncryptionAlgorithm.RSASSA_PSS) and none MGF (any other result)

Get the mask generation function

Returns:

the mask generation function.

setMaskGenerationFunction

@Deprecated
public void setMaskGenerationFunction(MaskGenerationFunction maskGenerationFunction)

Deprecated.

since DSS 6.1. Please use #setEncryptionAlgorithm method to specify mask generation function using EncryptionAlgorithm.RSA for none MGF, EncryptionAlgorithm.RSASSA_PSS for MGF1

Sets the mask generation function of the signature algorithm, when applicable

Parameters:

maskGenerationFunction - MaskGenerationFunction

getContentTimestamps

public List<TimestampDTO> getContentTimestamps()

Gets a list of content timestamps

Returns:

list of TimestampDTOs

setContentTimestamps

public void setContentTimestamps(List<TimestampDTO> contentTimestamps)

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

Parameters:

contentTimestamps - list of content TimestampDTOs to set

getContentTimestampParameters

public RemoteTimestampParameters getContentTimestampParameters()

Get the parameters for content timestamp (Baseline-B)

Returns:

the parameters to produce a content timestamp

setContentTimestampParameters

public void setContentTimestampParameters(RemoteTimestampParameters contentTimestampParameters)

Set the parameters to produce the content timestamp (Baseline-B)

Parameters:

contentTimestampParameters - the parameters to produce the content timestamp

getSignatureTimestampParameters

public RemoteTimestampParameters getSignatureTimestampParameters()

Get the parameters for signature timestamp (Baseline-T)

Returns:

the parameters to produce a signature timestamp

setSignatureTimestampParameters

public void setSignatureTimestampParameters(RemoteTimestampParameters signatureTimestampParameters)

Set the parameters to produce the signature timestamp (Baseline-T)

Parameters:

signatureTimestampParameters - the parameters to produce the signature timestamp

getArchiveTimestampParameters

public RemoteTimestampParameters getArchiveTimestampParameters()

Get the parameters for achive timestamp (Baseline-LTA)

Returns:

the parameters to produce an archive timestamp

setArchiveTimestampParameters

public void setArchiveTimestampParameters(RemoteTimestampParameters archiveTimestampParameters)

Set the parameters to produce the archive timestamp (Baseline-LTA)

Parameters:

archiveTimestampParameters - the parameters to produce the archive timestamp

isSignWithExpiredCertificate

@Deprecated
public boolean isSignWithExpiredCertificate()

Deprecated.

since DSS 6.1. See CertificateVerifier#setAlertOnExpiredCertificate

Indicates if it is possible to sign with an expired certificate. The default value is false.

Returns:

true if signature with an expired certificate is allowed

setSignWithExpiredCertificate

@Deprecated
public void setSignWithExpiredCertificate(boolean signWithExpiredCertificate)

Deprecated.

since DSS 6.1. Please use CertificateVerifier#setAlertOnExpiredCertificate method instead

Allows to change the default behavior regarding the use of an expired certificate.

Parameters:

signWithExpiredCertificate - true if signature with an expired certificate is allowed

isGenerateTBSWithoutCertificate

public boolean isGenerateTBSWithoutCertificate()

Indicates if it is possible to generate ToBeSigned data without the signing certificate. The default values is false.

Returns:

true if signing certificate is not required when generating ToBeSigned data.

setGenerateTBSWithoutCertificate

public void setGenerateTBSWithoutCertificate(boolean generateTBSWithoutCertificate)

Allows to change the default behaviour regarding the requirements of signing certificate to generate ToBeSigned data.

Parameters:

generateTBSWithoutCertificate - true if it should be possible to generate ToBeSigned data without certificate.

getImageParameters

public RemoteSignatureImageParameters getImageParameters()

Get the image information to be included (PAdES).

Returns:

RemoteSignatureImageParameters the image information to be included.

setImageParameters

public void setImageParameters(RemoteSignatureImageParameters imageParameters)

Set the image information to be included (PAdES).

Parameters:

imageParameters - RemoteSignatureImageParameters the image information to be included.

getSignatureIdToCounterSign

public String getSignatureIdToCounterSign()

Returns a signature Id being counter signed

Returns:

String signature Id to counter sign

setSignatureIdToCounterSign

public void setSignatureIdToCounterSign(String signatureIdToCounterSign)

Sets the signature Id to counter sign

Parameters:

signatureIdToCounterSign - String signature id to counter sign

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object