<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_51) on Wed Feb 05 09:35:05 CET 2014 --> <meta http-equiv="Content-Type" content="text/html" charset="ISO-8859-1"> <title>PdfAs (PDF-AS 4.0.0-SNAPSHOT Library)</title> <meta name="date" content="2014-02-05"> <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="PdfAs (PDF-AS 4.0.0-SNAPSHOT Library)"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/PdfAs.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../../../index-all.html">Index</a></li> <li><a href="../../../../../../help-doc.html">Help</a></li> </ul> <div class="aboutLanguage"><em><b>PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [27fb69688a5de7e291ce5a2fd348becb1a722ad5]</b></em></div> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../../at/gv/egiz/pdfas/lib/api/IConfigurationConstants.html" title="interface in at.gv.egiz.pdfas.lib.api"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../../at/gv/egiz/pdfas/lib/api/PdfAsFactory.html" title="class in at.gv.egiz.pdfas.lib.api"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../../index.html?at/gv/egiz/pdfas/lib/api/PdfAs.html" target="_top">Frames</a></li> <li><a href="PdfAs.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">at.gv.egiz.pdfas.lib.api</div> <h2 title="Interface PdfAs" class="title">Interface PdfAs</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Known Implementing Classes:</dt> <dd><a href="../../../../../../at/gv/egiz/pdfas/lib/impl/PdfAsImpl.html" title="class in at.gv.egiz.pdfas.lib.impl">PdfAsImpl</a></dd> </dl> <hr> <br> <pre>public interface <span class="strong">PdfAs</span></pre> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../../at/gv/egiz/pdfas/lib/api/sign/SignResult.html" title="interface in at.gv.egiz.pdfas.lib.api.sign">SignResult</a></code></td> <td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/lib/api/PdfAs.html#finishSign(at.gv.egiz.pdfas.lib.api.StatusRequest)">finishSign</a></strong>(<a href="../../../../../../at/gv/egiz/pdfas/lib/api/StatusRequest.html" title="interface in at.gv.egiz.pdfas.lib.api">StatusRequest</a> statusRequest)</code> <div class="block">Finishes a signature process</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../../at/gv/egiz/pdfas/lib/api/Configuration.html" title="interface in at.gv.egiz.pdfas.lib.api">Configuration</a></code></td> <td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/lib/api/PdfAs.html#getConfiguration()">getConfiguration</a></strong>()</code> <div class="block">Gets a copy of the PDF-AS configuration, to allow the application to override configuration parameters at runtime.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../../at/gv/egiz/pdfas/lib/api/StatusRequest.html" title="interface in at.gv.egiz.pdfas.lib.api">StatusRequest</a></code></td> <td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/lib/api/PdfAs.html#process(at.gv.egiz.pdfas.lib.api.StatusRequest)">process</a></strong>(<a href="../../../../../../at/gv/egiz/pdfas/lib/api/StatusRequest.html" title="interface in at.gv.egiz.pdfas.lib.api">StatusRequest</a> statusRequest)</code> <div class="block">Continues an ongoing signature process</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../../at/gv/egiz/pdfas/lib/api/sign/SignResult.html" title="interface in at.gv.egiz.pdfas.lib.api.sign">SignResult</a></code></td> <td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/lib/api/PdfAs.html#sign(at.gv.egiz.pdfas.lib.api.sign.SignParameter)">sign</a></strong>(<a href="../../../../../../at/gv/egiz/pdfas/lib/api/sign/SignParameter.html" title="interface in at.gv.egiz.pdfas.lib.api.sign">SignParameter</a> parameter)</code> <div class="block">Signs a PDF document using PDF-AS.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../../at/gv/egiz/pdfas/lib/api/StatusRequest.html" title="interface in at.gv.egiz.pdfas.lib.api">StatusRequest</a></code></td> <td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/lib/api/PdfAs.html#startSign(at.gv.egiz.pdfas.lib.api.sign.SignParameter)">startSign</a></strong>(<a href="../../../../../../at/gv/egiz/pdfas/lib/api/sign/SignParameter.html" title="interface in at.gv.egiz.pdfas.lib.api.sign">SignParameter</a> parameter)</code> <div class="block">Starts a signature process After the process has to be startet the status request has to be services by the user application</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../at/gv/egiz/pdfas/lib/api/verify/VerifyResult.html" title="interface in at.gv.egiz.pdfas.lib.api.verify">VerifyResult</a>></code></td> <td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/lib/api/PdfAs.html#verify(at.gv.egiz.pdfas.lib.api.verify.VerifyParameter)">verify</a></strong>(<a href="../../../../../../at/gv/egiz/pdfas/lib/api/verify/VerifyParameter.html" title="interface in at.gv.egiz.pdfas.lib.api.verify">VerifyParameter</a> parameter)</code> <div class="block">Verifies a document with (potentially multiple) PDF-AS signatures.</div> </td> </tr> </table> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="sign(at.gv.egiz.pdfas.lib.api.sign.SignParameter)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sign</h4> <pre><a href="../../../../../../at/gv/egiz/pdfas/lib/api/sign/SignResult.html" title="interface in at.gv.egiz.pdfas.lib.api.sign">SignResult</a> sign(<a href="../../../../../../at/gv/egiz/pdfas/lib/api/sign/SignParameter.html" title="interface in at.gv.egiz.pdfas.lib.api.sign">SignParameter</a> parameter) throws at.gv.egiz.pdfas.common.exceptions.PdfAsException</pre> <div class="block">Signs a PDF document using PDF-AS.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>parameter</code> - </dd> <dt><span class="strong">Returns:</span></dt><dd></dd> <dt><span class="strong">Throws:</span></dt> <dd><code>at.gv.egiz.pdfas.common.exceptions.PdfAsException</code></dd></dl> </li> </ul> <a name="verify(at.gv.egiz.pdfas.lib.api.verify.VerifyParameter)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>verify</h4> <pre><a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../at/gv/egiz/pdfas/lib/api/verify/VerifyResult.html" title="interface in at.gv.egiz.pdfas.lib.api.verify">VerifyResult</a>> verify(<a href="../../../../../../at/gv/egiz/pdfas/lib/api/verify/VerifyParameter.html" title="interface in at.gv.egiz.pdfas.lib.api.verify">VerifyParameter</a> parameter) throws at.gv.egiz.pdfas.common.exceptions.PdfAsException</pre> <div class="block">Verifies a document with (potentially multiple) PDF-AS signatures.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>parameter</code> - The verification parameter</dd> <dt><span class="strong">Returns:</span></dt><dd>A list of verification Results</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>at.gv.egiz.pdfas.common.exceptions.PdfAsException</code></dd></dl> </li> </ul> <a name="getConfiguration()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getConfiguration</h4> <pre><a href="../../../../../../at/gv/egiz/pdfas/lib/api/Configuration.html" title="interface in at.gv.egiz.pdfas.lib.api">Configuration</a> getConfiguration()</pre> <div class="block">Gets a copy of the PDF-AS configuration, to allow the application to override configuration parameters at runtime.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>A private copy of the pdf as configuration</dd></dl> </li> </ul> <a name="startSign(at.gv.egiz.pdfas.lib.api.sign.SignParameter)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>startSign</h4> <pre><a href="../../../../../../at/gv/egiz/pdfas/lib/api/StatusRequest.html" title="interface in at.gv.egiz.pdfas.lib.api">StatusRequest</a> startSign(<a href="../../../../../../at/gv/egiz/pdfas/lib/api/sign/SignParameter.html" title="interface in at.gv.egiz.pdfas.lib.api.sign">SignParameter</a> parameter) throws at.gv.egiz.pdfas.common.exceptions.PdfAsException</pre> <div class="block">Starts a signature process After the process has to be startet the status request has to be services by the user application</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>parameter</code> - The sign parameter</dd> <dt><span class="strong">Returns:</span></dt><dd>A status request</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>at.gv.egiz.pdfas.common.exceptions.PdfAsException</code></dd></dl> </li> </ul> <a name="process(at.gv.egiz.pdfas.lib.api.StatusRequest)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>process</h4> <pre><a href="../../../../../../at/gv/egiz/pdfas/lib/api/StatusRequest.html" title="interface in at.gv.egiz.pdfas.lib.api">StatusRequest</a> process(<a href="../../../../../../at/gv/egiz/pdfas/lib/api/StatusRequest.html" title="interface in at.gv.egiz.pdfas.lib.api">StatusRequest</a> statusRequest) throws at.gv.egiz.pdfas.common.exceptions.PdfAsException</pre> <div class="block">Continues an ongoing signature process</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>statusRequest</code> - The current status</dd> <dt><span class="strong">Returns:</span></dt><dd>A status request</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>at.gv.egiz.pdfas.common.exceptions.PdfAsException</code></dd></dl> </li> </ul> <a name="finishSign(at.gv.egiz.pdfas.lib.api.StatusRequest)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>finishSign</h4> <pre><a href="../../../../../../at/gv/egiz/pdfas/lib/api/sign/SignResult.html" title="interface in at.gv.egiz.pdfas.lib.api.sign">SignResult</a> finishSign(<a href="../../../../../../at/gv/egiz/pdfas/lib/api/StatusRequest.html" title="interface in at.gv.egiz.pdfas.lib.api">StatusRequest</a> statusRequest) throws at.gv.egiz.pdfas.common.exceptions.PdfAsException</pre> <div class="block">Finishes a signature process</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>statusRequest</code> - The current status</dd> <dt><span class="strong">Returns:</span></dt><dd>A signature result</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>at.gv.egiz.pdfas.common.exceptions.PdfAsException</code></dd></dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> <!-- --> </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/PdfAs.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../../../index-all.html">Index</a></li> <li><a href="../../../../../../help-doc.html">Help</a></li> </ul> <div class="aboutLanguage"><em><b>PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [27fb69688a5de7e291ce5a2fd348becb1a722ad5]</b></em></div> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../../at/gv/egiz/pdfas/lib/api/IConfigurationConstants.html" title="interface in at.gv.egiz.pdfas.lib.api"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../../at/gv/egiz/pdfas/lib/api/PdfAsFactory.html" title="class in at.gv.egiz.pdfas.lib.api"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../../index.html?at/gv/egiz/pdfas/lib/api/PdfAs.html" target="_top">Frames</a></li> <li><a href="PdfAs.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </body> </html>