Package eu.europa.esig.dss.pdf

Interface PDFSignatureService

All Known Implementing Classes:
AbstractPDFSignatureService, ITextPDFSignatureService, PdfBoxSignatureService
public interface PDFSignatureService
The usage of this interface permits the user to choose the underlying PDF library used to create PDF signatures.

  • Method Details

    • digest

      byte[] digest​(DSSDocument toSignDocument, PAdESCommonParameters parameters)
      Returns the digest value of a PDF document
      Parameters:
      toSignDocument - the document to be signed
      parameters - the signature/timestamp parameters
      Returns:
      the digest value
      Throws:
      DSSException - if an error occurred

    • sign

      DSSDocument sign​(DSSDocument pdfData, byte[] signatureValue, PAdESCommonParameters parameters)
      Signs a PDF document
      Parameters:
      pdfData - the pdf document
      signatureValue - the signature value
      parameters - the signature/timestamp parameters
      Throws:
      DSSException - if an error occurred

    • getRevisions

      List<PdfRevision> getRevisions​(DSSDocument document, String pwd)
      Retrieves revisions from a PDF document
      Parameters:
      document - the document to extract revisions from
      pwd - the password protection phrase used to encrypt the PDF document use 'null' value for not an encrypted document
      Returns:
      list of extracted PdfRevisions

    • addDssDictionary

      DSSDocument addDssDictionary​(DSSDocument document, List<DSSDictionaryCallback> callbacks)
      This method adds the DSS dictionary (Baseline-LT)
      Parameters:
      document - the document to be extended
      callbacks - the callbacks to retrieve the revocation data,...
      Returns:
      the pdf document with the added dss dictionary
      Throws:
      DSSException - if an error occurred

    • addDssDictionary

      DSSDocument addDssDictionary​(DSSDocument document, List<DSSDictionaryCallback> callbacks, String pwd)
      This method adds the DSS dictionary (Baseline-LT)
      Parameters:
      document - the document to be extended
      callbacks - the callbacks to retrieve the revocation data,...
      pwd - the password protection used to create the encrypted document
      Returns:
      the pdf document with the added dss dictionary
      Throws:
      DSSException - if an error occurred

    • getAvailableSignatureFields

      List<String> getAvailableSignatureFields​(DSSDocument document)
      This method returns not signed signature-fields
      Parameters:
      document - the pdf document
      Returns:
      the list of empty signature fields

    • getAvailableSignatureFields

      List<String> getAvailableSignatureFields​(DSSDocument document, String pwd)
      Returns not-signed signature fields from an encrypted document
      Parameters:
      document - the pdf document
      pwd - the password protection phrase used to encrypt the document
      Returns:
      the list of not signed signature field names

    • addNewSignatureField

      DSSDocument addNewSignatureField​(DSSDocument document, SignatureFieldParameters parameters)
      This method allows to add a new signature field to an existing pdf document
      Parameters:
      document - the pdf document
      parameters - the parameters with the coordinates,... of the signature field
      Returns:
      the pdf document with the new added signature field

    • addNewSignatureField

      DSSDocument addNewSignatureField​(DSSDocument document, SignatureFieldParameters parameters, String pwd)
      This method allows to add a new signature field to an existing encrypted pdf document
      Parameters:
      document - the pdf document
      parameters - the parameters with the coordinates,... of the signature field
      pwd - the password protection used to create the encrypted document
      Returns:
      the pdf document with the new added signature field