Added: poi/site/publish/apidocs/org/apache/poi/poifs/crypt/dsig/SignatureConfig.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/poifs/crypt/dsig/SignatureConfig.html?rev=1631441&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/poifs/crypt/dsig/SignatureConfig.html (added) +++ poi/site/publish/apidocs/org/apache/poi/poifs/crypt/dsig/SignatureConfig.html Mon Oct 13 15:44:30 2014 @@ -0,0 +1,1433 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>SignatureConfig (POI API Documentation)</title> +<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="SignatureConfig (POI API Documentation)"; + } +//--> +</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/SignatureConfig.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> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/RevokedCertificateSecurityException.html" title="class in org.apache.poi.poifs.crypt.dsig"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.SignatureConfigurable.html" title="interface in org.apache.poi.poifs.crypt.dsig"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/poifs/crypt/dsig/SignatureConfig.html" target="_top">Frames</a></li> +<li><a href="SignatureConfig.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><a href="#nested_class_summary">Nested</a> | </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">org.apache.poi.poifs.crypt.dsig</div> +<h2 title="Class SignatureConfig" class="title">Class SignatureConfig</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.poi.poifs.crypt.dsig.SignatureConfig</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">SignatureConfig</span> +extends java.lang.Object</pre> +<div class="block">This class bundles the configuration options used for the existing + signature facets. + Apart of the thread local members (e.g. opc-package) most values will probably be constant, so + it might be configured centrally (e.g. by spring)</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.SignatureConfigurable.html" title="interface in org.apache.poi.poifs.crypt.dsig">SignatureConfig.SignatureConfigurable</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== 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="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#SignatureConfig()">SignatureConfig</a></strong>()</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#addSignatureFacet(org.apache.poi.poifs.crypt.dsig.facets.SignatureFacet)">addSignatureFacet</a></strong>(<a href="../../../../../../org/apache/poi/poifs/crypt/dsig/facets/SignatureFacet.html" title="class in org.apache.poi.poifs.crypt.dsig.facets">SignatureFacet</a> signatureFacet)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getCanonicalizationMethod()">getCanonicalizationMethod</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getDigestAlgo()">getDigestAlgo</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getDigestMethodUri()">getDigestMethodUri</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getDigestMethodUri(org.apache.poi.poifs.crypt.HashAlgorithm)">getDigestMethodUri</a></strong>(<a href="../../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> digestAlgo)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getExecutionTime()">getExecutionTime</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getHashMagic()">getHashMagic</a></strong>()</code> +<div class="block">Each digest method has its own IV (initial vector)</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.security.PrivateKey</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getKey()">getKey</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>javax.xml.crypto.dsig.keyinfo.KeyInfoFactory</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getKeyInfoFactory()">getKeyInfoFactory</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getNamespacePrefixes()">getNamespacePrefixes</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc">OPCPackage</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getOpcPackage()">getOpcPackage</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getPackageSignatureId()">getPackageSignatureId</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.security.Provider</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getProvider()">getProvider</a></strong>()</code> +<div class="block">This method tests the existence of xml signature provider in the following order: + + the class pointed to by the system property "jsr105Provider" + the Santuario xmlsec provider + the JDK xmlsec provider + + + For signing the classes are linked against the Santuario xmlsec, so this might + only work for validation (not tested).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getProxyUrl()">getProxyUrl</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/RevocationDataService.html" title="interface in org.apache.poi.poifs.crypt.dsig.services">RevocationDataService</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getRevocationDataService()">getRevocationDataService</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getSignatureDescription()">getSignatureDescription</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../../org/apache/poi/poifs/crypt/dsig/facets/SignatureFacet.html" title="class in org.apache.poi.poifs.crypt.dsig.facets">SignatureFacet</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getSignatureFacets()">getSignatureFacets</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>javax.xml.crypto.dsig.XMLSignatureFactory</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getSignatureFactory()">getSignatureFactory</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.w3c.dom.events.EventListener</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getSignatureMarshalListener()">getSignatureMarshalListener</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getSignatureMethodUri()">getSignatureMethodUri</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/SignaturePolicyService.html" title="interface in org.apache.poi.poifs.crypt.dsig.services">SignaturePolicyService</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getSignaturePolicyService()">getSignaturePolicyService</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<java.security.cert.X509Certificate></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getSigningCertificateChain()">getSigningCertificateChain</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getTspDigestAlgo()">getTspDigestAlgo</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getTspPass()">getTspPass</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getTspRequestPolicy()">getTspRequestPolicy</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/TimeStampService.html" title="interface in org.apache.poi.poifs.crypt.dsig.services">TimeStampService</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getTspService()">getTspService</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getTspUrl()">getTspUrl</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getTspUser()">getTspUser</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/TimeStampServiceValidator.html" title="interface in org.apache.poi.poifs.crypt.dsig.services">TimeStampServiceValidator</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getTspValidator()">getTspValidator</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>javax.xml.crypto.URIDereferencer</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getUriDereferencer()">getUriDereferencer</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getUserAgent()">getUserAgent</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getXadesCanonicalizationMethod()">getXadesCanonicalizationMethod</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getXadesDigestAlgo()">getXadesDigestAlgo</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getXadesRole()">getXadesRole</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getXadesSignatureId()">getXadesSignatureId</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#init(boolean)">init</a></strong>(boolean onlyValidation)</code> +<div class="block">Inits and checks the config object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#isIncludeEntireCertificateChain()">isIncludeEntireCertificateChain</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#isIncludeIssuerSerial()">isIncludeIssuerSerial</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#isIncludeKeyValue()">isIncludeKeyValue</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#isTspOldProtocol()">isTspOldProtocol</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#isXadesIssuerNameNoReverseOrder()">isXadesIssuerNameNoReverseOrder</a></strong>()</code> +<div class="block">Make sure the DN is encoded using the same order as present + within the certificate.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#isXadesSignaturePolicyImplied()">isXadesSignaturePolicyImplied</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static <T> T</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#nvl(T,%20T)">nvl</a></strong>(T value, + T defaultValue)</code> +<div class="block">helper method for null/default value handling</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setCanonicalizationMethod(java.lang.String)">setCanonicalizationMethod</a></strong>(java.lang.String canonicalizationMethod)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setDigestAlgo(org.apache.poi.poifs.crypt.HashAlgorithm)">setDigestAlgo</a></strong>(<a href="../../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> digestAlgo)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setExecutionTime(java.util.Date)">setExecutionTime</a></strong>(java.util.Date executionTime)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setIncludeEntireCertificateChain(boolean)">setIncludeEntireCertificateChain</a></strong>(boolean includeEntireCertificateChain)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setIncludeIssuerSerial(boolean)">setIncludeIssuerSerial</a></strong>(boolean includeIssuerSerial)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setIncludeKeyValue(boolean)">setIncludeKeyValue</a></strong>(boolean includeKeyValue)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setKey(java.security.PrivateKey)">setKey</a></strong>(java.security.PrivateKey key)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setKeyInfoFactory(javax.xml.crypto.dsig.keyinfo.KeyInfoFactory)">setKeyInfoFactory</a></strong>(javax.xml.crypto.dsig.keyinfo.KeyInfoFactory keyInfoFactory)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setNamespacePrefixes(java.util.Map)">setNamespacePrefixes</a></strong>(java.util.Map<java.lang.String,java.lang.String> namespacePrefixes)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setOpcPackage(org.apache.poi.openxml4j.opc.OPCPackage)">setOpcPackage</a></strong>(<a href="../../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc">OPCPackage</a> opcPackage)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setPackageSignatureId(java.lang.String)">setPackageSignatureId</a></strong>(java.lang.String packageSignatureId)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setProxyUrl(java.lang.String)">setProxyUrl</a></strong>(java.lang.String proxyUrl)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setRevocationDataService(org.apache.poi.poifs.crypt.dsig.services.RevocationDataService)">setRevocationDataService</a></strong>(<a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/RevocationDataService.html" title="interface in org.apache.poi.poifs.crypt.dsig.services">RevocationDataService</a> revocationDataService)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setSignatureDescription(java.lang.String)">setSignatureDescription</a></strong>(java.lang.String signatureDescription)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setSignatureFacets(java.util.List)">setSignatureFacets</a></strong>(java.util.List<<a href="../../../../../../org/apache/poi/poifs/crypt/dsig/facets/SignatureFacet.html" title="class in org.apache.poi.poifs.crypt.dsig.facets">SignatureFacet</a>> signatureFacets)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setSignatureFactory(javax.xml.crypto.dsig.XMLSignatureFactory)">setSignatureFactory</a></strong>(javax.xml.crypto.dsig.XMLSignatureFactory signatureFactory)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setSignatureMarshalListener(org.w3c.dom.events.EventListener)">setSignatureMarshalListener</a></strong>(org.w3c.dom.events.EventListener signatureMarshalListener)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setSignaturePolicyService(org.apache.poi.poifs.crypt.dsig.services.SignaturePolicyService)">setSignaturePolicyService</a></strong>(<a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/SignaturePolicyService.html" title="interface in org.apache.poi.poifs.crypt.dsig.services">SignaturePolicyService</a> signaturePolicyService)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setSigningCertificateChain(java.util.List)">setSigningCertificateChain</a></strong>(java.util.List<java.security.cert.X509Certificate> signingCertificateChain)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setTspDigestAlgo(org.apache.poi.poifs.crypt.HashAlgorithm)">setTspDigestAlgo</a></strong>(<a href="../../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> tspDigestAlgo)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setTspOldProtocol(boolean)">setTspOldProtocol</a></strong>(boolean tspOldProtocol)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setTspPass(java.lang.String)">setTspPass</a></strong>(java.lang.String tspPass)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setTspRequestPolicy(java.lang.String)">setTspRequestPolicy</a></strong>(java.lang.String tspRequestPolicy)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setTspService(org.apache.poi.poifs.crypt.dsig.services.TimeStampService)">setTspService</a></strong>(<a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/TimeStampService.html" title="interface in org.apache.poi.poifs.crypt.dsig.services">TimeStampService</a> tspService)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setTspUrl(java.lang.String)">setTspUrl</a></strong>(java.lang.String tspUrl)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setTspUser(java.lang.String)">setTspUser</a></strong>(java.lang.String tspUser)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setTspValidator(org.apache.poi.poifs.crypt.dsig.services.TimeStampServiceValidator)">setTspValidator</a></strong>(<a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/TimeStampServiceValidator.html" title="interface in org.apache.poi.poifs.crypt.dsig.services">TimeStampServiceValidator</a> tspValidator)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setUriDereferencer(javax.xml.crypto.URIDereferencer)">setUriDereferencer</a></strong>(javax.xml.crypto.URIDereferencer uriDereferencer)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setUserAgent(java.lang.String)">setUserAgent</a></strong>(java.lang.String userAgent)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setXadesCanonicalizationMethod(java.lang.String)">setXadesCanonicalizationMethod</a></strong>(java.lang.String xadesCanonicalizationMethod)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setXadesDigestAlgo(org.apache.poi.poifs.crypt.HashAlgorithm)">setXadesDigestAlgo</a></strong>(<a href="../../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> xadesDigestAlgo)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setXadesIssuerNameNoReverseOrder(boolean)">setXadesIssuerNameNoReverseOrder</a></strong>(boolean xadesIssuerNameNoReverseOrder)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setXadesRole(java.lang.String)">setXadesRole</a></strong>(java.lang.String xadesRole)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setXadesSignatureId(java.lang.String)">setXadesSignatureId</a></strong>(java.lang.String xadesSignatureId)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#setXadesSignaturePolicyImplied(boolean)">setXadesSignaturePolicyImplied</a></strong>(boolean xadesSignaturePolicyImplied)</code> </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="SignatureConfig()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SignatureConfig</h4> +<pre>public SignatureConfig()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="init(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>init</h4> +<pre>protected void init(boolean onlyValidation)</pre> +<div class="block">Inits and checks the config object. + If not set previously, complex configuration properties also get + created/initialized via this initialization call.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>onlyValidation</code> - if true, only a subset of the properties + is initialized, which are necessary for validation. If false, + also the other properties needed for signing are been taken care of</dd></dl> +</li> +</ul> +<a name="addSignatureFacet(org.apache.poi.poifs.crypt.dsig.facets.SignatureFacet)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addSignatureFacet</h4> +<pre>public void addSignatureFacet(<a href="../../../../../../org/apache/poi/poifs/crypt/dsig/facets/SignatureFacet.html" title="class in org.apache.poi.poifs.crypt.dsig.facets">SignatureFacet</a> signatureFacet)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>signatureFacet</code> - the signature facet is appended to facet list</dd></dl> +</li> +</ul> +<a name="getSignatureFacets()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSignatureFacets</h4> +<pre>public java.util.List<<a href="../../../../../../org/apache/poi/poifs/crypt/dsig/facets/SignatureFacet.html" title="class in org.apache.poi.poifs.crypt.dsig.facets">SignatureFacet</a>> getSignatureFacets()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the list of facets, may be empty when the config object is not initialized</dd></dl> +</li> +</ul> +<a name="setSignatureFacets(java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSignatureFacets</h4> +<pre>public void setSignatureFacets(java.util.List<<a href="../../../../../../org/apache/poi/poifs/crypt/dsig/facets/SignatureFacet.html" title="class in org.apache.poi.poifs.crypt.dsig.facets">SignatureFacet</a>> signatureFacets)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>signatureFacets</code> - the new list of facets</dd></dl> +</li> +</ul> +<a name="getDigestAlgo()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDigestAlgo</h4> +<pre>public <a href="../../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> getDigestAlgo()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the main digest algorithm, defaults to sha-1</dd></dl> +</li> +</ul> +<a name="setDigestAlgo(org.apache.poi.poifs.crypt.HashAlgorithm)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDigestAlgo</h4> +<pre>public void setDigestAlgo(<a href="../../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> digestAlgo)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>digestAlgo</code> - the main digest algorithm</dd></dl> +</li> +</ul> +<a name="getOpcPackage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOpcPackage</h4> +<pre>public <a href="../../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc">OPCPackage</a> getOpcPackage()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the opc package to be used by this thread, stored as thread-local</dd></dl> +</li> +</ul> +<a name="setOpcPackage(org.apache.poi.openxml4j.opc.OPCPackage)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOpcPackage</h4> +<pre>public void setOpcPackage(<a href="../../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc">OPCPackage</a> opcPackage)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>opcPackage</code> - the opc package to be handled by this thread, stored as thread-local</dd></dl> +</li> +</ul> +<a name="getKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKey</h4> +<pre>public java.security.PrivateKey getKey()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the private key</dd></dl> +</li> +</ul> +<a name="setKey(java.security.PrivateKey)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setKey</h4> +<pre>public void setKey(java.security.PrivateKey key)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the private key</dd></dl> +</li> +</ul> +<a name="getSigningCertificateChain()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSigningCertificateChain</h4> +<pre>public java.util.List<java.security.cert.X509Certificate> getSigningCertificateChain()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the certificate chain, index 0 is usually the certificate matching + the private key</dd></dl> +</li> +</ul> +<a name="setSigningCertificateChain(java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSigningCertificateChain</h4> +<pre>public void setSigningCertificateChain(java.util.List<java.security.cert.X509Certificate> signingCertificateChain)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>signingCertificateChain</code> - the certificate chain, index 0 should be + the certificate matching the private key</dd></dl> +</li> +</ul> +<a name="getExecutionTime()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExecutionTime</h4> +<pre>public java.util.Date getExecutionTime()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the time at which the document is signed, also used for the timestamp service. + defaults to now</dd></dl> +</li> +</ul> +<a name="setExecutionTime(java.util.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExecutionTime</h4> +<pre>public void setExecutionTime(java.util.Date executionTime)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>executionTime</code> - sets the time at which the document ought to be signed</dd></dl> +</li> +</ul> +<a name="getSignaturePolicyService()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSignaturePolicyService</h4> +<pre>public <a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/SignaturePolicyService.html" title="interface in org.apache.poi.poifs.crypt.dsig.services">SignaturePolicyService</a> getSignaturePolicyService()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the service to be used for XAdES-EPES properties. There's no default implementation</dd></dl> +</li> +</ul> +<a name="setSignaturePolicyService(org.apache.poi.poifs.crypt.dsig.services.SignaturePolicyService)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSignaturePolicyService</h4> +<pre>public void setSignaturePolicyService(<a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/SignaturePolicyService.html" title="interface in org.apache.poi.poifs.crypt.dsig.services">SignaturePolicyService</a> signaturePolicyService)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>signaturePolicyService</code> - the service to be used for XAdES-EPES properties</dd></dl> +</li> +</ul> +<a name="getUriDereferencer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUriDereferencer</h4> +<pre>public javax.xml.crypto.URIDereferencer getUriDereferencer()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the dereferencer used for Reference/@URI attributes, defaults to <a href="../../../../../../org/apache/poi/poifs/crypt/dsig/OOXMLURIDereferencer.html" title="class in org.apache.poi.poifs.crypt.dsig"><code>OOXMLURIDereferencer</code></a></dd></dl> +</li> +</ul> +<a name="setUriDereferencer(javax.xml.crypto.URIDereferencer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setUriDereferencer</h4> +<pre>public void setUriDereferencer(javax.xml.crypto.URIDereferencer uriDereferencer)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uriDereferencer</code> - the dereferencer used for Reference/@URI attributes</dd></dl> +</li> +</ul> +<a name="getSignatureDescription()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSignatureDescription</h4> +<pre>public java.lang.String getSignatureDescription()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>Gives back the human-readable description of what the citizen + will be signing. The default value is "Office OpenXML Document".</dd></dl> +</li> +</ul> +<a name="setSignatureDescription(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSignatureDescription</h4> +<pre>public void setSignatureDescription(java.lang.String signatureDescription)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>signatureDescription</code> - the human-readable description of + what the citizen will be signing.</dd></dl> +</li> +</ul> +<a name="getCanonicalizationMethod()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCanonicalizationMethod</h4> +<pre>public java.lang.String getCanonicalizationMethod()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the default canonicalization method, defaults to INCLUSIVE</dd></dl> +</li> +</ul> +<a name="setCanonicalizationMethod(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCanonicalizationMethod</h4> +<pre>public void setCanonicalizationMethod(java.lang.String canonicalizationMethod)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>canonicalizationMethod</code> - the default canonicalization method</dd></dl> +</li> +</ul> +<a name="getPackageSignatureId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPackageSignatureId</h4> +<pre>public java.lang.String getPackageSignatureId()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>The signature Id attribute value used to create the XML signature. + Defaults to "idPackageSignature"</dd></dl> +</li> +</ul> +<a name="setPackageSignatureId(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPackageSignatureId</h4> +<pre>public void setPackageSignatureId(java.lang.String packageSignatureId)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>packageSignatureId</code> - The signature Id attribute value used to create the XML signature. + A <code>null</code> value will trigger an automatically generated signature Id.</dd></dl> +</li> +</ul> +<a name="getTspUrl()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTspUrl</h4> +<pre>public java.lang.String getTspUrl()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the url of the timestamp provider (TSP)</dd></dl> +</li> +</ul> +<a name="setTspUrl(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTspUrl</h4> +<pre>public void setTspUrl(java.lang.String tspUrl)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tspUrl</code> - the url of the timestamp provider (TSP)</dd></dl> +</li> +</ul> +<a name="isTspOldProtocol()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isTspOldProtocol</h4> +<pre>public boolean isTspOldProtocol()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>if true, uses timestamp-request/response mimetype, + if false, timestamp-query/reply mimetype</dd></dl> +</li> +</ul> +<a name="setTspOldProtocol(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTspOldProtocol</h4> +<pre>public void setTspOldProtocol(boolean tspOldProtocol)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tspOldProtocol</code> - defines the timestamp-protocol mimetype</dd><dt><span class="strong">See Also:</span></dt><dd><code>#isTspOldProtocol()}</code></dd></dl> +</li> +</ul> +<a name="getTspDigestAlgo()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTspDigestAlgo</h4> +<pre>public <a href="../../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> getTspDigestAlgo()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the hash algorithm to be used for the timestamp entry. + Defaults to the hash algorithm of the main entry</dd></dl> +</li> +</ul> +<a name="setTspDigestAlgo(org.apache.poi.poifs.crypt.HashAlgorithm)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTspDigestAlgo</h4> +<pre>public void setTspDigestAlgo(<a href="../../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> tspDigestAlgo)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tspDigestAlgo</code> - the algorithm to be used for the timestamp entry. + if <code>null</code>, the hash algorithm of the main entry</dd></dl> +</li> +</ul> +<a name="getProxyUrl()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProxyUrl</h4> +<pre>public java.lang.String getProxyUrl()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the proxy url to be used for all communications. + Currently this affects the timestamp service</dd></dl> +</li> +</ul> +<a name="setProxyUrl(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setProxyUrl</h4> +<pre>public void setProxyUrl(java.lang.String proxyUrl)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>proxyUrl</code> - the proxy url to be used for all communications. + Currently this affects the timestamp service</dd></dl> +</li> +</ul> +<a name="getTspService()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTspService</h4> +<pre>public <a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/TimeStampService.html" title="interface in org.apache.poi.poifs.crypt.dsig.services">TimeStampService</a> getTspService()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the timestamp service. Defaults to <a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/TSPTimeStampService.html" title="class in org.apache.poi.poifs.crypt.dsig.services"><code>TSPTimeStampService</code></a></dd></dl> +</li> +</ul> +<a name="setTspService(org.apache.poi.poifs.crypt.dsig.services.TimeStampService)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTspService</h4> +<pre>public void setTspService(<a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/TimeStampService.html" title="interface in org.apache.poi.poifs.crypt.dsig.services">TimeStampService</a> tspService)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tspService</code> - the timestamp service</dd></dl> +</li> +</ul> +<a name="getTspUser()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTspUser</h4> +<pre>public java.lang.String getTspUser()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the user id for the timestamp service - currently only basic authorization is supported</dd></dl> +</li> +</ul> +<a name="setTspUser(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTspUser</h4> +<pre>public void setTspUser(java.lang.String tspUser)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tspUser</code> - the user id for the timestamp service - currently only basic authorization is supported</dd></dl> +</li> +</ul> +<a name="getTspPass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTspPass</h4> +<pre>public java.lang.String getTspPass()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the password for the timestamp service</dd></dl> +</li> +</ul> +<a name="setTspPass(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTspPass</h4> +<pre>public void setTspPass(java.lang.String tspPass)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tspPass</code> - the password for the timestamp service</dd></dl> +</li> +</ul> +<a name="getTspValidator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTspValidator</h4> +<pre>public <a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/TimeStampServiceValidator.html" title="interface in org.apache.poi.poifs.crypt.dsig.services">TimeStampServiceValidator</a> getTspValidator()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the validator for the timestamp service (certificate)</dd></dl> +</li> +</ul> +<a name="setTspValidator(org.apache.poi.poifs.crypt.dsig.services.TimeStampServiceValidator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTspValidator</h4> +<pre>public void setTspValidator(<a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/TimeStampServiceValidator.html" title="interface in org.apache.poi.poifs.crypt.dsig.services">TimeStampServiceValidator</a> tspValidator)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tspValidator</code> - the validator for the timestamp service (certificate)</dd></dl> +</li> +</ul> +<a name="getRevocationDataService()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRevocationDataService</h4> +<pre>public <a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/RevocationDataService.html" title="interface in org.apache.poi.poifs.crypt.dsig.services">RevocationDataService</a> getRevocationDataService()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the optional revocation data service used for XAdES-C and XAdES-X-L. + When <code>null</code> the signature will be limited to XAdES-T only.</dd></dl> +</li> +</ul> +<a name="setRevocationDataService(org.apache.poi.poifs.crypt.dsig.services.RevocationDataService)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRevocationDataService</h4> +<pre>public void setRevocationDataService(<a href="../../../../../../org/apache/poi/poifs/crypt/dsig/services/RevocationDataService.html" title="interface in org.apache.poi.poifs.crypt.dsig.services">RevocationDataService</a> revocationDataService)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>revocationDataService</code> - the optional revocation data service used for XAdES-C and XAdES-X-L. + When <code>null</code> the signature will be limited to XAdES-T only.</dd></dl> +</li> +</ul> +<a name="getXadesDigestAlgo()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getXadesDigestAlgo</h4> +<pre>public <a href="../../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> getXadesDigestAlgo()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>hash algorithm used for XAdES. Defaults to the <a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getDigestAlgo()"><code>getDigestAlgo()</code></a></dd></dl> +</li> +</ul> +<a name="setXadesDigestAlgo(org.apache.poi.poifs.crypt.HashAlgorithm)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setXadesDigestAlgo</h4> +<pre>public void setXadesDigestAlgo(<a href="../../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> xadesDigestAlgo)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xadesDigestAlgo</code> - hash algorithm used for XAdES. + When <code>null</code>, defaults to <a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.html#getDigestAlgo()"><code>getDigestAlgo()</code></a></dd></dl> +</li> +</ul> +<a name="getUserAgent()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUserAgent</h4> +<pre>public java.lang.String getUserAgent()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the user agent used for http communication (e.g. to the TSP)</dd></dl> +</li> +</ul> +<a name="setUserAgent(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setUserAgent</h4> +<pre>public void setUserAgent(java.lang.String userAgent)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>userAgent</code> - the user agent used for http communication (e.g. to the TSP)</dd></dl> +</li> +</ul> +<a name="getTspRequestPolicy()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTspRequestPolicy</h4> +<pre>public java.lang.String getTspRequestPolicy()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the asn.1 object id for the tsp request policy. + Defaults to <code>1.3.6.1.4.1.13762.3</code></dd></dl> +</li> +</ul> +<a name="setTspRequestPolicy(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTspRequestPolicy</h4> +<pre>public void setTspRequestPolicy(java.lang.String tspRequestPolicy)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tspRequestPolicy</code> - the asn.1 object id for the tsp request policy.</dd></dl> +</li> +</ul> +<a name="isIncludeEntireCertificateChain()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIncludeEntireCertificateChain</h4> +<pre>public boolean isIncludeEntireCertificateChain()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true, if the whole certificate chain is included in the signature. + When false, only the signer cert will be included</dd></dl> +</li> +</ul> +<a name="setIncludeEntireCertificateChain(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIncludeEntireCertificateChain</h4> +<pre>public void setIncludeEntireCertificateChain(boolean includeEntireCertificateChain)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>includeEntireCertificateChain</code> - if true, include the whole certificate chain. + If false, only include the signer cert</dd></dl> +</li> +</ul> +<a name="isIncludeIssuerSerial()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIncludeIssuerSerial</h4> +<pre>public boolean isIncludeIssuerSerial()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>if true, issuer serial number is included</dd></dl> +</li> +</ul> +<a name="setIncludeIssuerSerial(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIncludeIssuerSerial</h4> +<pre>public void setIncludeIssuerSerial(boolean includeIssuerSerial)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>includeIssuerSerial</code> - if true, issuer serial number is included</dd></dl> +</li> +</ul> +<a name="isIncludeKeyValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIncludeKeyValue</h4> +<pre>public boolean isIncludeKeyValue()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>if true, the key value of the public key (certificate) is included</dd></dl> +</li> +</ul> +<a name="setIncludeKeyValue(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIncludeKeyValue</h4> +<pre>public void setIncludeKeyValue(boolean includeKeyValue)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>includeKeyValue</code> - if true, the key value of the public key (certificate) is included</dd></dl> +</li> +</ul> +<a name="getXadesRole()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getXadesRole</h4> +<pre>public java.lang.String getXadesRole()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the xades role element. If <code>null</code> the claimed role element is omitted. + Defaults to <code>null</code></dd></dl> +</li> +</ul> +<a name="setXadesRole(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setXadesRole</h4> +<pre>public void setXadesRole(java.lang.String xadesRole)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xadesRole</code> - the xades role element. If <code>null</code> the claimed role element is omitted.</dd></dl> +</li> +</ul> +<a name="getXadesSignatureId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getXadesSignatureId</h4> +<pre>public java.lang.String getXadesSignatureId()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the Id for the XAdES SignedProperties element. + Defaults to <code>idSignedProperties</code></dd></dl> +</li> +</ul> +<a name="setXadesSignatureId(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setXadesSignatureId</h4> +<pre>public void setXadesSignatureId(java.lang.String xadesSignatureId)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xadesSignatureId</code> - the Id for the XAdES SignedProperties element. + When <code>null</code> defaults to <code>idSignedProperties</code></dd></dl> +</li> +</ul> +<a name="isXadesSignaturePolicyImplied()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isXadesSignaturePolicyImplied</h4> +<pre>public boolean isXadesSignaturePolicyImplied()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>when true, include the policy-implied block. + Defaults to <code>true</code></dd></dl> +</li> +</ul> +<a name="setXadesSignaturePolicyImplied(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setXadesSignaturePolicyImplied</h4> +<pre>public void setXadesSignaturePolicyImplied(boolean xadesSignaturePolicyImplied)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xadesSignaturePolicyImplied</code> - when true, include the policy-implied block</dd></dl> +</li> +</ul> +<a name="isXadesIssuerNameNoReverseOrder()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isXadesIssuerNameNoReverseOrder</h4> +<pre>public boolean isXadesIssuerNameNoReverseOrder()</pre> +<div class="block">Make sure the DN is encoded using the same order as present + within the certificate. This is an Office2010 work-around. + Should be reverted back. + + XXX: not correct according to RFC 4514.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>when true, the issuer DN is used instead of the issuer X500 principal</dd></dl> +</li> +</ul> +<a name="setXadesIssuerNameNoReverseOrder(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setXadesIssuerNameNoReverseOrder</h4> +<pre>public void setXadesIssuerNameNoReverseOrder(boolean xadesIssuerNameNoReverseOrder)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xadesIssuerNameNoReverseOrder</code> - when true, the issuer DN instead of the issuer X500 prinicpal is used</dd></dl> +</li> +</ul> +<a name="getSignatureMarshalListener()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSignatureMarshalListener</h4> +<pre>public org.w3c.dom.events.EventListener getSignatureMarshalListener()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the event listener which is active while xml structure for + the signature is created. + Defaults to <a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureMarshalListener.html" title="class in org.apache.poi.poifs.crypt.dsig"><code>SignatureMarshalListener</code></a></dd></dl> +</li> +</ul> +<a name="setSignatureMarshalListener(org.w3c.dom.events.EventListener)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSignatureMarshalListener</h4> +<pre>public void setSignatureMarshalListener(org.w3c.dom.events.EventListener signatureMarshalListener)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>signatureMarshalListener</code> - the event listener watching the xml structure + generation for the signature</dd></dl> +</li> +</ul> +<a name="getNamespacePrefixes()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNamespacePrefixes</h4> +<pre>public java.util.Map<java.lang.String,java.lang.String> getNamespacePrefixes()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the map of namespace uri (key) to prefix (value)</dd></dl> +</li> +</ul> +<a name="setNamespacePrefixes(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setNamespacePrefixes</h4> +<pre>public void setNamespacePrefixes(java.util.Map<java.lang.String,java.lang.String> namespacePrefixes)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>namespacePrefixes</code> - the map of namespace uri (key) to prefix (value)</dd></dl> +</li> +</ul> +<a name="nvl(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="nvl(T, T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nvl</h4> +<pre>protected static <T> T nvl(T value, + T defaultValue)</pre> +<div class="block">helper method for null/default value handling</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - </dd><dd><code>defaultValue</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>if value is not null, return value otherwise defaultValue</dd></dl> +</li> +</ul> +<a name="getHashMagic()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHashMagic</h4> +<pre>public byte[] getHashMagic()</pre> +<div class="block">Each digest method has its own IV (initial vector)</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the IV depending on the main digest method</dd></dl> +</li> +</ul> +<a name="getSignatureMethodUri()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSignatureMethodUri</h4> +<pre>public java.lang.String getSignatureMethodUri()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the uri for the signature method, i.e. currently only rsa is + supported, so it's the rsa variant of the main digest</dd></dl> +</li> +</ul> +<a name="getDigestMethodUri()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDigestMethodUri</h4> +<pre>public java.lang.String getDigestMethodUri()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the uri for the main digest</dd></dl> +</li> +</ul> +<a name="getDigestMethodUri(org.apache.poi.poifs.crypt.HashAlgorithm)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDigestMethodUri</h4> +<pre>public static java.lang.String getDigestMethodUri(<a href="../../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a> digestAlgo)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>digestAlgo</code> - the digest algo, currently only sha* and ripemd160 is supported</dd> +<dt><span class="strong">Returns:</span></dt><dd>the uri for the given digest</dd></dl> +</li> +</ul> +<a name="setSignatureFactory(javax.xml.crypto.dsig.XMLSignatureFactory)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSignatureFactory</h4> +<pre>public void setSignatureFactory(javax.xml.crypto.dsig.XMLSignatureFactory signatureFactory)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>signatureFactory</code> - the xml signature factory, saved as thread-local</dd></dl> +</li> +</ul> +<a name="getSignatureFactory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSignatureFactory</h4> +<pre>public javax.xml.crypto.dsig.XMLSignatureFactory getSignatureFactory()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the xml signature factory (thread-local)</dd></dl> +</li> +</ul> +<a name="setKeyInfoFactory(javax.xml.crypto.dsig.keyinfo.KeyInfoFactory)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setKeyInfoFactory</h4> +<pre>public void setKeyInfoFactory(javax.xml.crypto.dsig.keyinfo.KeyInfoFactory keyInfoFactory)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>keyInfoFactory</code> - the key factory, saved as thread-local</dd></dl> +</li> +</ul> +<a name="getKeyInfoFactory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKeyInfoFactory</h4> +<pre>public javax.xml.crypto.dsig.keyinfo.KeyInfoFactory getKeyInfoFactory()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the key factory (thread-local)</dd></dl> +</li> +</ul> +<a name="getProvider()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProvider</h4> +<pre>public java.security.Provider getProvider()</pre> +<div class="block">This method tests the existence of xml signature provider in the following order: + <ul> + <li>the class pointed to by the system property "jsr105Provider"</li> + <li>the Santuario xmlsec provider</li> + <li>the JDK xmlsec provider</li> + </ul> + + For signing the classes are linked against the Santuario xmlsec, so this might + only work for validation (not tested).</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the xml dsig provider</dd></dl> +</li> +</ul> +<a name="getXadesCanonicalizationMethod()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getXadesCanonicalizationMethod</h4> +<pre>public java.lang.String getXadesCanonicalizationMethod()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the cannonicalization method for XAdES-XL signing. + Defaults to <code>EXCLUSIVE</code></dd><dt><span class="strong">See Also:</span></dt><dd><code>CanonicalizationMethod}</code></dd></dl> +</li> +</ul> +<a name="setXadesCanonicalizationMethod(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setXadesCanonicalizationMethod</h4> +<pre>public void setXadesCanonicalizationMethod(java.lang.String xadesCanonicalizationMethod)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xadesCanonicalizationMethod</code> - the cannonicalization method for XAdES-XL signing</dd><dt><span class="strong">See Also:</span></dt><dd><code>CanonicalizationMethod}</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/SignatureConfig.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> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/RevokedCertificateSecurityException.html" title="class in org.apache.poi.poifs.crypt.dsig"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureConfig.SignatureConfigurable.html" title="interface in org.apache.poi.poifs.crypt.dsig"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/poifs/crypt/dsig/SignatureConfig.html" target="_top">Frames</a></li> +<li><a href="SignatureConfig.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><a href="#nested_class_summary">Nested</a> | </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 ======= --> +<p class="legalCopy"><small> + <i>Copyright 2014 The Apache Software Foundation or + its licensors, as applicable.</i> + </small></p> +</body> +</html>
Added: poi/site/publish/apidocs/org/apache/poi/poifs/crypt/dsig/SignatureInfo.SignaturePart.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/poifs/crypt/dsig/SignatureInfo.SignaturePart.html?rev=1631441&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/poifs/crypt/dsig/SignatureInfo.SignaturePart.html (added) +++ poi/site/publish/apidocs/org/apache/poi/poifs/crypt/dsig/SignatureInfo.SignaturePart.html Mon Oct 13 15:44:30 2014 @@ -0,0 +1,293 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>SignatureInfo.SignaturePart (POI API Documentation)</title> +<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="SignatureInfo.SignaturePart (POI API Documentation)"; + } +//--> +</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/SignatureInfo.SignaturePart.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> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureInfo.html" title="class in org.apache.poi.poifs.crypt.dsig"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureMarshalListener.html" title="class in org.apache.poi.poifs.crypt.dsig"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/poifs/crypt/dsig/SignatureInfo.SignaturePart.html" target="_top">Frames</a></li> +<li><a href="SignatureInfo.SignaturePart.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">org.apache.poi.poifs.crypt.dsig</div> +<h2 title="Class SignatureInfo.SignaturePart" class="title">Class SignatureInfo.SignaturePart</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.poi.poifs.crypt.dsig.SignatureInfo.SignaturePart</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureInfo.html" title="class in org.apache.poi.poifs.crypt.dsig">SignatureInfo</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">SignatureInfo.SignaturePart</span> +extends java.lang.Object</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>java.util.List<java.security.cert.X509Certificate></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureInfo.SignaturePart.html#getCertChain()">getCertChain</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/openxml4j/opc/PackagePart.html" title="class in org.apache.poi.openxml4j.opc">PackagePart</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureInfo.SignaturePart.html#getPackagePart()">getPackagePart</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>SignatureDocument</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureInfo.SignaturePart.html#getSignatureDocument()">getSignatureDocument</a></strong>()</code> +<div class="block">Helper method for examining the xml signature</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.security.cert.X509Certificate</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureInfo.SignaturePart.html#getSigner()">getSigner</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureInfo.SignaturePart.html#validate()">validate</a></strong>()</code> </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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getPackagePart()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPackagePart</h4> +<pre>public <a href="../../../../../../org/apache/poi/openxml4j/opc/PackagePart.html" title="class in org.apache.poi.openxml4j.opc">PackagePart</a> getPackagePart()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the package part containing the signature</dd></dl> +</li> +</ul> +<a name="getSigner()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSigner</h4> +<pre>public java.security.cert.X509Certificate getSigner()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the signer certificate</dd></dl> +</li> +</ul> +<a name="getCertChain()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCertChain</h4> +<pre>public java.util.List<java.security.cert.X509Certificate> getCertChain()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the certificate chain of the signer</dd></dl> +</li> +</ul> +<a name="getSignatureDocument()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSignatureDocument</h4> +<pre>public SignatureDocument getSignatureDocument() + throws java.io.IOException, + org.apache.xmlbeans.XmlException</pre> +<div class="block">Helper method for examining the xml signature</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the xml signature document</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if the xml signature doesn't exist or can't be read</dd> +<dd><code>org.apache.xmlbeans.XmlException</code> - if the xml signature is malformed</dd></dl> +</li> +</ul> +<a name="validate()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>validate</h4> +<pre>public boolean validate()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true, when the xml signature is valid, false otherwise</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/SignatureInfo.SignaturePart.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> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureInfo.html" title="class in org.apache.poi.poifs.crypt.dsig"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/poi/poifs/crypt/dsig/SignatureMarshalListener.html" title="class in org.apache.poi.poifs.crypt.dsig"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/poifs/crypt/dsig/SignatureInfo.SignaturePart.html" target="_top">Frames</a></li> +<li><a href="SignatureInfo.SignaturePart.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 ======= --> +<p class="legalCopy"><small> + <i>Copyright 2014 The Apache Software Foundation or + its licensors, as applicable.</i> + </small></p> +</body> +</html> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
