diff options
| author | Andreas Fitzek <andreas.fitzek@iaik.tugraz.at> | 2014-02-20 10:54:04 +0100 |
|---|---|---|
| committer | Andreas Fitzek <andreas.fitzek@iaik.tugraz.at> | 2014-02-20 12:05:25 +0100 |
| commit | 835256964f3fa64587a0e05b859d012d125be308 (patch) | |
| tree | 21f68d684caf4a8e8afe2321f40e001202ba7f3e /docs/full/at/gv/egiz/pdfas/wrapper/PdfAsObject.html | |
| parent | e2fb88b773931ed3fbb1fee22c3a53a2ebd3b1fd (diff) | |
| download | pdf-as-4-835256964f3fa64587a0e05b859d012d125be308.tar.gz pdf-as-4-835256964f3fa64587a0e05b859d012d125be308.tar.bz2 pdf-as-4-835256964f3fa64587a0e05b859d012d125be308.zip | |
Documentation update
Diffstat (limited to 'docs/full/at/gv/egiz/pdfas/wrapper/PdfAsObject.html')
| -rw-r--r-- | docs/full/at/gv/egiz/pdfas/wrapper/PdfAsObject.html | 701 |
1 files changed, 701 insertions, 0 deletions
diff --git a/docs/full/at/gv/egiz/pdfas/wrapper/PdfAsObject.html b/docs/full/at/gv/egiz/pdfas/wrapper/PdfAsObject.html new file mode 100644 index 00000000..26034df3 --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/wrapper/PdfAsObject.html @@ -0,0 +1,701 @@ +<!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 Thu Feb 20 10:19:19 CET 2014 --> +<title>PdfAsObject</title> +<meta name="date" content="2014-02-20"> +<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="PdfAsObject"; + } +//--> +</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="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> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../at/gv/egiz/pdfas/wrapper/LegacyMainTest.html" title="class in at.gv.egiz.pdfas.wrapper"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../at/gv/egiz/pdfas/wrapper/SignatureCheckWrapper.html" title="class in at.gv.egiz.pdfas.wrapper"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?at/gv/egiz/pdfas/wrapper/PdfAsObject.html" target="_top">Frames</a></li> +<li><a href="PdfAsObject.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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.wrapper</div> +<h2 title="Class PdfAsObject" class="title">Class PdfAsObject</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>at.gv.egiz.pdfas.wrapper.PdfAsObject</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">PdfAsObject</span> +extends java.lang.Object +implements <a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#PdfAsObject(java.io.File)">PdfAsObject</a></strong>(java.io.File workdirectory)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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/api/analyze/AnalyzeResult.html" title="interface in at.gv.egiz.pdfas.api.analyze">AnalyzeResult</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#analyze(at.gv.egiz.pdfas.api.analyze.AnalyzeParameters)">analyze</a></strong>(<a href="../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html" title="class in at.gv.egiz.pdfas.api.analyze">AnalyzeParameters</a> analyzeParameters)</code> +<div class="block">Analyzes a document for signatures and returns a verify-able list of such.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons">DynamicSignatureProfile</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#createDynamicSignatureProfile(java.lang.String, at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)">createDynamicSignatureProfile</a></strong>(java.lang.String parentProfile, + <a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureLifetimeEnum.html" title="class in at.gv.egiz.pdfas.api.commons">DynamicSignatureLifetimeEnum</a> mode)</code> +<div class="block">Create a signature profile dynamically.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons">DynamicSignatureProfile</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#createDynamicSignatureProfile(java.lang.String, java.lang.String, at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)">createDynamicSignatureProfile</a></strong>(java.lang.String myUniqueName, + java.lang.String parentProfile, + <a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureLifetimeEnum.html" title="class in at.gv.egiz.pdfas.api.commons">DynamicSignatureLifetimeEnum</a> mode)</code> +<div class="block">Create a signature profile dynamically.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons">DynamicSignatureProfile</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#createEmptyDynamicSignatureProfile(at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)">createEmptyDynamicSignatureProfile</a></strong>(<a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureLifetimeEnum.html" title="class in at.gv.egiz.pdfas.api.commons">DynamicSignatureLifetimeEnum</a> mode)</code> +<div class="block">Create a signature profile dynamically.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons">DynamicSignatureProfile</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#createEmptyDynamicSignatureProfile(java.lang.String, at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)">createEmptyDynamicSignatureProfile</a></strong>(java.lang.String myUniqueName, + <a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureLifetimeEnum.html" title="class in at.gv.egiz.pdfas.api.commons">DynamicSignatureLifetimeEnum</a> mode)</code> +<div class="block">Create a signature profile dynamically.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../at/gv/egiz/pdfas/api/sign/SignResult.html" title="interface in at.gv.egiz.pdfas.api.sign">SignResult</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#finishSign(at.gv.egiz.pdfas.api.sign.SignParameters, at.gv.egiz.pdfas.api.sign.SignatureDetailInformation)">finishSign</a></strong>(<a href="../../../../../at/gv/egiz/pdfas/api/sign/SignParameters.html" title="class in at.gv.egiz.pdfas.api.sign">SignParameters</a> signParameters, + <a href="../../../../../at/gv/egiz/pdfas/api/sign/SignatureDetailInformation.html" title="interface in at.gv.egiz.pdfas.api.sign">SignatureDetailInformation</a> signatureDetailInformation)</code> +<div class="block">Finish the signature process.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List</code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#getProfileInformation()">getProfileInformation</a></strong>()</code> +<div class="block">Returns the list of information objects about activated profiles available in the + configuration.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons">DynamicSignatureProfile</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#loadDynamicSignatureProfile(java.lang.String)">loadDynamicSignatureProfile</a></strong>(java.lang.String profileName)</code> +<div class="block">Loads an existing dynamic signature profile by its name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../at/gv/egiz/pdfas/api/sign/SignatureDetailInformation.html" title="interface in at.gv.egiz.pdfas.api.sign">SignatureDetailInformation</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#prepareSign(at.gv.egiz.pdfas.api.sign.SignParameters)">prepareSign</a></strong>(<a href="../../../../../at/gv/egiz/pdfas/api/sign/SignParameters.html" title="class in at.gv.egiz.pdfas.api.sign">SignParameters</a> signParameters)</code> +<div class="block">Prepares the signature of the given PDF document.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigResult.html" title="class in at.gv.egiz.pdfas.api.xmldsig">ReconstructXMLDsigResult</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#reconstructXMLDSIG(at.gv.egiz.pdfas.api.xmldsig.ReconstructXMLDsigAfterAnalysisParameters)">reconstructXMLDSIG</a></strong>(<a href="../../../../../at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigAfterAnalysisParameters.html" title="class in at.gv.egiz.pdfas.api.xmldsig">ReconstructXMLDsigAfterAnalysisParameters</a> reconstructXMLDsigParameters)</code> +<div class="block">Reconstruct the <xmldsig:Signature> from the given parameters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigResult.html" title="class in at.gv.egiz.pdfas.api.xmldsig">ReconstructXMLDsigResult</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#reconstructXMLDSIG(at.gv.egiz.pdfas.api.xmldsig.ReconstructXMLDsigParameters)">reconstructXMLDSIG</a></strong>(<a href="../../../../../at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigParameters.html" title="class in at.gv.egiz.pdfas.api.xmldsig">ReconstructXMLDsigParameters</a> reconstructXMLDsigParameters)</code> +<div class="block">Reconstruct the <xmldsig:Signature> from the given parameters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#reloadConfig()">reloadConfig</a></strong>()</code> +<div class="block">Reloads the configuration from the work directory.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../at/gv/egiz/pdfas/api/sign/SignResult.html" title="interface in at.gv.egiz.pdfas.api.sign">SignResult</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#sign(at.gv.egiz.pdfas.api.sign.SignParameters)">sign</a></strong>(<a href="../../../../../at/gv/egiz/pdfas/api/sign/SignParameters.html" title="class in at.gv.egiz.pdfas.api.sign">SignParameters</a> signParameters)</code> +<div class="block">Signs a PDF document using PDF-AS.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../at/gv/egiz/pdfas/api/sign/SignResult.html" title="interface in at.gv.egiz.pdfas.api.sign">SignResult</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#sign(at.gv.egiz.pdfas.api.sign.SignParameters, at.gv.egiz.pdfas.api.sign.SignatureDetailInformation)">sign</a></strong>(<a href="../../../../../at/gv/egiz/pdfas/api/sign/SignParameters.html" title="class in at.gv.egiz.pdfas.api.sign">SignParameters</a> signParameters, + <a href="../../../../../at/gv/egiz/pdfas/api/sign/SignatureDetailInformation.html" title="interface in at.gv.egiz.pdfas.api.sign">SignatureDetailInformation</a> signatureDetailInformation)</code> +<div class="block">Signs a PDF document using PDF-AS.<br/> + This uses the <code>SignatorInformation</code> which was obtained by a call to <a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#prepareSign(at.gv.egiz.pdfas.api.sign.SignParameters)"><code>PdfAs.prepareSign(SignParameters)</code></a></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyResults.html" title="interface in at.gv.egiz.pdfas.api.verify">VerifyResults</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#verify(at.gv.egiz.pdfas.api.verify.VerifyAfterAnalysisParameters)">verify</a></strong>(<a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyAfterAnalysisParameters.html" title="class in at.gv.egiz.pdfas.api.verify">VerifyAfterAnalysisParameters</a> verifyAfterAnalysisParameters)</code> +<div class="block">Verifies a list of signatures that have been analyzed previously.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyResults.html" title="interface in at.gv.egiz.pdfas.api.verify">VerifyResults</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#verify(at.gv.egiz.pdfas.api.verify.VerifyAfterReconstructXMLDsigParameters)">verify</a></strong>(<a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyAfterReconstructXMLDsigParameters.html" title="class in at.gv.egiz.pdfas.api.verify">VerifyAfterReconstructXMLDsigParameters</a> verifyAfterReconstructXMLDsigParameters)</code> +<div class="block">Verifies a list of signatures that have been analyzed previously and the xmldsigs have been reconstructed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyResults.html" title="interface in at.gv.egiz.pdfas.api.verify">VerifyResults</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/PdfAsObject.html#verify(at.gv.egiz.pdfas.api.verify.VerifyParameters)">verify</a></strong>(<a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyParameters.html" title="class in at.gv.egiz.pdfas.api.verify">VerifyParameters</a> verifyParameters)</code> +<div class="block">Verifies a document with (potentially multiple) PDF-AS signatures.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="PdfAsObject(java.io.File)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PdfAsObject</h4> +<pre>public PdfAsObject(java.io.File workdirectory)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="sign(at.gv.egiz.pdfas.api.sign.SignParameters)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sign</h4> +<pre>public <a href="../../../../../at/gv/egiz/pdfas/api/sign/SignResult.html" title="interface in at.gv.egiz.pdfas.api.sign">SignResult</a> sign(<a href="../../../../../at/gv/egiz/pdfas/api/sign/SignParameters.html" title="class in at.gv.egiz.pdfas.api.sign">SignParameters</a> signParameters) + throws <a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#sign(at.gv.egiz.pdfas.api.sign.SignParameters)">PdfAs</a></code></strong></div> +<div class="block">Signs a PDF document using PDF-AS.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#sign(at.gv.egiz.pdfas.api.sign.SignParameters)">sign</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>signParameters</code> - The sign parameters.</dd> +<dt><span class="strong">Returns:</span></dt><dd>Returns the signed document plus additional information.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></code> - Thrown, if an error occurs.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../at/gv/egiz/pdfas/api/sign/SignParameters.html" title="class in at.gv.egiz.pdfas.api.sign"><code>SignParameters</code></a>, +<a href="../../../../../at/gv/egiz/pdfas/api/sign/SignResult.html" title="interface in at.gv.egiz.pdfas.api.sign"><code>SignResult</code></a></dd></dl> +</li> +</ul> +<a name="sign(at.gv.egiz.pdfas.api.sign.SignParameters, at.gv.egiz.pdfas.api.sign.SignatureDetailInformation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sign</h4> +<pre>public <a href="../../../../../at/gv/egiz/pdfas/api/sign/SignResult.html" title="interface in at.gv.egiz.pdfas.api.sign">SignResult</a> sign(<a href="../../../../../at/gv/egiz/pdfas/api/sign/SignParameters.html" title="class in at.gv.egiz.pdfas.api.sign">SignParameters</a> signParameters, + <a href="../../../../../at/gv/egiz/pdfas/api/sign/SignatureDetailInformation.html" title="interface in at.gv.egiz.pdfas.api.sign">SignatureDetailInformation</a> signatureDetailInformation) + throws <a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#sign(at.gv.egiz.pdfas.api.sign.SignParameters, at.gv.egiz.pdfas.api.sign.SignatureDetailInformation)">PdfAs</a></code></strong></div> +<div class="block">Signs a PDF document using PDF-AS.<br/> + This uses the <code>SignatorInformation</code> which was obtained by a call to <a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#prepareSign(at.gv.egiz.pdfas.api.sign.SignParameters)"><code>PdfAs.prepareSign(SignParameters)</code></a></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#sign(at.gv.egiz.pdfas.api.sign.SignParameters, at.gv.egiz.pdfas.api.sign.SignatureDetailInformation)">sign</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>signParameters</code> - The sign parameters.</dd><dd><code>signatureDetailInformation</code> - The signature information which was previously obtained by a call to <a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#prepareSign(at.gv.egiz.pdfas.api.sign.SignParameters)"><code>PdfAs.prepareSign(SignParameters)</code></a></dd> +<dt><span class="strong">Returns:</span></dt><dd>Returns the signed document plus additional information.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></code> - Thrown, if an error occurs.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../at/gv/egiz/pdfas/api/sign/SignParameters.html" title="class in at.gv.egiz.pdfas.api.sign"><code>SignParameters</code></a>, +<a href="../../../../../at/gv/egiz/pdfas/api/sign/SignResult.html" title="interface in at.gv.egiz.pdfas.api.sign"><code>SignResult</code></a></dd></dl> +</li> +</ul> +<a name="verify(at.gv.egiz.pdfas.api.verify.VerifyParameters)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>verify</h4> +<pre>public <a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyResults.html" title="interface in at.gv.egiz.pdfas.api.verify">VerifyResults</a> verify(<a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyParameters.html" title="class in at.gv.egiz.pdfas.api.verify">VerifyParameters</a> verifyParameters) + throws <a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#verify(at.gv.egiz.pdfas.api.verify.VerifyParameters)">PdfAs</a></code></strong></div> +<div class="block">Verifies a document with (potentially multiple) PDF-AS signatures.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#verify(at.gv.egiz.pdfas.api.verify.VerifyParameters)">verify</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>verifyParameters</code> - The verify parameters.</dd> +<dt><span class="strong">Returns:</span></dt><dd>Returns the verification results.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></code> - Thrown, if an error occurs.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyParameters.html" title="class in at.gv.egiz.pdfas.api.verify"><code>VerifyParameters</code></a>, +<a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyResults.html" title="interface in at.gv.egiz.pdfas.api.verify"><code>VerifyResults</code></a>, +<a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyResult.html" title="interface in at.gv.egiz.pdfas.api.verify"><code>VerifyResult</code></a></dd></dl> +</li> +</ul> +<a name="analyze(at.gv.egiz.pdfas.api.analyze.AnalyzeParameters)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>analyze</h4> +<pre>public <a href="../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeResult.html" title="interface in at.gv.egiz.pdfas.api.analyze">AnalyzeResult</a> analyze(<a href="../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html" title="class in at.gv.egiz.pdfas.api.analyze">AnalyzeParameters</a> analyzeParameters) + throws <a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#analyze(at.gv.egiz.pdfas.api.analyze.AnalyzeParameters)">PdfAs</a></code></strong></div> +<div class="block">Analyzes a document for signatures and returns a verify-able list of such.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#analyze(at.gv.egiz.pdfas.api.analyze.AnalyzeParameters)">analyze</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>analyzeParameters</code> - The analyzation parameters.</dd> +<dt><span class="strong">Returns:</span></dt><dd>Returns a list of verify-able signatures that were found in the + document.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></code> - Thrown on error.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html" title="class in at.gv.egiz.pdfas.api.analyze"><code>AnalyzeParameters</code></a>, +<a href="../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeResult.html" title="interface in at.gv.egiz.pdfas.api.analyze"><code>AnalyzeResult</code></a>, +<code>#verify(AnalyzeResult)}</code></dd></dl> +</li> +</ul> +<a name="reconstructXMLDSIG(at.gv.egiz.pdfas.api.xmldsig.ReconstructXMLDsigParameters)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reconstructXMLDSIG</h4> +<pre>public <a href="../../../../../at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigResult.html" title="class in at.gv.egiz.pdfas.api.xmldsig">ReconstructXMLDsigResult</a> reconstructXMLDSIG(<a href="../../../../../at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigParameters.html" title="class in at.gv.egiz.pdfas.api.xmldsig">ReconstructXMLDsigParameters</a> reconstructXMLDsigParameters) + throws <a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#reconstructXMLDSIG(at.gv.egiz.pdfas.api.xmldsig.ReconstructXMLDsigParameters)">PdfAs</a></code></strong></div> +<div class="block">Reconstruct the <xmldsig:Signature> from the given parameters.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#reconstructXMLDSIG(at.gv.egiz.pdfas.api.xmldsig.ReconstructXMLDsigParameters)">reconstructXMLDSIG</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>reconstructXMLDsigParameters</code> - The data from which to reconstruct the xmldsig</dd> +<dt><span class="strong">Returns:</span></dt><dd>a list of xmldsigs, one for each signature in the document</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></code> - if the reconstruction fails</dd></dl> +</li> +</ul> +<a name="reconstructXMLDSIG(at.gv.egiz.pdfas.api.xmldsig.ReconstructXMLDsigAfterAnalysisParameters)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reconstructXMLDSIG</h4> +<pre>public <a href="../../../../../at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigResult.html" title="class in at.gv.egiz.pdfas.api.xmldsig">ReconstructXMLDsigResult</a> reconstructXMLDSIG(<a href="../../../../../at/gv/egiz/pdfas/api/xmldsig/ReconstructXMLDsigAfterAnalysisParameters.html" title="class in at.gv.egiz.pdfas.api.xmldsig">ReconstructXMLDsigAfterAnalysisParameters</a> reconstructXMLDsigParameters) + throws <a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#reconstructXMLDSIG(at.gv.egiz.pdfas.api.xmldsig.ReconstructXMLDsigAfterAnalysisParameters)">PdfAs</a></code></strong></div> +<div class="block">Reconstruct the <xmldsig:Signature> from the given parameters.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#reconstructXMLDSIG(at.gv.egiz.pdfas.api.xmldsig.ReconstructXMLDsigAfterAnalysisParameters)">reconstructXMLDSIG</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>reconstructXMLDsigParameters</code> - The data from which to reconstruct the xmldsigs</dd> +<dt><span class="strong">Returns:</span></dt><dd>a list of xmldsigs, one for each signature in the document</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></code></dd></dl> +</li> +</ul> +<a name="verify(at.gv.egiz.pdfas.api.verify.VerifyAfterAnalysisParameters)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>verify</h4> +<pre>public <a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyResults.html" title="interface in at.gv.egiz.pdfas.api.verify">VerifyResults</a> verify(<a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyAfterAnalysisParameters.html" title="class in at.gv.egiz.pdfas.api.verify">VerifyAfterAnalysisParameters</a> verifyAfterAnalysisParameters) + throws <a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#verify(at.gv.egiz.pdfas.api.verify.VerifyAfterAnalysisParameters)">PdfAs</a></code></strong></div> +<div class="block">Verifies a list of signatures that have been analyzed previously.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#verify(at.gv.egiz.pdfas.api.verify.VerifyAfterAnalysisParameters)">verify</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>verifyAfterAnalysisParameters</code> - The parameters.</dd> +<dt><span class="strong">Returns:</span></dt><dd>Returns the verification results.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></code> - Thrown on error.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeResult.html" title="interface in at.gv.egiz.pdfas.api.analyze"><code>AnalyzeResult</code></a>, +<a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyAfterAnalysisParameters.html" title="class in at.gv.egiz.pdfas.api.verify"><code>VerifyAfterAnalysisParameters</code></a>, +<a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyResults.html" title="interface in at.gv.egiz.pdfas.api.verify"><code>VerifyResults</code></a>, +<a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyResult.html" title="interface in at.gv.egiz.pdfas.api.verify"><code>VerifyResult</code></a>, +<code>#analyze(AnalyzeParameters)}</code></dd></dl> +</li> +</ul> +<a name="verify(at.gv.egiz.pdfas.api.verify.VerifyAfterReconstructXMLDsigParameters)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>verify</h4> +<pre>public <a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyResults.html" title="interface in at.gv.egiz.pdfas.api.verify">VerifyResults</a> verify(<a href="../../../../../at/gv/egiz/pdfas/api/verify/VerifyAfterReconstructXMLDsigParameters.html" title="class in at.gv.egiz.pdfas.api.verify">VerifyAfterReconstructXMLDsigParameters</a> verifyAfterReconstructXMLDsigParameters) + throws <a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#verify(at.gv.egiz.pdfas.api.verify.VerifyAfterReconstructXMLDsigParameters)">PdfAs</a></code></strong></div> +<div class="block">Verifies a list of signatures that have been analyzed previously and the xmldsigs have been reconstructed.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#verify(at.gv.egiz.pdfas.api.verify.VerifyAfterReconstructXMLDsigParameters)">verify</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>verifyAfterReconstructXMLDsigParameters</code> - The parameters.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the verification results.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></code> - Thrown on error.</dd></dl> +</li> +</ul> +<a name="reloadConfig()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reloadConfig</h4> +<pre>public void reloadConfig() + throws <a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#reloadConfig()">PdfAs</a></code></strong></div> +<div class="block">Reloads the configuration from the work directory.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#reloadConfig()">reloadConfig</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></code> - Thrown, if an error occurs.</dd></dl> +</li> +</ul> +<a name="getProfileInformation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProfileInformation</h4> +<pre>public java.util.List getProfileInformation() + throws <a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#getProfileInformation()">PdfAs</a></code></strong></div> +<div class="block">Returns the list of information objects about activated profiles available in the + configuration. + + <p> + Note: Currently the profile information consists of the profile Id and the + MOA Key Id only. + </p> + <p> + Note: In near future the profile management will be moved out of the config + file into an API class representation of the profiles which may render this + (and related) methods obsolete. + </p></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#getProfileInformation()">getProfileInformation</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>Returns the list of <a href="../../../../../at/gv/egiz/pdfas/api/commons/SignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons"><code>SignatureProfile</code></a> objects with + information about active profiles available in the configuration.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></code> - Thrown on error.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../at/gv/egiz/pdfas/api/commons/SignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons"><code>SignatureProfile</code></a></dd></dl> +</li> +</ul> +<a name="createDynamicSignatureProfile(java.lang.String, at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createDynamicSignatureProfile</h4> +<pre>public <a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons">DynamicSignatureProfile</a> createDynamicSignatureProfile(java.lang.String parentProfile, + <a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureLifetimeEnum.html" title="class in at.gv.egiz.pdfas.api.commons">DynamicSignatureLifetimeEnum</a> mode)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#createDynamicSignatureProfile(java.lang.String, at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)">PdfAs</a></code></strong></div> +<div class="block">Create a signature profile dynamically. You have do apply() it for usage. See <a href="../../../../../at/gv/egiz/pdfas/api/commons/SignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons"><code>SignatureProfile</code></a>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#createDynamicSignatureProfile(java.lang.String, at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)">createDynamicSignatureProfile</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>parentProfile</code> - a parent profile id to inherit all properties</dd><dd><code>mode</code> - lifetime mode</dd> +<dt><span class="strong">Returns:</span></dt><dd>the created signature profile to work with.</dd></dl> +</li> +</ul> +<a name="createDynamicSignatureProfile(java.lang.String, java.lang.String, at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createDynamicSignatureProfile</h4> +<pre>public <a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons">DynamicSignatureProfile</a> createDynamicSignatureProfile(java.lang.String myUniqueName, + java.lang.String parentProfile, + <a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureLifetimeEnum.html" title="class in at.gv.egiz.pdfas.api.commons">DynamicSignatureLifetimeEnum</a> mode)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#createDynamicSignatureProfile(java.lang.String, java.lang.String, at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)">PdfAs</a></code></strong></div> +<div class="block">Create a signature profile dynamically. You have to provide a unique name and have do apply() it for usage. See <a href="../../../../../at/gv/egiz/pdfas/api/commons/SignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons"><code>SignatureProfile</code></a>. + It is recommended to use <a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#createDynamicSignatureProfile(java.lang.String, at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)"><code>PdfAs.createDynamicSignatureProfile(String, DynamicSignatureLifetimeEnum)</code></a> that generates + a unique name on its own.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#createDynamicSignatureProfile(java.lang.String, java.lang.String, at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)">createDynamicSignatureProfile</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>myUniqueName</code> - a unique name for the profile</dd><dd><code>parentProfile</code> - a parent profile id to inherit all properties</dd><dd><code>mode</code> - lifetime mode</dd> +<dt><span class="strong">Returns:</span></dt><dd>the created signature profile to work with.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons"><code>DynamicSignatureProfile</code></a></dd></dl> +</li> +</ul> +<a name="createEmptyDynamicSignatureProfile(at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createEmptyDynamicSignatureProfile</h4> +<pre>public <a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons">DynamicSignatureProfile</a> createEmptyDynamicSignatureProfile(<a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureLifetimeEnum.html" title="class in at.gv.egiz.pdfas.api.commons">DynamicSignatureLifetimeEnum</a> mode)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#createEmptyDynamicSignatureProfile(at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)">PdfAs</a></code></strong></div> +<div class="block">Create a signature profile dynamically. You have fill it with properties and apply() it for usage. See <a href="../../../../../at/gv/egiz/pdfas/api/commons/SignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons"><code>SignatureProfile</code></a>. + <br> + It is recommended to use <a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#createDynamicSignatureProfile(java.lang.String, at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)"><code>PdfAs.createDynamicSignatureProfile(String, DynamicSignatureLifetimeEnum)</code></a> that inherits from an + existing profile saving you a lot of work.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#createEmptyDynamicSignatureProfile(at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)">createEmptyDynamicSignatureProfile</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>mode</code> - lifetime mode</dd> +<dt><span class="strong">Returns:</span></dt><dd>the created signature profile to work with.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons"><code>DynamicSignatureProfile</code></a></dd></dl> +</li> +</ul> +<a name="createEmptyDynamicSignatureProfile(java.lang.String, at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createEmptyDynamicSignatureProfile</h4> +<pre>public <a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons">DynamicSignatureProfile</a> createEmptyDynamicSignatureProfile(java.lang.String myUniqueName, + <a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureLifetimeEnum.html" title="class in at.gv.egiz.pdfas.api.commons">DynamicSignatureLifetimeEnum</a> mode)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#createEmptyDynamicSignatureProfile(java.lang.String, at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)">PdfAs</a></code></strong></div> +<div class="block">Create a signature profile dynamically. You have fill it with properties and apply() it for usage. See <a href="../../../../../at/gv/egiz/pdfas/api/commons/SignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons"><code>SignatureProfile</code></a>. + <br> + It is recommended to use <a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#createDynamicSignatureProfile(java.lang.String, at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)"><code>PdfAs.createDynamicSignatureProfile(String, DynamicSignatureLifetimeEnum)</code></a> that inherits from an + existing profile saving you a lot of work.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#createEmptyDynamicSignatureProfile(java.lang.String, at.gv.egiz.pdfas.api.commons.DynamicSignatureLifetimeEnum)">createEmptyDynamicSignatureProfile</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>myUniqueName</code> - a unique name for the profile</dd><dd><code>mode</code> - lifetime mode</dd> +<dt><span class="strong">Returns:</span></dt><dd>the created signature profile to work with.</dd></dl> +</li> +</ul> +<a name="loadDynamicSignatureProfile(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadDynamicSignatureProfile</h4> +<pre>public <a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons">DynamicSignatureProfile</a> loadDynamicSignatureProfile(java.lang.String profileName)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#loadDynamicSignatureProfile(java.lang.String)">PdfAs</a></code></strong></div> +<div class="block">Loads an existing dynamic signature profile by its name. Profiles are saved when they are applied + and it has <a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureLifetimeEnum.html#MANUAL"><code>DynamicSignatureLifetimeEnum.MANUAL</code></a></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#loadDynamicSignatureProfile(java.lang.String)">loadDynamicSignatureProfile</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the signature profile or <code>null</code> if not found.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html" title="interface in at.gv.egiz.pdfas.api.commons"><code>DynamicSignatureProfile</code></a></dd></dl> +</li> +</ul> +<a name="prepareSign(at.gv.egiz.pdfas.api.sign.SignParameters)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prepareSign</h4> +<pre>public <a href="../../../../../at/gv/egiz/pdfas/api/sign/SignatureDetailInformation.html" title="interface in at.gv.egiz.pdfas.api.sign">SignatureDetailInformation</a> prepareSign(<a href="../../../../../at/gv/egiz/pdfas/api/sign/SignParameters.html" title="class in at.gv.egiz.pdfas.api.sign">SignParameters</a> signParameters) + throws <a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#prepareSign(at.gv.egiz.pdfas.api.sign.SignParameters)">PdfAs</a></code></strong></div> +<div class="block">Prepares the signature of the given PDF document. The table for the signature data is placed but not filled.<br/> + Usually used for preview.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#prepareSign(at.gv.egiz.pdfas.api.sign.SignParameters)">prepareSign</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>signParameters</code> - The sign parameters.</dd> +<dt><span class="strong">Returns:</span></dt><dd>Only the <a href="../../../../../at/gv/egiz/pdfas/api/sign/SignatureDetailInformation.html#getSignaturePosition()"><code>SignatureDetailInformation.getSignaturePosition()</code></a>, <a href="../../../../../at/gv/egiz/pdfas/api/sign/SignatureDetailInformation.html#getNonTextualObjects()"><code>SignatureDetailInformation.getNonTextualObjects()</code></a>, <a href="../../../../../at/gv/egiz/pdfas/api/sign/SignatureDetailInformation.html#getSignatureData()"><code>SignatureDetailInformation.getSignatureData()</code></a> are filled.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></code> - if something goes wrong during the process</dd></dl> +</li> +</ul> +<a name="finishSign(at.gv.egiz.pdfas.api.sign.SignParameters, at.gv.egiz.pdfas.api.sign.SignatureDetailInformation)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>finishSign</h4> +<pre>public <a href="../../../../../at/gv/egiz/pdfas/api/sign/SignResult.html" title="interface in at.gv.egiz.pdfas.api.sign">SignResult</a> finishSign(<a href="../../../../../at/gv/egiz/pdfas/api/sign/SignParameters.html" title="class in at.gv.egiz.pdfas.api.sign">SignParameters</a> signParameters, + <a href="../../../../../at/gv/egiz/pdfas/api/sign/SignatureDetailInformation.html" title="interface in at.gv.egiz.pdfas.api.sign">SignatureDetailInformation</a> signatureDetailInformation) + throws <a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#finishSign(at.gv.egiz.pdfas.api.sign.SignParameters, at.gv.egiz.pdfas.api.sign.SignatureDetailInformation)">PdfAs</a></code></strong></div> +<div class="block">Finish the signature process. The PDF is filled with the signature data.<br/> + Usually used if some steps like the actual signing are to be performed externally.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html#finishSign(at.gv.egiz.pdfas.api.sign.SignParameters, at.gv.egiz.pdfas.api.sign.SignatureDetailInformation)">finishSign</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>signParameters</code> - The sign parameters.</dd><dd><code>signatureDetailInformation</code> - The signature detail information.</dd> +<dt><span class="strong">Returns:</span></dt><dd></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/exceptions/PdfAsException.html" title="class in at.gv.egiz.pdfas.api.exceptions">PdfAsException</a></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="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> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../at/gv/egiz/pdfas/wrapper/LegacyMainTest.html" title="class in at.gv.egiz.pdfas.wrapper"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../at/gv/egiz/pdfas/wrapper/SignatureCheckWrapper.html" title="class in at.gv.egiz.pdfas.wrapper"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?at/gv/egiz/pdfas/wrapper/PdfAsObject.html" target="_top">Frames</a></li> +<li><a href="PdfAsObject.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |