From 87c9269152f8c631123525b796cf07dc0cca7398 Mon Sep 17 00:00:00 2001 From: Andreas Fitzek Date: Wed, 5 Feb 2014 09:20:54 +0100 Subject: Documentation + Documentation building --- .../gv/egiz/pdfas/lib/api/sign/IPlainSigner.html | 277 +++++++++++++++++ .../gv/egiz/pdfas/lib/api/sign/SignParameter.html | 344 +++++++++++++++++++++ docs/at/gv/egiz/pdfas/lib/api/sign/SignResult.html | 257 +++++++++++++++ .../pdfas/lib/api/sign/class-use/IPlainSigner.html | 175 +++++++++++ .../lib/api/sign/class-use/SignParameter.html | 184 +++++++++++ .../pdfas/lib/api/sign/class-use/SignResult.html | 166 ++++++++++ .../gv/egiz/pdfas/lib/api/sign/package-frame.html | 22 ++ .../egiz/pdfas/lib/api/sign/package-summary.html | 148 +++++++++ .../gv/egiz/pdfas/lib/api/sign/package-tree.html | 133 ++++++++ .../at/gv/egiz/pdfas/lib/api/sign/package-use.html | 177 +++++++++++ 10 files changed, 1883 insertions(+) create mode 100644 docs/at/gv/egiz/pdfas/lib/api/sign/IPlainSigner.html create mode 100644 docs/at/gv/egiz/pdfas/lib/api/sign/SignParameter.html create mode 100644 docs/at/gv/egiz/pdfas/lib/api/sign/SignResult.html create mode 100644 docs/at/gv/egiz/pdfas/lib/api/sign/class-use/IPlainSigner.html create mode 100644 docs/at/gv/egiz/pdfas/lib/api/sign/class-use/SignParameter.html create mode 100644 docs/at/gv/egiz/pdfas/lib/api/sign/class-use/SignResult.html create mode 100644 docs/at/gv/egiz/pdfas/lib/api/sign/package-frame.html create mode 100644 docs/at/gv/egiz/pdfas/lib/api/sign/package-summary.html create mode 100644 docs/at/gv/egiz/pdfas/lib/api/sign/package-tree.html create mode 100644 docs/at/gv/egiz/pdfas/lib/api/sign/package-use.html (limited to 'docs/at/gv/egiz/pdfas/lib/api/sign') diff --git a/docs/at/gv/egiz/pdfas/lib/api/sign/IPlainSigner.html b/docs/at/gv/egiz/pdfas/lib/api/sign/IPlainSigner.html new file mode 100644 index 00000000..b1177a0c --- /dev/null +++ b/docs/at/gv/egiz/pdfas/lib/api/sign/IPlainSigner.html @@ -0,0 +1,277 @@ + + + + + + +IPlainSigner (PDF-AS 4.0.0-SNAPSHOT Library) + + + + + + + +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
at.gv.egiz.pdfas.lib.api.sign
+

Interface IPlainSigner

+
+
+
+
    +
  • +
    +
    +
    public interface IPlainSigner
    +
    Signer interface + + PDF-AS uses an IPlainSigner instance to create the signature. Also custom IPlainSigner + may be used to sign PDF-AS documents.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      iaik.x509.X509CertificategetCertificate() +
      Gets the signing certificate
      +
      StringgetPDFFilter() +
      Gets the PDF Filter for this signer
      +
      StringgetPDFSubFilter() +
      Gets the PDF Subfilter for this signer
      +
      byte[]sign(byte[] input, + int[] byteRange) +
      Sign the document
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCertificate

        +
        iaik.x509.X509Certificate getCertificate()
