doc/site/src/documentation/content/xdocs/Java/installation.xml - santuario-xml-security-java - Git at Google

 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd"
 [
   <!ENTITY % xmlsec_entities SYSTEM "../xmlsec_entities.ent">
   %xmlsec_entities;
 ]>
 <!--
 Copyright 2003-2004 The Apache Software Foundation

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 -->

 <document>
   <header>
     <title>Installation - Java</title>
   </header>
   <body>
     <section>
       <title>Using JDK 1.4.0</title>
       <p>
 	After SUN released the
 	<jump href="ext:java">
 	  Java (TM) 2 Platform Standard Edition v1.4.0
 	</jump>, the xml-security package stopped working. This is a
 	<jump href="http://developer.java.sun.com/developer/bugParade/bugs/4615582.html">
 	  known
 	</jump>
 	problem: SUN packaged a beta of Xalan into the JDK 1.4.0, but the
 	xml-security package requires a stable version of Xalan (v2.2.0 or
 	later). To fix the problem, you have to put the xalan.jar into a
 	special directory in your JDK:
 	<code>j2sdk1.4.0/jre/lib/endorsed/xalan.jar</code> . If you installed
 	an out-of-the-box JDK1.4 (e.g. on Windows 2000), the "endorsed"
 	directory does not exist: you'll have to create it by hand.
       </p>
       <warning>
 	Putting this JAR to another location like <code>lib/ext</code> WILL
 	NOT WORK.
       </warning>
       <p>
 	For more on that, you can also check the
 	<jump href="http://xml.apache.org/~edwingo/jaxp-faq.html#override">
 	  Unofficial JAXP FAQ
 	</jump>.
       </p>
     </section>

     <section>
       <title>Prerequisites</title>
       <p>
 	Make sure you get the Jakarta Ant Tool from
 	<jump href="ext:ant">http://jakarta.apache.org/ant/</jump>
       </p>
     </section>

     <section>
       <title>Getting the source</title>
       <p>
 	You can download the sources via WWW from the download page
 	at
 	<jump href="site:about/download">
 	  http://xml.apache.org/security/download.html
 	</jump>
       </p>
       <p>
 	This project's CVS repository can be checked out through anonymous
 	(pserver) CVS with the following instruction set. The module you wish
 	to check out must be specified as the modulename. When prompted for a
 	password for anonymous, simply enter "anoncvs" without quotes:
       </p>
       <source>cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic login
 	password: anoncvs
 	cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic checkout
 	xml-security
       </source>
       <p>
 	A HTTP interface to browse the sources online is available via
 	<jump href="site:getting-involved/CVS">http://cvs.apache.org/viewcvs.cgi/xml-security/</jump>
       </p>
     </section>

     <section>
       <title>Compiling the source</title>
       <p>
 	At the command prompt type <code>ant test</code>. If you want to
 	use jikes instead of your default java compiler locate the <code>build.xml</code>
 	file and replace the line
       </p>
       <source>&lt;property name="build.compiler" value="classic"/&gt;</source>
       <p>
 	with
       </p>
       <source>&lt;property name="build.compiler" value="jikes"/&gt;</source>
     </section>

 <!-- Uncommented in the original docs
     <section>
       <title>Unpacking the files</title>
       <p>
 	&packagename; is packaged as a ZIP file for all
 	platforms and operating systems.  You can run the Java
 	<ref>jar</ref> command to unpack the distribution.
       </p>
       <ul>
 	<li>jar xf &packagename;-bin.&packageversion;.zip</li>
 	<li>jar xf &packagename;-src.&packageversion;.zip</li>
 	<li>This command creates a "&packagedirectory;" sub-directory in the
 	  current directory containing all the files.</li>
       </ul>
     </section>

     <section>
       <title>Files in the binary package release</title>
       <table>
 	<tr><td>LICENSE</td><td>License for &packagename;</td></tr>
 	<tr><td>Readme.html</td><td>Web page redirect to docs/html/index.html</td></tr>
 	<tr><td>xerces.jar</td><td>Jar file containing all the parser class files</td></tr>
 	<tr><td>xercesSamples.jar</td><td>Jar file containing all sample class files</td></tr>
 	<tr><td>data/</td><td>Directory containing sample XML data files</td></tr>
 	<tr><td>doc/html/</td><td>Directory containing documentation</td></tr>
 	<tr><td>doc/html/api/</td><td>Directory containing Javadoc API</td></tr>
       </table>
       <note>To use &packagename; you do not need the source files.</note>
     </section>
 -->
     <section>
       <title>Testing the distibution</title>
       <p>
 	The first way to ensure that everything is in place is to run the unit
 	tests. This is simply done by typing <code>ant test</code>. This starts
 	the included JUnit test cases. Actually, we do not have complete test
 	coverage, but as a first start, it works.
       </p>
     </section>

     <section>
       <title>Playing around with the examples </title>
       <p>
 	To see how the distribution works, simply run <code>ant
 	  mega-sample</code> to let ant execute several examples from the
 	<code>src_samples/</code> directory.
       </p>
     </section>
     <section>
       <title>Files in the source package release</title>
       <table>
 	<tr>
 	  <td>build.xml</td>
 	  <td>Top level <jump href="ext:ant">Ant</jump> Makefile -- read README
 	    file before building</td>
 	</tr>
 	<tr>
 	  <td>LICENSE.txt</td>
 	  <td>License for the software</td>
 	</tr>
 	<tr>
 	  <td>README</td>
 	  <td>Build instructions</td>
 	</tr>
 	<tr>
 	  <td>Readme.html</td>
 	  <td>Web page redirect required for building documentation</td>
 	</tr>
 	<tr>
 	  <td>STATUS</td>
 	  <td>Current source code status information</td>
 	</tr>
 	<tr>
 	  <td>data/</td>
 	  <td>Directory containing sample data files and test vectors for the unit tests</td>
 	</tr>
 	<tr>
 	  <td>doc/xml/</td>
 	  <td>Directory containing documentation, in XML form</td>
 	</tr>
 	<tr>
 	  <td>src/</td>
 	  <td>Directory containing source code for the core library</td>
 	</tr>
 	<tr>
 	  <td>src_samples/</td>
 	  <td>Directory containing source code for samples</td>
 	</tr>
 	<tr>
 	  <td>src_unitTests/</td>
 	  <td>Directory containing source code for unit tests</td>
 	</tr>
       </table>
     </section>

     <section>
       <title>Where is my JCE?</title>
       <p>
 	There is <em>no</em> JCE bundled together with this
 	distribution. Living in Germany, I had no problem to include the JCE in
 	this software package but then I realized that the Apache Project is
 	hosted in the US where some export restrictions apply to the
 	cryptographic primitives.
       </p>
       <p>
 	Well, how do we solve this problem? The nice guys from the <jump
 	  href="ext:bouncy">Bouncy Castle</jump> where so
 	helpful to supply the JAR that you need to create HMAC integrity checks
 	on their web site. When you use the ant makefile <code>build.xml</code>
 	and simply say <code>ant compile</code> or <code>ant get-jce</code>,
 	<code>ant</code> tries to fetch this JAR from the australian
 	server. After that step, the compilation works completely.
       </p>
       <p/>
       <p>
 	The ant make tools initiates an automated download of the BouncyCastle
 	JCE. The file is downloaded into the libs/ directory and a "bc-" is
 	prepended to the filename. This is done because we want the provider
 	name (bc means BouncyCastle) being visible in the JAR's filename.
       </p>
       <p/>
       <p>
 	If you are a little paranoid like all security people and don't want
 	ant to make automated downloads or your firewall doesn't permit it
 	(preventing programs "phoning home"), look in the
 	<code>./build.xml</code> file for the properties called
       </p>
       <p/>
       <source><![CDATA[
 	<property name="jce.download.file" value="]]>&jce_download_file;<![CDATA[ />
 	<property name="jce.download"
 	          value="http://www.bouncycastle.org/download/${jce.download.file}" />
 	<property name="lib.jce" value="${libs}/bc-${jce.download.file}" />
 	]]></source>
       <p>
 	Here you can see that the file
 	<jump href="ext:java/jce/download/file">&jce_download_file;</jump>
 	 is downloaded and stored in the location <code>&lib_jce;</code>
       </p>
       <p>
 	If you do this by hand (pointing you favourite web browser and download
 	it yourself), simply put a "<code>bc-</code>" in front of the filename
 	and put it to <code>./libs/</code>, then ant won't try to make a
 	download.
       </p>
     </section>
   </body>
 </document>
	<?xml version="1.0" encoding="UTF-8"?>
	<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd"
	[
	<!ENTITY % xmlsec_entities SYSTEM "../xmlsec_entities.ent">
	%xmlsec_entities;
	]>
	<!--
	Copyright 2003-2004 The Apache Software Foundation

	Licensed under the Apache License, Version 2.0 (the "License");
	you may not use this file except in compliance with the License.
	You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
	-->

	<document>
	<header>
	<title>Installation - Java</title>
	</header>
	<body>
	<section>
	<title>Using JDK 1.4.0</title>
	<p>
	After SUN released the
	<jump href="ext:java">
	Java (TM) 2 Platform Standard Edition v1.4.0
	</jump>, the xml-security package stopped working. This is a
	<jump href="http://developer.java.sun.com/developer/bugParade/bugs/4615582.html">
	known
	</jump>
	problem: SUN packaged a beta of Xalan into the JDK 1.4.0, but the
	xml-security package requires a stable version of Xalan (v2.2.0 or
	later). To fix the problem, you have to put the xalan.jar into a
	special directory in your JDK:
	<code>j2sdk1.4.0/jre/lib/endorsed/xalan.jar</code> . If you installed
	an out-of-the-box JDK1.4 (e.g. on Windows 2000), the "endorsed"
	directory does not exist: you'll have to create it by hand.
	</p>
	<warning>
	Putting this JAR to another location like <code>lib/ext</code> WILL
	NOT WORK.
	</warning>
	<p>
	For more on that, you can also check the
	<jump href="http://xml.apache.org/~edwingo/jaxp-faq.html#override">
	Unofficial JAXP FAQ
	</jump>.
	</p>
	</section>

	<section>
	<title>Prerequisites</title>
	<p>
	Make sure you get the Jakarta Ant Tool from
	<jump href="ext:ant">http://jakarta.apache.org/ant/</jump>
	</p>
	</section>

	<section>
	<title>Getting the source</title>
	<p>
	You can download the sources via WWW from the download page
	at
	<jump href="site:about/download">
	http://xml.apache.org/security/download.html
	</jump>
	</p>
	<p>
	This project's CVS repository can be checked out through anonymous
	(pserver) CVS with the following instruction set. The module you wish
	to check out must be specified as the modulename. When prompted for a
	password for anonymous, simply enter "anoncvs" without quotes:
	</p>
	<source>cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic login
	password: anoncvs
	cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic checkout
	xml-security
	</source>
	<p>
	A HTTP interface to browse the sources online is available via
	<jump href="site:getting-involved/CVS">http://cvs.apache.org/viewcvs.cgi/xml-security/</jump>
	</p>
	</section>

	<section>
	<title>Compiling the source</title>
	<p>
	At the command prompt type <code>ant test</code>. If you want to
	use jikes instead of your default java compiler locate the <code>build.xml</code>
	file and replace the line
	</p>
	<source><property name="build.compiler" value="classic"/></source>
	<p>
	with
	</p>
	<source><property name="build.compiler" value="jikes"/></source>
	</section>

	<!-- Uncommented in the original docs
	<section>
	<title>Unpacking the files</title>
	<p>
	&packagename; is packaged as a ZIP file for all
	platforms and operating systems. You can run the Java
	<ref>jar</ref> command to unpack the distribution.
	</p>
	<ul>
	<li>jar xf &packagename;-bin.&packageversion;.zip</li>
	<li>jar xf &packagename;-src.&packageversion;.zip</li>
	<li>This command creates a "&packagedirectory;" sub-directory in the
	current directory containing all the files.</li>
	</ul>
	</section>

	<section>
	<title>Files in the binary package release</title>
	<table>
	<tr><td>LICENSE</td><td>License for &packagename;</td></tr>
	<tr><td>Readme.html</td><td>Web page redirect to docs/html/index.html</td></tr>
	<tr><td>xerces.jar</td><td>Jar file containing all the parser class files</td></tr>
	<tr><td>xercesSamples.jar</td><td>Jar file containing all sample class files</td></tr>
	<tr><td>data/</td><td>Directory containing sample XML data files</td></tr>
	<tr><td>doc/html/</td><td>Directory containing documentation</td></tr>
	<tr><td>doc/html/api/</td><td>Directory containing Javadoc API</td></tr>
	</table>
	<note>To use &packagename; you do not need the source files.</note>
	</section>
	-->
	<section>
	<title>Testing the distibution</title>
	<p>
	The first way to ensure that everything is in place is to run the unit
	tests. This is simply done by typing <code>ant test</code>. This starts
	the included JUnit test cases. Actually, we do not have complete test
	coverage, but as a first start, it works.
	</p>
	</section>

	<section>
	<title>Playing around with the examples </title>
	<p>
	To see how the distribution works, simply run <code>ant
	mega-sample</code> to let ant execute several examples from the
	<code>src_samples/</code> directory.
	</p>
	</section>
	<section>
	<title>Files in the source package release</title>
	<table>
	<tr>
	<td>build.xml</td>
	<td>Top level <jump href="ext:ant">Ant</jump> Makefile -- read README
	file before building</td>
	</tr>
	<tr>
	<td>LICENSE.txt</td>
	<td>License for the software</td>
	</tr>
	<tr>
	<td>README</td>
	<td>Build instructions</td>
	</tr>
	<tr>
	<td>Readme.html</td>
	<td>Web page redirect required for building documentation</td>
	</tr>
	<tr>
	<td>STATUS</td>
	<td>Current source code status information</td>
	</tr>
	<tr>
	<td>data/</td>
	<td>Directory containing sample data files and test vectors for the unit tests</td>
	</tr>
	<tr>
	<td>doc/xml/</td>
	<td>Directory containing documentation, in XML form</td>
	</tr>
	<tr>
	<td>src/</td>
	<td>Directory containing source code for the core library</td>
	</tr>
	<tr>
	<td>src_samples/</td>
	<td>Directory containing source code for samples</td>
	</tr>
	<tr>
	<td>src_unitTests/</td>
	<td>Directory containing source code for unit tests</td>
	</tr>
	</table>
	</section>

	<section>
	<title>Where is my JCE?</title>
	<p>
	There is <em>no</em> JCE bundled together with this
	distribution. Living in Germany, I had no problem to include the JCE in
	this software package but then I realized that the Apache Project is
	hosted in the US where some export restrictions apply to the
	cryptographic primitives.
	</p>
	<p>
	Well, how do we solve this problem? The nice guys from the <jump
	href="ext:bouncy">Bouncy Castle</jump> where so
	helpful to supply the JAR that you need to create HMAC integrity checks
	on their web site. When you use the ant makefile <code>build.xml</code>
	and simply say <code>ant compile</code> or <code>ant get-jce</code>,
	<code>ant</code> tries to fetch this JAR from the australian
	server. After that step, the compilation works completely.
	</p>
	<p/>
	<p>
	The ant make tools initiates an automated download of the BouncyCastle
	JCE. The file is downloaded into the libs/ directory and a "bc-" is
	prepended to the filename. This is done because we want the provider
	name (bc means BouncyCastle) being visible in the JAR's filename.
	</p>
	<p/>
	<p>
	If you are a little paranoid like all security people and don't want
	ant to make automated downloads or your firewall doesn't permit it
	(preventing programs "phoning home"), look in the
	<code>./build.xml</code> file for the properties called
	</p>
	<p/>
	<source><![CDATA[
	<property name="jce.download.file" value="]]>&jce_download_file;<![CDATA[ />
	<property name="jce.download"
	value="http://www.bouncycastle.org/download/${jce.download.file}" />
	<property name="lib.jce" value="${libs}/bc-${jce.download.file}" />
	]]></source>
	<p>
	Here you can see that the file
	<jump href="ext:java/jce/download/file">&jce_download_file;</jump>
	is downloaded and stored in the location <code>&lib_jce;</code>
	</p>
	<p>
	If you do this by hand (pointing you favourite web browser and download
	it yourself), simply put a "<code>bc-</code>" in front of the filename
	and put it to <code>./libs/</code>, then ant won't try to make a
	download.
	</p>
	</section>
	</body>
	</document>