Class SignedDocumentExtender

java.lang.Object
eu.europa.esig.dss.extension.SignedDocumentExtender
Direct Known Subclasses:
AbstractDocumentExtender
public abstract class SignedDocumentExtender extends Object
This class contains common code for signature augmentation utilities.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected eu.europa.esig.dss.spi.validation.CertificateVerifier
    certificateVerifier
    The reference to the certificate verifier.
    protected DocumentSignatureService<?,?>[]
    services
    (Optional) Document signature services.
    protected eu.europa.esig.dss.spi.x509.tsp.TSPSource
    tspSource
    The source to be used for a timestamp token request, when applicable.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    SignedDocumentExtender()
    Empty constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    eu.europa.esig.dss.model.DSSDocument
    extendDocument(eu.europa.esig.dss.enumerations.SignatureProfile arg0)
     
    eu.europa.esig.dss.model.DSSDocument
    extendDocument(eu.europa.esig.dss.enumerations.SignatureProfile arg0, eu.europa.esig.dss.model.SerializableSignatureParameters... arg1)
     
    eu.europa.esig.dss.model.DSSDocument
    extendDocument(eu.europa.esig.dss.enumerations.SignatureProfile arg0, List<eu.europa.esig.dss.model.DSSDocument> arg1)
     
    eu.europa.esig.dss.model.DSSDocument
    extendDocument(eu.europa.esig.dss.enumerations.SignatureProfile arg0, List<eu.europa.esig.dss.model.DSSDocument> arg1, eu.europa.esig.dss.model.SerializableSignatureParameters... arg2)
     
    static SignedDocumentExtender
    fromDocument(eu.europa.esig.dss.model.DSSDocument dssDocument)
    This method guesses the document format and returns an appropriate document reader.
    abstract eu.europa.esig.dss.enumerations.SignatureForm
    getSignatureForm()
    Gets the signature form for the current implementation
    boolean
    isASiC()
    Gets whether the document to be extended represents an ASiC container
    boolean
    isSupported(eu.europa.esig.dss.model.DSSDocument arg0)
     
    void
    setCertificateVerifier(eu.europa.esig.dss.spi.validation.CertificateVerifier certificateVerifier)
     
    void
    setServices(DocumentSignatureService<?,?>... services)
    (Optional) Sets document signature services.
    void
    setTspSource(eu.europa.esig.dss.spi.x509.tsp.TSPSource tspSource)
     

    Methods inherited from class Object

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

  • Field Details

    • certificateVerifier

      protected eu.europa.esig.dss.spi.validation.CertificateVerifier certificateVerifier
      The reference to the certificate verifier. The current DSS implementation proposes CommonCertificateVerifier. This verifier encapsulates the references to different sources used in the signature validation process.

    • tspSource

      protected eu.europa.esig.dss.spi.x509.tsp.TSPSource tspSource
      The source to be used for a timestamp token request, when applicable.

    • services

      protected DocumentSignatureService<?,?>[] services
      (Optional) Document signature services. When defined, the applicable instance of a corresponding service will be used. If no suitable service found, a new service instance will be created.

  • Constructor Details

    • SignedDocumentExtender

      protected SignedDocumentExtender()
      Empty constructor

  • Method Details

    • fromDocument

      public static SignedDocumentExtender fromDocument(eu.europa.esig.dss.model.DSSDocument dssDocument)
      This method guesses the document format and returns an appropriate document reader.
      Parameters:
      dssDocument - The instance of DSSDocument to validate
      Returns:
      returns the specific instance of DocumentReader in terms of the document type

    • setCertificateVerifier

      public void setCertificateVerifier(eu.europa.esig.dss.spi.validation.CertificateVerifier certificateVerifier)

    • setTspSource

      public void setTspSource(eu.europa.esig.dss.spi.x509.tsp.TSPSource tspSource)

    • setServices

      public void setServices(DocumentSignatureService<?,?>... services)
      (Optional) Sets document signature services. When defined, the applicable instance of a corresponding service will be used. If no suitable service found, a new service instance will be created.
      Parameters:
      services - an array of DocumentSignatureServices

    • getSignatureForm

      public abstract eu.europa.esig.dss.enumerations.SignatureForm getSignatureForm()
      Gets the signature form for the current implementation
      Returns:
      SignatureForm

    • isASiC

      public boolean isASiC()
      Gets whether the document to be extended represents an ASiC container
      Returns:
      TRUE if the document is an ASiC container, FALSE otherwise

    • isSupported

      boolean isSupported(eu.europa.esig.dss.model.DSSDocument arg0)

    • extendDocument

      eu.europa.esig.dss.model.DSSDocument extendDocument(eu.europa.esig.dss.enumerations.SignatureProfile arg0)

    • extendDocument

      eu.europa.esig.dss.model.DSSDocument extendDocument(eu.europa.esig.dss.enumerations.SignatureProfile arg0, List<eu.europa.esig.dss.model.DSSDocument> arg1)

    • extendDocument

      eu.europa.esig.dss.model.DSSDocument extendDocument(eu.europa.esig.dss.enumerations.SignatureProfile arg0, eu.europa.esig.dss.model.SerializableSignatureParameters... arg1)

    • extendDocument

      eu.europa.esig.dss.model.DSSDocument extendDocument(eu.europa.esig.dss.enumerations.SignatureProfile arg0, List<eu.europa.esig.dss.model.DSSDocument> arg1, eu.europa.esig.dss.model.SerializableSignatureParameters... arg2)