+                                         throws at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        Gets the signing certificate
        +
        Returns:
        +
        Throws:
        +
        at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        • +
      + + + +
        +
      • +

        sign

        +
        byte[] sign(byte[] input,
+          int[] byteRange)
+            throws at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        Sign the document
        +
        Parameters:
        input -
        byteRange -
        +
        Returns:
        +
        Throws:
        +
        at.gv.egiz.pdfas.common.exceptions.PdfAsException
        +
        • +
      + + + +
        +
      • +

        getPDFSubFilter

        +
        String getPDFSubFilter()
        +
        Gets the PDF Subfilter for this signer
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        getPDFFilter

        +
        String getPDFFilter()
        +
        Gets the PDF Filter for this signer
        +
        Returns:
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/at/gv/egiz/pdfas/lib/api/sign/SignParameter.html b/docs/at/gv/egiz/pdfas/lib/api/sign/SignParameter.html new file mode 100644 index 00000000..0596382c --- /dev/null +++ b/docs/at/gv/egiz/pdfas/lib/api/sign/SignParameter.html @@ -0,0 +1,344 @@ + + + + + + +SignParameter (PDF-AS 4.0.0-SNAPSHOT Library) + + + + + + + +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
at.gv.egiz.pdfas.lib.api.sign
+

Interface SignParameter

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSignatureProfileId

        +
        String getSignatureProfileId()
        +
        Gets the signature profile to use
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        setSignatureProfileId

        +
        void setSignatureProfileId(String signatureProfileId)
        +
        Sets the signature profile to use
        +
        Parameters:
        signatureProfileId - The signature profile
        +
        • +
      + + + +
        +
      • +

        getSignaturePosition

        +
        String getSignaturePosition()
        +
        Gets the signature position
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        setSignaturePosition

        +
        void setSignaturePosition(String signaturePosition)
        +
        Sets the signature position
        +
        Parameters:
        signaturePosition - The signature position string
        +
        • +
      + + + +
        +
      • +

        setOutput

        +
        void setOutput(DataSink output)
        +
        Sets the data sink for the signature process
        +
        Parameters:
        output -
        +
        • +
      + + + +
        +
      • +

        getOutput

        +
        DataSink getOutput()
        +
        Gets the data sink for the signature process
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        setPlainSigner

        +
        void setPlainSigner(IPlainSigner signer)
        +
        Sets the signer to use
        +
        Parameters:
        signer -
        +
        • +
      + + + +
        +
      • +

        getPlainSigner

        +
        IPlainSigner getPlainSigner()
        +
        Gets the signer to use.
        +
        Returns:
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/at/gv/egiz/pdfas/lib/api/sign/SignResult.html b/docs/at/gv/egiz/pdfas/lib/api/sign/SignResult.html new file mode 100644 index 00000000..f559cc50 --- /dev/null +++ b/docs/at/gv/egiz/pdfas/lib/api/sign/SignResult.html @@ -0,0 +1,257 @@ + + + + + + +SignResult (PDF-AS 4.0.0-SNAPSHOT Library) + + + + + + + +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
at.gv.egiz.pdfas.lib.api.sign
+

Interface SignResult

+
+
+
+
    +
  • +
    +
    +
    public interface SignResult
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getOutputDocument

        +
        DataSink getOutputDocument()
        +
        Returns the filled output data sink.
        +
        Returns:
        Returns the filled output data sink.
        +
        • +
      + + + +
        +
      • +

        getSignerCertificate

        +
        X509Certificate getSignerCertificate()
        +
        Returns the certificate of the signer.
        +
        Returns:
        Returns the certificate of the signer.
        +
        • +
      + + + +
        +
      • +

        getSignaturePosition

        +
        SignaturePosition getSignaturePosition()
        +
        Returns the position where the signature is finally placed. + +

        + This information can be useful for post-processing the document. +

        + +

        + Consult the PDF-AS documentation section Commandline for further + information about positioning. +

        +
        Returns:
        Returns the position where the signature is finally placed. May + return null if no position information is available.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/at/gv/egiz/pdfas/lib/api/sign/class-use/IPlainSigner.html b/docs/at/gv/egiz/pdfas/lib/api/sign/class-use/IPlainSigner.html new file mode 100644 index 00000000..8442e870 --- /dev/null +++ b/docs/at/gv/egiz/pdfas/lib/api/sign/class-use/IPlainSigner.html @@ -0,0 +1,175 @@ + + + + + + +Uses of Interface at.gv.egiz.pdfas.lib.api.sign.IPlainSigner (PDF-AS 4.0.0-SNAPSHOT Library) + + + + + + + +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
