From 835256964f3fa64587a0e05b859d012d125be308 Mon Sep 17 00:00:00 2001 From: Andreas Fitzek Date: Thu, 20 Feb 2014 10:54:04 +0100 Subject: Documentation update --- .../api/xmldsig/ExtendedSignatureInformation.html | 276 ++++++++++ .../ReconstructXMLDsigAfterAnalysisParameters.html | 358 ++++++++++++ .../api/xmldsig/ReconstructXMLDsigParameters.html | 604 +++++++++++++++++++++ .../api/xmldsig/ReconstructXMLDsigResult.html | 281 ++++++++++ .../at/gv/egiz/pdfas/api/xmldsig/XMLDsigData.html | 313 +++++++++++ .../gv/egiz/pdfas/api/xmldsig/package-frame.html | 23 + .../gv/egiz/pdfas/api/xmldsig/package-summary.html | 158 ++++++ .../at/gv/egiz/pdfas/api/xmldsig/package-tree.html | 130 +++++ 8 files changed, 2143 insertions(+) create mode 100644 docs/full/at/gv/egiz/pdfas/api/xmldsig/ExtendedSignatureInformation.html create mode 100644 docs/full/at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigAfterAnalysisParameters.html create mode 100644 docs/full/at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigParameters.html create mode 100644 docs/full/at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigResult.html create mode 100644 docs/full/at/gv/egiz/pdfas/api/xmldsig/XMLDsigData.html create mode 100644 docs/full/at/gv/egiz/pdfas/api/xmldsig/package-frame.html create mode 100644 docs/full/at/gv/egiz/pdfas/api/xmldsig/package-summary.html create mode 100644 docs/full/at/gv/egiz/pdfas/api/xmldsig/package-tree.html (limited to 'docs/full/at/gv/egiz/pdfas/api/xmldsig') diff --git a/docs/full/at/gv/egiz/pdfas/api/xmldsig/ExtendedSignatureInformation.html b/docs/full/at/gv/egiz/pdfas/api/xmldsig/ExtendedSignatureInformation.html new file mode 100644 index 00000000..81e45380 --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/xmldsig/ExtendedSignatureInformation.html @@ -0,0 +1,276 @@ + + + + + +ExtendedSignatureInformation + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
at.gv.egiz.pdfas.api.xmldsig
+

Class ExtendedSignatureInformation

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

      Constructor Detail

      + + + +
        +
      • +

        ExtendedSignatureInformation

        +
        public ExtendedSignatureInformation(SignatureInformation siginfo,
+                            XMLDsigData dsigData)
        +
        Constructor.
        +
        Parameters:
        siginfo - The signature information
        dsigData - The matching xmldsig to the signature information.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSignatureInformation

        +
        public SignatureInformation getSignatureInformation()
        +
        Returns:
        the signatureInformation
        +
        • +
      + + + +
        +
      • +

        getXmlDsigData

        +
        public XMLDsigData getXmlDsigData()
        +
        Returns:
        the xmlDsigData
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/full/at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigAfterAnalysisParameters.html b/docs/full/at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigAfterAnalysisParameters.html new file mode 100644 index 00000000..f4ea6fea --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigAfterAnalysisParameters.html @@ -0,0 +1,358 @@ + + + + + +ReconstructXMLDsigAfterAnalysisParameters + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
at.gv.egiz.pdfas.api.xmldsig
+

Class ReconstructXMLDsigAfterAnalysisParameters

+
+
+ +
+
    +
  • +
    +
    +
    public class ReconstructXMLDsigAfterAnalysisParameters
+extends java.lang.Object
    +
    Parameters for the reconstructXMLDsig method which is to be called after a analyze call.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ReconstructXMLDsigAfterAnalysisParameters

        +
        public ReconstructXMLDsigAfterAnalysisParameters()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAnalyzeResult

        +
        public AnalyzeResult getAnalyzeResult()
        +
        Returns:
        the analyzeResult
        +
        • +
      + + + +
        +
      • +

        setAnalyzeResult

        +
        public void setAnalyzeResult(AnalyzeResult analyzeResult)
        +
        Parameters:
        analyzeResult - the analyzeResult to set
        +
        • +
      + + + +
        +
      • +

        getSignatureDevice

        +
        public java.lang.String getSignatureDevice()
        +
        Returns:
        the signatureDevice
        +
        • +
      + + + +
        +
      • +

        setSignatureDevice

        +
        public void setSignatureDevice(java.lang.String signatureDevice)
        +
        Parameters:
        signatureDevice - the signatureDevice to set
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/full/at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigParameters.html b/docs/full/at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigParameters.html new file mode 100644 index 00000000..9e4bc078 --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigParameters.html @@ -0,0 +1,604 @@ + + + + + +ReconstructXMLDsigParameters + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
at.gv.egiz.pdfas.api.xmldsig
+

