Author: fanningpj
Date: Thu Nov 11 19:16:56 2021
New Revision: 1894957
URL: http://svn.apache.org/viewvc?rev=1894957&view=rev
Log:
update docs to remove jcl logging references
Modified:
poi/site/src/documentation/content/xdocs/components/index.xml
poi/site/src/documentation/content/xdocs/encryption.xml
Modified: poi/site/src/documentation/content/xdocs/components/index.xml
URL:
http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/index.xml?rev=1894957&r1=1894956&r2=1894957&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/index.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/index.xml Thu Nov 11
19:16:56 2021
@@ -291,7 +291,7 @@
</tr>
<tr>
<td>poi</td>
- <td><a
href="https://search.maven.org/#artifactdetails|org.slf4j|jcl-over-slf4j|1.7.32|jar">jcl-over-slf4j
(commons-logging replacement)</a>,
+ <td><a
href="https://search.maven.org/#artifactdetails|org.apache.logging.log4j|log4j-api|2.14.1|jar">log4j
2.x</a>,
<a
href="https://search.maven.org/#artifactdetails|commons-codec|commons-codec|1.15|jar">commons-codec</a>,
<a
href="https://search.maven.org/#artifactdetails|org.apache.commons|commons-collections4|4.4|jar">commons-collections</a>,
<a
href="https://search.maven.org/#artifactdetails|org.apache.commons|commons-math3|3.6.1|jar">commons-math3</a>
Modified: poi/site/src/documentation/content/xdocs/encryption.xml
URL:
http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/encryption.xml?rev=1894957&r1=1894956&r2=1894957&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/encryption.xml (original)
+++ poi/site/src/documentation/content/xdocs/encryption.xml Thu Nov 11 19:16:56
2021
@@ -374,54 +374,25 @@
<section>
<title>Debugging XML signature issues</title>
<p>Finding the source of a XML signature problem can be sometimes a
pain in the ... neck, because
- the hashing of the canonicalized form is more or less intransparent
done in the background.</p>
+ the hashing of the canonicalized form is more or less done in the
background.</p>
<!-- TODO: find original source -->
<p>One of the tripping hazards are <a
href="https://stackoverflow.com/questions/36063375">different
linebreaks in Windows/Unix</a>, therefore use the non-indent form of
the xmls. Furthermore the
- elements/anchestors containing namespace definitions and the used
prefix might also differ.</p>
+ elements/ancestors containing namespace definitions and the used
prefix might also differ.</p>
<p>The next thing is to compare successful signed documents from
Office vs. POIs generated signature,
i.e. unzip both files and look for differences. Usually the package
relations (*.rels) will be different,
and the sig1.xml, core.xml and [Content_Types].xml due to different
order of the references.</p>
- <p>The package relationsships (*.rels) will be specially handled, i.e.
they will be filtered and only
+ <p>The package relationships (*.rels) will be specially handled, i.e.
they will be filtered and only
a subset will be processed - see <a
href="https://www.ecma-international.org/activities/Office%20Open%20XML%20Formats/Draft%20ECMA-376%203rd%20edition,%20March%202011/Office%20Open%20XML%20Part%202%20-%20Open%20Packaging%20Conventions.pdf">13.2.4.24
Relationships Transform Algorithm</a>.</p>
- <p>POI and Santuario (XmlSec) use <a
href="http://www.slf4j.org/">SLF4J</a> for logging.
- To get logging information and debug output ...:</p>
+ <p>POI and Santuario (XmlSec) use <a
href="https://logging.apache.org/log4j/2.x">Log4J 2.x</a> and
+ <a href="http://www.slf4j.org/">SLF4J</a> respectively for
logging.</p>
<ul>
<li>
- add the following JVM parameters:
- <source><![CDATA[
- -Djava.io.tmpdir=<custom temp directory>
- -Xbootclasspath/p:<preload dir, which contains
/org/apache/xml/security/utils/UnsyncBufferedOutputStream.class>
-
-Dorg.apache.poi.util.POILogger=org.apache.poi.util.CommonsLogger
- ]]></source>
- </li>
- <li>
- replace commons-logging.jar with <a
href="https://search.maven.org/artifact/org.slf4j/jcl-over-slf4j/1.7.32/jar">jcl-over-slf4j.jar</a>
- </li>
- <li>
- beside log4j.jar, add <a
href="https://search.maven.org/artifact/org.slf4j/slf4j-log4j12/1.7.32/jar">slf4j-log4j12.jar</a>
- </li>
- <li>
- add a log4j.properties into the path with the following
content:
- <source><![CDATA[
- log4j.rootLogger=ALL,FILE
-
- # Define the file appender
- log4j.appender.FILE=org.apache.log4j.FileAppender
- log4j.appender.FILE.File=debug.log
- log4j.appender.FILE.ImmediateFlush=true
- log4j.appender.FILE.Threshold=debug
- log4j.appender.FILE.Append=false
- log4j.appender.FILE.layout=org.apache.log4j.PatternLayout
- log4j.appender.FILE.layout.conversionPattern=%-5p %c %x -
%m%n
- ]]></source>
- </li>
- <li>
To check the processed files in the canonicalized form, the
below UnsyncBufferedOutputStream class needs
to be injected/replaced. Put the .class file in separate
directory and add it to the JVM parameters (see above):
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]