at.gv.egiz.pdfas.lib.api.sign.IPlainSigner

+
+
+ +
+ +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/at/gv/egiz/pdfas/lib/api/sign/class-use/SignParameter.html b/docs/at/gv/egiz/pdfas/lib/api/sign/class-use/SignParameter.html new file mode 100644 index 00000000..cc393c36 --- /dev/null +++ b/docs/at/gv/egiz/pdfas/lib/api/sign/class-use/SignParameter.html @@ -0,0 +1,184 @@ + + + + + + +Uses of Interface at.gv.egiz.pdfas.lib.api.sign.SignParameter (PDF-AS 4.0.0-SNAPSHOT Library) + + + + + + + +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
at.gv.egiz.pdfas.lib.api.sign.SignParameter

+
+
+ +
+ +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/at/gv/egiz/pdfas/lib/api/sign/class-use/SignResult.html b/docs/at/gv/egiz/pdfas/lib/api/sign/class-use/SignResult.html new file mode 100644 index 00000000..241b4b6b --- /dev/null +++ b/docs/at/gv/egiz/pdfas/lib/api/sign/class-use/SignResult.html @@ -0,0 +1,166 @@ + + + + + + +Uses of Interface at.gv.egiz.pdfas.lib.api.sign.SignResult (PDF-AS 4.0.0-SNAPSHOT Library) + + + + + + + +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
at.gv.egiz.pdfas.lib.api.sign.SignResult

+
+
+ +
+ +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/at/gv/egiz/pdfas/lib/api/sign/package-frame.html b/docs/at/gv/egiz/pdfas/lib/api/sign/package-frame.html new file mode 100644 index 00000000..f07a205a --- /dev/null +++ b/docs/at/gv/egiz/pdfas/lib/api/sign/package-frame.html @@ -0,0 +1,22 @@ + + + + + + +at.gv.egiz.pdfas.lib.api.sign (PDF-AS 4.0.0-SNAPSHOT Library) + + + + +

at.gv.egiz.pdfas.lib.api.sign

+
+

Interfaces

+ +
+ + diff --git a/docs/at/gv/egiz/pdfas/lib/api/sign/package-summary.html b/docs/at/gv/egiz/pdfas/lib/api/sign/package-summary.html new file mode 100644 index 00000000..3757821f --- /dev/null +++ b/docs/at/gv/egiz/pdfas/lib/api/sign/package-summary.html @@ -0,0 +1,148 @@ + + + + + + +at.gv.egiz.pdfas.lib.api.sign (PDF-AS 4.0.0-SNAPSHOT Library) + + + + + + + +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+ + +
+ +
+

Package at.gv.egiz.pdfas.lib.api.sign

+
+
+ +
+ +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/at/gv/egiz/pdfas/lib/api/sign/package-tree.html b/docs/at/gv/egiz/pdfas/lib/api/sign/package-tree.html new file mode 100644 index 00000000..4e393659 --- /dev/null +++ b/docs/at/gv/egiz/pdfas/lib/api/sign/package-tree.html @@ -0,0 +1,133 @@ + + + + + + +at.gv.egiz.pdfas.lib.api.sign Class Hierarchy (PDF-AS 4.0.0-SNAPSHOT Library) + + + + + + + +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package at.gv.egiz.pdfas.lib.api.sign

+Package Hierarchies: + +
+
+

Interface Hierarchy

+ +
+ +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/at/gv/egiz/pdfas/lib/api/sign/package-use.html b/docs/at/gv/egiz/pdfas/lib/api/sign/package-use.html new file mode 100644 index 00000000..71724620 --- /dev/null +++ b/docs/at/gv/egiz/pdfas/lib/api/sign/package-use.html @@ -0,0 +1,177 @@ + + + + + + +Uses of Package at.gv.egiz.pdfas.lib.api.sign (PDF-AS 4.0.0-SNAPSHOT Library) + + + + + + + +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
at.gv.egiz.pdfas.lib.api.sign

+
+
+ +
+ +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+
+ + + +
+ +
+ + +
+ + + -- cgit v1.2.3