diff options
Diffstat (limited to 'docs/full/at/gv/egiz/pdfas/PdfAsFactory.html')
| -rw-r--r-- | docs/full/at/gv/egiz/pdfas/PdfAsFactory.html | 362 |
1 files changed, 362 insertions, 0 deletions
diff --git a/docs/full/at/gv/egiz/pdfas/PdfAsFactory.html b/docs/full/at/gv/egiz/pdfas/PdfAsFactory.html new file mode 100644 index 00000000..7f179789 --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/PdfAsFactory.html @@ -0,0 +1,362 @@ +<!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:22:00 CET 2014 --> +<title>PdfAsFactory</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="PdfAsFactory"; + } +//--> +</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>Prev Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?at/gv/egiz/pdfas/PdfAsFactory.html" target="_top">Frames</a></li> +<li><a href="PdfAsFactory.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</div> +<h2 title="Class PdfAsFactory" class="title">Class PdfAsFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>at.gv.egiz.pdfas.PdfAsFactory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<div class="block"><strong>Deprecated.</strong></div> +<br> +<pre>@Deprecated +public class <span class="strong">PdfAsFactory</span> +extends java.lang.Object</pre> +<div class="block">Main factory for creating a PDF-AS API Instance (PdfAs Interface).</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api"><code>PdfAs</code></a></dd></dl> +</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/PdfAsFactory.html#PdfAsFactory()">PdfAsFactory</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> + </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>static <a href="../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></td> +<td class="colLast"><code><strong><a href="../../../../at/gv/egiz/pdfas/PdfAsFactory.html#createPdfAs()">createPdfAs</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></td> +<td class="colLast"><code><strong><a href="../../../../at/gv/egiz/pdfas/PdfAsFactory.html#createPdfAs(boolean)">createPdfAs</a></strong>(boolean registerProvider)</code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></td> +<td class="colLast"><code><strong><a href="../../../../at/gv/egiz/pdfas/PdfAsFactory.html#createPdfAs(java.io.File)">createPdfAs</a></strong>(java.io.File workDirectory)</code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a></code></td> +<td class="colLast"><code><strong><a href="../../../../at/gv/egiz/pdfas/PdfAsFactory.html#createPdfAs(java.io.File, boolean)">createPdfAs</a></strong>(java.io.File workDirectory, + boolean registerProvider)</code> +<div class="block"><strong>Deprecated.</strong> </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="PdfAsFactory()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PdfAsFactory</h4> +<pre>public PdfAsFactory()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createPdfAs(java.io.File)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createPdfAs</h4> +<pre>@Deprecated +public static <a href="../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a> createPdfAs(java.io.File workDirectory) + 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"><span class="strong">Deprecated.</span> </div> +<div class="block">Creates a PDF-AS API instance for the given work directory.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>workDirectory</code> - The work directory. If <code>null</code> the configuration is assumed to be located + within the user's home directory. Note: IAIK JCE and IAIK ECC security provders are + automatically registered.</dd> +<dt><span class="strong">Returns:</span></dt><dd>Returns an instance of the PDF-AS API.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - Thrown, if the workDirectory doesn't exist.</dd> +<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 the work directory does not meet its requirements, or + if the config file is invalid.</dd><dt><span class="strong">See Also:</span></dt><dd><code>PdfAS#USERHOME_CONFIG_FOLDER</code></dd></dl> +</li> +</ul> +<a name="createPdfAs(java.io.File, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createPdfAs</h4> +<pre>@Deprecated +public static <a href="../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a> createPdfAs(java.io.File workDirectory, + boolean registerProvider) + 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"><span class="strong">Deprecated.</span> </div> +<div class="block">Creates a PDF-AS API instance for the given work directory. + + WARNING registerProvider is IGNORED as ov Version 4.0</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>workDirectory</code> - The work directory. If <code>null</code> the configuration is assumed to be located + within the user's home directory.</dd><dd><code>registerProvider</code> - <code>true</code>: automatically registers IAIK JCE and ECC Provider; + <code>false</code>: providers will NOT be automatically registered, providers + needed have to be registered by the API user</dd> +<dt><span class="strong">Returns:</span></dt><dd>Returns an instance of the PDF-AS API.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - Thrown, if the workDirectory doesn't exist.</dd> +<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 the work directory does not meet its requirements, or + if the config file is invalid.</dd><dt><span class="strong">See Also:</span></dt><dd><code>PdfAS#USERHOME_CONFIG_FOLDER</code></dd></dl> +</li> +</ul> +<a name="createPdfAs()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createPdfAs</h4> +<pre>@Deprecated +public static <a href="../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a> createPdfAs() + 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"><span class="strong">Deprecated.</span> </div> +<div class="block">Creates a PDF-AS API instance assuming that the configuration is located within the user's + home directory. Note: IAIK JCE and IAIK ECC security providers are automatically registered.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Returns an instance of the PDF-AS API.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - Thrown, if the work directory doesn't exist within the user's home directory.</dd> +<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 the work directory does not meet its requirements, or + if the config file is invalid.</dd><dt><span class="strong">See Also:</span></dt><dd><code>PdfAS#USERHOME_CONFIG_FOLDER</code></dd></dl> +</li> +</ul> +<a name="createPdfAs(boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createPdfAs</h4> +<pre>@Deprecated +public static <a href="../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api">PdfAs</a> createPdfAs(boolean registerProvider) + 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"><span class="strong">Deprecated.</span> </div> +<div class="block">Creates a PDF-AS API instance assuming that the configuration is located within the user's + home directory. + + WARNING registerProvider is IGNORED as ov Version 4.0</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>registerProvider</code> - <code>true</code>: automatically registers IAIK JCE and ECC Provider; + <code>false</code>: providers will NOT be automatically registered, providers + needed have to be registered by the API user</dd> +<dt><span class="strong">Returns:</span></dt><dd>Returns an instance of the PDF-AS API.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - Thrown, if the work directory doesn't exist within the user's home directory.</dd> +<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 the work directory does not meet its requirements, or + if the config file is invalid.</dd><dt><span class="strong">See Also:</span></dt><dd><code>PdfAS#USERHOME_CONFIG_FOLDER</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>Prev Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?at/gv/egiz/pdfas/PdfAsFactory.html" target="_top">Frames</a></li> +<li><a href="PdfAsFactory.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> |