Documentation + Documentation building

author: Andreas Fitzek <andreas.fitzek@iaik.tugraz.at> 2014-02-05 09:20:54 +0100
committer: Andreas Fitzek <andreas.fitzek@iaik.tugraz.at> 2014-02-05 09:20:54 +0100
commit: 87c9269152f8c631123525b796cf07dc0cca7398 (patch)
tree: 041c36a99e746df8a802375a5f71b0f7081f6e51 /docs/at/gv/egiz/pdfas/lib/api/StatusRequest.html
parent: 3f78cac3c1c5255b315a60c98cfb6853f1faa2fc (diff)
download: pdf-as-4-87c9269152f8c631123525b796cf07dc0cca7398.tar.gz
pdf-as-4-87c9269152f8c631123525b796cf07dc0cca7398.tar.bz2
pdf-as-4-87c9269152f8c631123525b796cf07dc0cca7398.zip
1 files changed, 329 insertions, 0 deletions
diff --git a/docs/at/gv/egiz/pdfas/lib/api/StatusRequest.html b/docs/at/gv/egiz/pdfas/lib/api/StatusRequest.html
new file mode 100644
index 00000000..0d7b4120
--- /dev/null
+++ b/docs/at/gv/egiz/pdfas/lib/api/StatusRequest.html
@@ -0,0 +1,329 @@
+<!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 Tue Feb 04 17:03:59 CET 2014 -->
+<meta http-equiv="Content-Type" content="text/html" charset="ISO-8859-1">
+<title>StatusRequest (PDF-AS 4.0.0-SNAPSHOT Library)</title>
+<meta name="date" content="2014-02-04">
+<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="StatusRequest (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/StatusRequest.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 [6b692931c81fd0e09d8d21eb81e05a5f08af8342]</b></em></div>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../at/gv/egiz/pdfas/lib/api/SignaturePosition.html" title="interface in at.gv.egiz.pdfas.lib.api"><span class="strong">Prev Class</span></a></li>
+<li>Next Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?at/gv/egiz/pdfas/lib/api/StatusRequest.html" target="_top">Frames</a></li>
+<li><a href="StatusRequest.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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</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 StatusRequest" class="title">Interface StatusRequest</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public interface <span class="strong">StatusRequest</span></pre>
+<div class="block">Status of a signture process</div>
+</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">&nbsp;</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>byte[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/lib/api/StatusRequest.html#getSignatureData()">getSignatureData</a></strong>()</code>
+<div class="block">Gets the data to be signed</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>int[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/lib/api/StatusRequest.html#getSignatureDataByteRange()">getSignatureDataByteRange</a></strong>()</code>
+<div class="block">Gets the byte range of the data to be signed</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/lib/api/StatusRequest.html#isReady()">isReady</a></strong>()</code>
+<div class="block">If true finishSign in PdfAs can be called to retrieve the signed pdf</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/lib/api/StatusRequest.html#needCertificate()">needCertificate</a></strong>()</code>
+<div class="block">If true PDF-AS requires the signature certificate
+ 
+ Retrieve the signing certificate and set it via setCertificate</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/lib/api/StatusRequest.html#needSignature()">needSignature</a></strong>()</code>
+<div class="block">If true PDF-AS requires a the CAdES signature
+ 
+ use getSignatureData() and getSignatureDataByteRange() to retrieve the
+ data to be signed and set the signature via setSigature</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/lib/api/StatusRequest.html#setCertificate(byte[])">setCertificate</a></strong>(byte[]&nbsp;encodedCertificate)</code>
+<div class="block">Sets the signing certificate</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/lib/api/StatusRequest.html#setSigature(byte[])">setSigature</a></strong>(byte[]&nbsp;signatureValue)</code>
+<div class="block">Sets the signature</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="needCertificate()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>needCertificate</h4>
+<pre>boolean&nbsp;needCertificate()</pre>
+<div class="block">If true PDF-AS requires the signature certificate
+ 
+ Retrieve the signing certificate and set it via setCertificate</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
+</li>
+</ul>
+<a name="needSignature()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>needSignature</h4>
+<pre>boolean&nbsp;needSignature()</pre>
+<div class="block">If true PDF-AS requires a the CAdES signature
+ 
+ use getSignatureData() and getSignatureDataByteRange() to retrieve the
+ data to be signed and set the signature via setSigature</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
+</li>
+</ul>
+<a name="isReady()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isReady</h4>
+<pre>boolean&nbsp;isReady()</pre>
+<div class="block">If true finishSign in PdfAs can be called to retrieve the signed pdf</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
+</li>
+</ul>
+<a name="getSignatureData()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSignatureData</h4>
+<pre>byte[]&nbsp;getSignatureData()</pre>
+<div class="block">Gets the data to be signed</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
+</li>
+</ul>
+<a name="getSignatureDataByteRange()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSignatureDataByteRange</h4>
+<pre>int[]&nbsp;getSignatureDataByteRange()</pre>
+<div class="block">Gets the byte range of the data to be signed</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
+</li>
+</ul>
+<a name="setCertificate(byte[])">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setCertificate</h4>
+<pre>void&nbsp;setCertificate(byte[]&nbsp;encodedCertificate)
+                    throws <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/security/cert/CertificateException.html?is-external=true" title="class or interface in java.security.cert">CertificateException</a></pre>
+<div class="block">Sets the signing certificate</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>encodedCertificate</code> - </dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://java.sun.com/j2se/1.5.0/docs/api/java/security/cert/CertificateException.html?is-external=true" title="class or interface in java.security.cert">CertificateException</a></code></dd></dl>
+</li>
+</ul>
+<a name="setSigature(byte[])">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>setSigature</h4>
+<pre>void&nbsp;setSigature(byte[]&nbsp;signatureValue)</pre>
+<div class="block">Sets the signature</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>signatureValue</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/StatusRequest.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 [6b692931c81fd0e09d8d21eb81e05a5f08af8342]</b></em></div>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../at/gv/egiz/pdfas/lib/api/SignaturePosition.html" title="interface in at.gv.egiz.pdfas.lib.api"><span class="strong">Prev Class</span></a></li>
+<li>Next Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?at/gv/egiz/pdfas/lib/api/StatusRequest.html" target="_top">Frames</a></li>
+<li><a href="StatusRequest.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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
author	Andreas Fitzek <andreas.fitzek@iaik.tugraz.at>	2014-02-05 09:20:54 +0100
committer	Andreas Fitzek <andreas.fitzek@iaik.tugraz.at>	2014-02-05 09:20:54 +0100
commit	87c9269152f8c631123525b796cf07dc0cca7398 (patch)
tree	041c36a99e746df8a802375a5f71b0f7081f6e51 /docs/at/gv/egiz/pdfas/lib/api/StatusRequest.html
parent	3f78cac3c1c5255b315a60c98cfb6853f1faa2fc (diff)
download	pdf-as-4-87c9269152f8c631123525b796cf07dc0cca7398.tar.gz pdf-as-4-87c9269152f8c631123525b796cf07dc0cca7398.tar.bz2 pdf-as-4-87c9269152f8c631123525b796cf07dc0cca7398.zip