Package eu.europa.esig.dss.model

Class AbstractSerializableSignatureParameters<TP extends SerializableTimestampParameters>

java.lang.Object
eu.europa.esig.dss.model.AbstractSerializableSignatureParameters<TP>
All Implemented Interfaces:
SerializableSignatureParameters, Serializable
Direct Known Subclasses:
AbstractSignatureParameters
public abstract class AbstractSerializableSignatureParameters<TP extends SerializableTimestampParameters>
extends Object
implements SerializableSignatureParameters
Parameters for a Signature creation/extension
See Also:
Serialized Form

  • Field Details

    • contentTimestampParameters

      protected TP extends SerializableTimestampParameters contentTimestampParameters
      The object representing the parameters related to the content timestamp (Baseline-B)

    • signatureTimestampParameters

      protected TP extends SerializableTimestampParameters signatureTimestampParameters
      The object representing the parameters related to the signature timestamp (Baseline-T)

    • archiveTimestampParameters

      protected TP extends SerializableTimestampParameters archiveTimestampParameters
      The object representing the parameters related to the archive timestamp (Baseline-LTA)

  • Constructor Details

    • AbstractSerializableSignatureParameters

      public AbstractSerializableSignatureParameters()

  • Method Details

    • isSignWithExpiredCertificate

      public boolean isSignWithExpiredCertificate()
      Indicates if it is possible to sign with an expired certificate. The default value is false.
      Specified by:
      isSignWithExpiredCertificate in interface SerializableSignatureParameters
      Returns:
      true if signature with an expired certificate is allowed

    • setSignWithExpiredCertificate

      public void setSignWithExpiredCertificate​(boolean signWithExpiredCertificate)
      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.
      Specified by:
      isGenerateTBSWithoutCertificate in interface SerializableSignatureParameters
      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.

    • 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

    • 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

    • getDigestAlgorithm

      public DigestAlgorithm getDigestAlgorithm()
      Get the digest algorithm
      Specified by:
      getDigestAlgorithm in interface SerializableSignatureParameters
      Returns:
      the digest algorithm

    • setDigestAlgorithm

      public void setDigestAlgorithm​(DigestAlgorithm digestAlgorithm)
      Set the digest algorithm
      Parameters:
      digestAlgorithm - the digest algorithm to set

    • 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

    • setMaskGenerationFunction

      public void setMaskGenerationFunction​(MaskGenerationFunction maskGenerationFunction)
      Sets the mask generation function if used with the given SignatureAlgorithm
      Parameters:
      maskGenerationFunction - MaskGenerationFunction

    • getEncryptionAlgorithm

      public EncryptionAlgorithm getEncryptionAlgorithm()
      Get the encryption algorithm
      Returns:
      the encryption algorithm.

    • getSignatureAlgorithm

      public SignatureAlgorithm getSignatureAlgorithm()
      Gets the signature algorithm.
      Returns:
      the signature algorithm

    • getMaskGenerationFunction

      public MaskGenerationFunction getMaskGenerationFunction()
      Description copied from interface: SerializableSignatureParameters
      Returns the mask generation function
      Specified by:
      getMaskGenerationFunction in interface SerializableSignatureParameters
      Returns:
      MaskGenerationFunction

    • 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 DigestAlgorithm to be used for reference digest calculation
      Parameters:
      referenceDigestAlgorithm - DigestAlgorithm

    • bLevel

      public BLevelParameters bLevel()
      Get Baseline B parameters (signed properties)
      Specified by:
      bLevel in interface SerializableSignatureParameters
      Returns:
      the Baseline B parameters

    • setBLevelParams

      public void setBLevelParams​(BLevelParameters bLevelParams)
      Set the Baseline B parameters (signed properties)
      Parameters:
      bLevelParams - the baseline B properties

    • getContentTimestampParameters

      public TP getContentTimestampParameters()
      Get the parameters for content timestamp (Baseline-B)
      Returns:
      the parameters to produce a content timestamp

    • setContentTimestampParameters

      public void setContentTimestampParameters​(TP contentTimestampParameters)
      Set the parameters to produce the content timestamp (Baseline-B)
      Parameters:
      contentTimestampParameters - the parameters to produce the content timestamp

    • getSignatureTimestampParameters

      public TP getSignatureTimestampParameters()
      Get the parameters for signature timestamp (Baseline-T)
      Returns:
      the parameters to produce a signature timestamp

    • setSignatureTimestampParameters

      public void setSignatureTimestampParameters​(TP signatureTimestampParameters)
      Set the parameters to produce the signature timestamp (Baseline-T)
      Parameters:
      signatureTimestampParameters - the parameters to produce the signature timestamp

    • getArchiveTimestampParameters

      public TP getArchiveTimestampParameters()
      Get the parameters for achive timestamp (Baseline-LTA)
      Returns:
      the parameters to produce an archive timestamp

    • setArchiveTimestampParameters

      public void setArchiveTimestampParameters​(TP archiveTimestampParameters)
      Set the parameters to produce the archive timestamp (Baseline-LTA)
      Parameters:
      archiveTimestampParameters - the parameters to produce the archive timestamp

    • 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