Module jpms_dss_pades
Package eu.europa.esig.dss.pades

Class PAdESSignatureParameters

java.lang.Object
eu.europa.esig.dss.model.AbstractSerializableSignatureParameters<TP>
eu.europa.esig.dss.AbstractSignatureParameters<eu.europa.esig.dss.cades.signature.CAdESTimestampParameters>
eu.europa.esig.dss.cades.CAdESSignatureParameters
eu.europa.esig.dss.pades.PAdESSignatureParameters
All Implemented Interfaces:
eu.europa.esig.dss.model.SerializableSignatureParameters, PAdESCommonParameters, Serializable
public class PAdESSignatureParameters extends eu.europa.esig.dss.cades.CAdESSignatureParameters implements PAdESCommonParameters
Parameters to create/extend a PAdES signature
See Also:

  • Field Summary

    Fields inherited from class eu.europa.esig.dss.AbstractSignatureParameters

    context

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

    archiveTimestampParameters, contentTimestampParameters, signatureTimestampParameters

  • Constructor Summary

    Constructors
    Constructor
    Description
    PAdESSignatureParameters()
    Default constructor instantiating object with default parameters

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAppName()
    Returns name of an application used to create a signature/timestamp
    PAdESTimestampParameters
    getArchiveTimestampParameters()
     
    String
    getContactInfo()
    Gets the contactInfo
    int
    getContentSize()
    Returns a length of the reserved /Contents attribute
    PAdESTimestampParameters
    getContentTimestampParameters()
     
    PAdESProfileParameters
    getContext()
     
    String
    getFilter()
    Returns Filter value
    SignatureImageParameters
    getImageParameters()
    Returns SignatureImageParameters for field's visual representation
    String
    getLocation()
    Gets location
    char[]
    getPasswordProtection()
    Returns a password used to encrypt a document
    PdfSignatureCache
    getPdfSignatureCache()
    Returns an internal variable, used to cache data in order to accelerate signing process
    eu.europa.esig.dss.enumerations.CertificationPermission
    getPermission()
    Gets the permission for the PDF document modification
    String
    getReason()
    Gets the reason
    PAdESTimestampParameters
    getSignatureTimestampParameters()
     
    String
    getSignerName()
    Returns the Signer Name
    Date
    getSigningDate()
    Returns a claimed signing time
    TimeZone
    getSigningTimeZone()
    Returns a time-zone used to define the signing time
    String
    getSubFilter()
    Returns SubFilter value
    boolean
    isIncludeVRIDictionary()
    Returns whether the VRI dictionary should be included to the PAdES Signature on extension within LT-level revision (DSS revision)
    void
    setAppName(String appName)
    Sets signing application name
    void
    setArchiveTimestampParameters(eu.europa.esig.dss.cades.signature.CAdESTimestampParameters archiveTimestampParameters)
     
    void
    setContactInfo(String contactInfo)
    Sets the contactInfo
    void
    setContentSize(int signatureSize)
    This setter defines an amount of bytes to be reserved for a CMS signature contents encapsulation Default : 9472 bytes
    void
    setContentTimestampParameters(eu.europa.esig.dss.cades.signature.CAdESTimestampParameters contentTimestampParameters)
     
    void
    setFilter(String signatureFilter)
    Sets the filter
    void
    setImageParameters(SignatureImageParameters signatureImageParameters)
    Sets the SignatureImageParameters for a visual signature creation
    void
    setIncludeVRIDictionary(boolean includeVRIDictionary)
    Sets whether corresponding VRI dictionary should be included to the PAdES signature on extension to LT-level Default: FALSE (VRI dictionary is not included to PAdES signature)
    void
    setLocation(String location)
    Sets location (The CPU host name or physical location of the signing)
    void
    setPasswordProtection(char[] passwordProtection)
    Sets password to the document
    void
    setPermission(eu.europa.esig.dss.enumerations.CertificationPermission permission)
    Sets the permission for the PDF document modification
    void
    setReason(String reason)
    Sets the reason
    void
    setSignatureLevel(eu.europa.esig.dss.enumerations.SignatureLevel signatureLevel)
     
    void
    setSignatureTimestampParameters(eu.europa.esig.dss.cades.signature.CAdESTimestampParameters signatureTimestampParameters)
     
    void
    setSignerName(String signerName)
    Sets the name of the signed
    void
    setSigningTimeZone(TimeZone signingTimeZone)
    Sets a TimeZone to use for signature creation.
    void
    setSubFilter(String signatureSubFilter)
    Sets the sub filter

    Methods inherited from class eu.europa.esig.dss.cades.CAdESSignatureParameters

    getContentHintsDescription, getContentHintsType, getContentIdentifierPrefix, getContentIdentifierSuffix, isEn319122, setContentHintsDescription, setContentHintsType, setContentIdentifierPrefix, setContentIdentifierSuffix, setEn319122

    Methods inherited from class eu.europa.esig.dss.AbstractSignatureParameters

    getCertificateChain, getContentTimestamps, getDetachedContents, getDeterministicId, getSignedData, getSigningCertificate, reinit, setCertificateChain, setCertificateChain, setContentTimestamps, setDetachedContents, setSignedData, setSigningCertificate

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

    bLevel, equals, getDigestAlgorithm, getEncryptionAlgorithm, getMaskGenerationFunction, getReferenceDigestAlgorithm, getSignatureAlgorithm, getSignatureLevel, getSignaturePackaging, hashCode, isCheckCertificateRevocation, isGenerateTBSWithoutCertificate, isSignWithExpiredCertificate, isSignWithNotYetValidCertificate, setBLevelParams, setCheckCertificateRevocation, setDigestAlgorithm, setEncryptionAlgorithm, setGenerateTBSWithoutCertificate, setMaskGenerationFunction, setReferenceDigestAlgorithm, setSignaturePackaging, setSignWithExpiredCertificate, setSignWithNotYetValidCertificate, toString

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface eu.europa.esig.dss.pades.PAdESCommonParameters

    getDeterministicId, getDigestAlgorithm, reinit

  • Constructor Details

    • PAdESSignatureParameters

      public PAdESSignatureParameters()
      Default constructor instantiating object with default parameters

  • Method Details

    • setSignatureLevel

      public void setSignatureLevel(eu.europa.esig.dss.enumerations.SignatureLevel signatureLevel)
      Overrides:
      setSignatureLevel in class eu.europa.esig.dss.model.AbstractSerializableSignatureParameters<eu.europa.esig.dss.cades.signature.CAdESTimestampParameters>

    • getReason

      public String getReason()
      Gets the reason
      Returns:
      String

    • setReason

      public void setReason(String reason)
      Sets the reason
      Parameters:
      reason - String the reason to set

    • getContactInfo

      public String getContactInfo()
      Gets the contactInfo
      Returns:
      String

    • setContactInfo

      public void setContactInfo(String contactInfo)
      Sets the contactInfo
      Parameters:
      contactInfo - String

    • getLocation

      public String getLocation()
      Gets location
      Returns:
      String

    • setLocation

      public void setLocation(String location)
      Sets location (The CPU host name or physical location of the signing)
      Parameters:
      location - String

    • getSignerName

      public String getSignerName()
      Returns the Signer Name
      Returns:
      String

    • setSignerName

      public void setSignerName(String signerName)
      Sets the name of the signed
      Parameters:
      signerName - String

    • getFilter

      public String getFilter()
      Description copied from interface: PAdESCommonParameters
      Returns Filter value
      Specified by:
      getFilter in interface PAdESCommonParameters
      Returns:
      String filter

    • setFilter

      public void setFilter(String signatureFilter)
      Sets the filter
      Parameters:
      signatureFilter - String

    • getSubFilter

      public String getSubFilter()
      Description copied from interface: PAdESCommonParameters
      Returns SubFilter value
      Specified by:
      getSubFilter in interface PAdESCommonParameters
      Returns:
      String subFilter

    • setSubFilter

      public void setSubFilter(String signatureSubFilter)
      Sets the sub filter
      Parameters:
      signatureSubFilter - String

    • getAppName

      public String getAppName()
      Description copied from interface: PAdESCommonParameters
      Returns name of an application used to create a signature/timestamp
      Specified by:
      getAppName in interface PAdESCommonParameters
      Returns:
      String

    • setAppName

      public void setAppName(String appName)
      Sets signing application name
      Parameters:
      appName - String

    • getContext

      public PAdESProfileParameters getContext()
      Overrides:
      getContext in class eu.europa.esig.dss.AbstractSignatureParameters<eu.europa.esig.dss.cades.signature.CAdESTimestampParameters>

    • getImageParameters

      public SignatureImageParameters getImageParameters()
      Description copied from interface: PAdESCommonParameters
      Returns SignatureImageParameters for field's visual representation
      Specified by:
      getImageParameters in interface PAdESCommonParameters
      Returns:
      SignatureImageParameters

    • setImageParameters

      public void setImageParameters(SignatureImageParameters signatureImageParameters)
      Sets the SignatureImageParameters for a visual signature creation
      Parameters:
      signatureImageParameters - SignatureImageParameters

    • getContentSize

      public int getContentSize()
      Description copied from interface: PAdESCommonParameters
      Returns a length of the reserved /Contents attribute
      Specified by:
      getContentSize in interface PAdESCommonParameters
      Returns:
      int content size

    • setContentSize

      public void setContentSize(int signatureSize)
      This setter defines an amount of bytes to be reserved for a CMS signature contents encapsulation Default : 9472 bytes
      Parameters:
      signatureSize - /Contents parameter reserved space

    • getPermission

      public eu.europa.esig.dss.enumerations.CertificationPermission getPermission()
      Gets the permission for the PDF document modification
      Returns:
      CertificationPermission

    • setPermission

      public void setPermission(eu.europa.esig.dss.enumerations.CertificationPermission permission)
      Sets the permission for the PDF document modification
      Parameters:
      permission - CertificationPermission

    • getPasswordProtection

      public char[] getPasswordProtection()
      Description copied from interface: PAdESCommonParameters
      Returns a password used to encrypt a document
      Specified by:
      getPasswordProtection in interface PAdESCommonParameters
      Returns:
      char array representing a password string

    • setPasswordProtection

      public void setPasswordProtection(char[] passwordProtection)
      Sets password to the document
      Parameters:
      passwordProtection - char array representing a password of the document

    • getSigningDate

      public Date getSigningDate()
      Description copied from interface: PAdESCommonParameters
      Returns a claimed signing time
      Specified by:
      getSigningDate in interface PAdESCommonParameters
      Returns:
      Date

    • setSigningTimeZone

      public void setSigningTimeZone(TimeZone signingTimeZone)
      Sets a TimeZone to use for signature creation. Will be used to define a signingTime within a PDF entry with key /M. Default: TimeZone.getDefault()
      Parameters:
      signingTimeZone - TimeZone

    • getSigningTimeZone

      public TimeZone getSigningTimeZone()
      Returns a time-zone used to define the signing time
      Returns:
      TimeZone

    • isIncludeVRIDictionary

      public boolean isIncludeVRIDictionary()
      Returns whether the VRI dictionary should be included to the PAdES Signature on extension within LT-level revision (DSS revision)
      Returns:
      whether the corresponding VRI dictionary should be included on signature extension

    • setIncludeVRIDictionary

      public void setIncludeVRIDictionary(boolean includeVRIDictionary)
      Sets whether corresponding VRI dictionary should be included to the PAdES signature on extension to LT-level Default: FALSE (VRI dictionary is not included to PAdES signature)
      Parameters:
      includeVRIDictionary - whether corresponding VRI dictionary should be included to the PAdES signature on extension

    • getContentTimestampParameters

      public PAdESTimestampParameters getContentTimestampParameters()
      Overrides:
      getContentTimestampParameters in class eu.europa.esig.dss.cades.CAdESSignatureParameters

    • setContentTimestampParameters

      public void setContentTimestampParameters(eu.europa.esig.dss.cades.signature.CAdESTimestampParameters contentTimestampParameters)
      Overrides:
      setContentTimestampParameters in class eu.europa.esig.dss.model.AbstractSerializableSignatureParameters<eu.europa.esig.dss.cades.signature.CAdESTimestampParameters>

    • getSignatureTimestampParameters

      public PAdESTimestampParameters getSignatureTimestampParameters()
      Overrides:
      getSignatureTimestampParameters in class eu.europa.esig.dss.cades.CAdESSignatureParameters

    • setSignatureTimestampParameters

      public void setSignatureTimestampParameters(eu.europa.esig.dss.cades.signature.CAdESTimestampParameters signatureTimestampParameters)
      Overrides:
      setSignatureTimestampParameters in class eu.europa.esig.dss.model.AbstractSerializableSignatureParameters<eu.europa.esig.dss.cades.signature.CAdESTimestampParameters>

    • getArchiveTimestampParameters

      public PAdESTimestampParameters getArchiveTimestampParameters()
      Overrides:
      getArchiveTimestampParameters in class eu.europa.esig.dss.cades.CAdESSignatureParameters

    • setArchiveTimestampParameters

      public void setArchiveTimestampParameters(eu.europa.esig.dss.cades.signature.CAdESTimestampParameters archiveTimestampParameters)
      Overrides:
      setArchiveTimestampParameters in class eu.europa.esig.dss.model.AbstractSerializableSignatureParameters<eu.europa.esig.dss.cades.signature.CAdESTimestampParameters>

    • getPdfSignatureCache

      public PdfSignatureCache getPdfSignatureCache()
      Description copied from interface: PAdESCommonParameters
      Returns an internal variable, used to cache data in order to accelerate signing process
      Specified by:
      getPdfSignatureCache in interface PAdESCommonParameters
      Returns:
      PdfSignatureCache