From fe8409ea3ebbb34058eeb5c2f0a6977b8a421686 Mon Sep 17 00:00:00 2001 From: Andreas Fitzek Date: Wed, 5 Feb 2014 10:19:00 +0100 Subject: Added API Documentation and Full Documentation --- docs/full/at/gv/egiz/pdfas/lib/api/PdfAs.html | 328 ++++++++++++++++++++++++++ 1 file changed, 328 insertions(+) create mode 100644 docs/full/at/gv/egiz/pdfas/lib/api/PdfAs.html (limited to 'docs/full/at/gv/egiz/pdfas/lib/api/PdfAs.html') diff --git a/docs/full/at/gv/egiz/pdfas/lib/api/PdfAs.html b/docs/full/at/gv/egiz/pdfas/lib/api/PdfAs.html new file mode 100644 index 00000000..684e2963 --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/lib/api/PdfAs.html @@ -0,0 +1,328 @@ + + + + + + +PdfAs (PDF-AS 4.0.0-SNAPSHOT Library) + + + + + + + +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [27fb69688a5de7e291ce5a2fd348becb1a722ad5]
+
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
at.gv.egiz.pdfas.lib.api
+

Interface PdfAs

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    PdfAsImpl
    +
    +
    +
    +
    public interface PdfAs
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sign

        +
        SignResult sign(SignParameter parameter)
+                throws at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        Signs a PDF document using PDF-AS.
        +
        Parameters:
        parameter -
        +
        Returns:
        +
        Throws:
        +
        at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        • +
      + + + +
        +
      • +

        verify

        +
        List<VerifyResult> verify(VerifyParameter parameter)
+                          throws at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        Verifies a document with (potentially multiple) PDF-AS signatures.
        +
        Parameters:
        parameter - The verification parameter
        +
        Returns:
        A list of verification Results
        +
        Throws:
        +
        at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        • +
      + + + +
        +
      • +

        getConfiguration

        +
        Configuration getConfiguration()
        +
        Gets a copy of the PDF-AS configuration, to allow the application to + override configuration parameters at runtime.
        +
        Returns:
        A private copy of the pdf as configuration
        +
        • +
      + + + +
        +
      • +

        startSign

        +
        StatusRequest startSign(SignParameter parameter)
+                        throws at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        Starts a signature process + + After the process has to be startet the status request has to be services by the user application
        +
        Parameters:
        parameter - The sign parameter
        +
        Returns:
        A status request
        +
        Throws:
        +
        at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        • +
      + + + +
        +
      • +

        process

        +
        StatusRequest process(StatusRequest statusRequest)
+                      throws at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        Continues an ongoing signature process
        +
        Parameters:
        statusRequest - The current status
        +
        Returns:
        A status request
        +
        Throws:
        +
        at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        • +
      + + + +
        +
      • +

        finishSign

        +
        SignResult finishSign(StatusRequest statusRequest)
+                      throws at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        Finishes a signature process
        +
        Parameters:
        statusRequest - The current status
        +
        Returns:
        A signature result
        +
        Throws:
        +
        at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [27fb69688a5de7e291ce5a2fd348becb1a722ad5]
+
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + -- cgit v1.2.3