Class ReconstructXMLDsigParameters

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

      Field Detail

      + + + +
        +
      • +

        document

        +
        protected DataSource document
        +
        The document to be verified.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        signatureToVerify

        +
        protected int signatureToVerify
        +
        The (zero based) index of the signature to verify. + +

        + This allows to verify only one found signature instead of all. Constants.VERIFY_ALL means to + verify all found signatures. +

        +
        • +
      + + + +
        +
      • +

        verificationTime

        +
        protected java.util.Date verificationTime
        +
        Allows to pass a VerificationTime to the verification device. + +

        + Note that the actual usage of this parameter depends on the verification device. +

        +
        • +
      + + + +
        +
      • +

        returnHashInputData

        +
        protected boolean returnHashInputData
        +
        Tells the signature device (e.g. MOA) to return the signature hash input + data (which is the probably transformed signed data). + +

        + Note that this forces MOA to return the potentially large signature data to + be returned in the result XML, which may result in very bad performance. +

        +
        • +
      + + + +
        +
      • +

        returnNonTextualObjects

        +
        protected boolean returnNonTextualObjects
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ReconstructXMLDsigParameters

        +
        public ReconstructXMLDsigParameters()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDocument

        +
        public DataSource getDocument()
        +
        Returns:
        the document
        +
        • +
      + + + +
        +
      • +

        setDocument

        +
        public void setDocument(DataSource document)
        +
        Parameters:
        document - the document to set
        +
        • +
      + + + +
        +
      • +

        getSignatureDevice

        +
        public java.lang.String getSignatureDevice()
        +
        Returns:
        the signatureDevice
        +
        • +
      + + + +
        +
      • +

        setSignatureDevice

        +
        public void setSignatureDevice(java.lang.String signatureDevice)
        +
        Parameters:
        signatureDevice - the signatureDevice to set
        +
        • +
      + + + +
        +
      • +

        getVerifyMode

        +
        public java.lang.String getVerifyMode()
        +
        Returns:
        the verifyMode
        +
        • +
      + + + +
        +
      • +

        setVerifyMode

        +
        public void setVerifyMode(java.lang.String verifyMode)
        +
        Parameters:
        verifyMode - the verifyMode to set
        +
        • +
      + + + +
        +
      • +

        getSignatureToVerify

        +
        public int getSignatureToVerify()
        +
        Returns:
        the signatureToVerify
        +
        • +
      + + + +
        +
      • +

        setSignatureToVerify

        +
        public void setSignatureToVerify(int signatureToVerify)
        +
        Parameters:
        signatureToVerify - the signatureToVerify to set
        +
        • +
      + + + +
        +
      • +

        getVerificationTime

        +
        public java.util.Date getVerificationTime()
        +
        Returns:
        the verificationTime
        +
        • +
      + + + +
        +
      • +

        setVerificationTime

        +
        public void setVerificationTime(java.util.Date verificationTime)
        +
        Parameters:
        verificationTime - the verificationTime to set
        +
        • +
      + + + +
        +
      • +

        isReturnHashInputData

        +
        public boolean isReturnHashInputData()
        +
        Returns:
        the returnHashInputData
        +
        • +
      + + + +
        +
      • +

        setReturnHashInputData

        +
        public void setReturnHashInputData(boolean returnHashInputData)
        +
        Parameters:
        returnHashInputData - the returnHashInputData to set
        +
        • +
      + + + +
        +
      • +

        isReturnNonTextualObjects

        +
        public boolean isReturnNonTextualObjects()
        +
        • +
      + + + +
        +
      • +

        setReturnNonTextualObjects

        +
        public void setReturnNonTextualObjects(boolean returnNonTextualObjects)
        +
        Tells if non text object of the signed pdf should be extracted and returned. + One should show this to the user, especially in case of textual signature. + Defaults to false
        +
        Parameters:
        returnNonTextualObjects -
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/full/at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigResult.html b/docs/full/at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigResult.html new file mode 100644 index 00000000..b10d6321 --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigResult.html @@ -0,0 +1,281 @@ + + + + + +ReconstructXMLDsigResult + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
at.gv.egiz.pdfas.api.xmldsig
+

Class ReconstructXMLDsigResult

+
+
+ +
+
    +
  • +
    +
    +
    public class ReconstructXMLDsigResult
+extends java.lang.Object
    +
    The result of a reconstructXMLDsig call.
    + This is just a wrapper for a list of ExtendedSignatureInformations
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ReconstructXMLDsigResult(java.util.List extendedSignatureInfos, + java.lang.String signatureDevice) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetDevice() +
      Get the signature device that was used to create this result.
      +
      java.util.ListgetExtendedSignatures() +
      Returns the list of found signatures.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ReconstructXMLDsigResult

        +
        public ReconstructXMLDsigResult(java.util.List extendedSignatureInfos,
+                        java.lang.String signatureDevice)
        +
        Parameters:
        extendedSignatureInfos -
        signatureDevice -
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/full/at/gv/egiz/pdfas/api/xmldsig/XMLDsigData.html b/docs/full/at/gv/egiz/pdfas/api/xmldsig/XMLDsigData.html new file mode 100644 index 00000000..b8b7b7ef --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/xmldsig/XMLDsigData.html @@ -0,0 +1,313 @@ + + + + + +XMLDsigData + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
at.gv.egiz.pdfas.api.xmldsig
+

Class XMLDsigData

+
+
+ +
+
    +
  • +
    +
    +
    public class XMLDsigData
+extends java.lang.Object
    +
    A container for XMLDsig data.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      XMLDsigData(java.lang.String xmldsig, + boolean detached) +
      Constructor.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetXmlDsig() +
      Get the xmldsig string
      +
      booleanisDetached() 
      voidsetDetached(boolean detached) +
      Set the detached.
      +
      voidsetXmlDsig(java.lang.String xmlDsig) +
      Set the xmldsig string.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        XMLDsigData

        +
        public XMLDsigData(java.lang.String xmldsig,
+           boolean detached)
        +
        Constructor.
        +
        Parameters:
        xmldsig - the xml string of the xmldsig.
        detached - true if detached, false otherwise
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getXmlDsig

        +
        public java.lang.String getXmlDsig()
        +
        Get the xmldsig string
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        setXmlDsig

        +
        public void setXmlDsig(java.lang.String xmlDsig)
        +
        Set the xmldsig string.
        +
        Parameters:
        xmlDsig -
        +
        • +
      + + + +
        +
      • +

        isDetached

        +
        public boolean isDetached()
        +
        Returns:
        true if detached, false otherwise
        +
        • +
      + + + +
        +
      • +

        setDetached

        +
        public void setDetached(boolean detached)
        +
        Set the detached.
        +
        Parameters:
        detached -
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/full/at/gv/egiz/pdfas/api/xmldsig/package-frame.html b/docs/full/at/gv/egiz/pdfas/api/xmldsig/package-frame.html new file mode 100644 index 00000000..d4100c4e --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/xmldsig/package-frame.html @@ -0,0 +1,23 @@ + + + + + +at.gv.egiz.pdfas.api.xmldsig + + + + +

at.gv.egiz.pdfas.api.xmldsig

+
+

Classes

+ +
+ + diff --git a/docs/full/at/gv/egiz/pdfas/api/xmldsig/package-summary.html b/docs/full/at/gv/egiz/pdfas/api/xmldsig/package-summary.html new file mode 100644 index 00000000..72ebb16d --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/xmldsig/package-summary.html @@ -0,0 +1,158 @@ + + + + + +at.gv.egiz.pdfas.api.xmldsig + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package at.gv.egiz.pdfas.api.xmldsig

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/full/at/gv/egiz/pdfas/api/xmldsig/package-tree.html b/docs/full/at/gv/egiz/pdfas/api/xmldsig/package-tree.html new file mode 100644 index 00000000..65c7eb6e --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/xmldsig/package-tree.html @@ -0,0 +1,130 @@ + + + + + +at.gv.egiz.pdfas.api.xmldsig Class Hierarchy + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package at.gv.egiz.pdfas.api.xmldsig

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + -- cgit v1.2.3