You are viewing a plain text version of this content. The canonical link for it is here.
Posted to rampart-dev@ws.apache.org by ru...@apache.org on 2008/03/03 12:20:39 UTC
svn commit: r633039 - in
/webservices/rampart/trunk/java/modules/documentation/src/site: site.xml
xdoc/download.xml xdoc/index.xml xdoc/quick-start.xml
Author: ruchithf
Date: Mon Mar 3 03:20:37 2008
New Revision: 633039
URL: http://svn.apache.org/viewvc?rev=633039&view=rev
Log:
fixed a broken link and some formatting
Modified:
webservices/rampart/trunk/java/modules/documentation/src/site/site.xml
webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/download.xml
webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/index.xml
webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/quick-start.xml
Modified: webservices/rampart/trunk/java/modules/documentation/src/site/site.xml
URL: http://svn.apache.org/viewvc/webservices/rampart/trunk/java/modules/documentation/src/site/site.xml?rev=633039&r1=633038&r2=633039&view=diff
==============================================================================
--- webservices/rampart/trunk/java/modules/documentation/src/site/site.xml (original)
+++ webservices/rampart/trunk/java/modules/documentation/src/site/site.xml Mon Mar 3 03:20:37 2008
@@ -20,42 +20,42 @@
<project name="Apache Rampart">
- <bannerLeft>
- <name>Apache Rampart</name>
- <href>ws.apache.org/rampart/</href>
- </bannerLeft>
+ <bannerLeft>
+ <name>Apache Rampart</name>
+ <href>ws.apache.org/rampart/</href>
+ </bannerLeft>
- <skin>
- <groupId>org.apache.maven.skins</groupId>
- <artifactId>maven-default-skin</artifactId>
- <version>1.0</version>
- </skin>
+ <skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-default-skin</artifactId>
+ <version>1.0</version>
+ </skin>
- <publishDate format="dd MMM yyyy"/>
+ <publishDate format="dd MMM yyyy"/>
- <body>
- <links>
- <item name="Apache" href="http://www.apache.org/"/>
- <item name="WebServices" href="http://ws.apache.org/"/>
- </links>
+ <body>
+ <links>
+ <item name="Apache" href="http://www.apache.org/"/>
+ <item name="WebServices" href="http://ws.apache.org/"/>
+ </links>
- <menu name="Apache Rampart">
- <item name="About" href="index.html"/>
- <item name="Downloads">
- <item name="Releases" href="download.html"/>
- <item name="Source Code" href="source-repository.html"/>
- </item>
- <item name="Documentation">
- <item name="Quick Start Guide" href="quick-start.html"/>
- <item name="Rampart Configuration" href="rampartconfig-guide.html"/>
- <item name="Developer Guide" href="developer-guide.html"/>
- </item>
- <item name="Project Information">
- <item name="Mailing Lists" href="mail-lists.html"/>
- <item name="Issue Tracking" href="http://issues.apache.org/jira/browse/Rampart"/>
- <item name="Dependencies" href="dependencies.html"/>
- </item>
- </menu>
-
- </body>
+ <menu name="Apache Rampart">
+ <item name="About" href="index.html"/>
+ <item name="Downloads">
+ <item name="Releases" href="download.html"/>
+ <item name="Source Code" href="source-repository.html"/>
+ </item>
+ <item name="Documentation">
+ <item name="Quick Start Guide" href="quick-start.html"/>
+ <item name="Rampart Configuration" href="rampartconfig-guide.html"/>
+ <item name="Developer Guide" href="developer-guide.html"/>
+ </item>
+ <item name="Project Information">
+ <item name="Mailing Lists" href="mail-lists.html"/>
+ <item name="Issue Tracking" href="http://issues.apache.org/jira/browse/Rampart"/>
+ <item name="Dependencies" href="dependencies.html"/>
+ </item>
+ </menu>
+
+ </body>
</project>
Modified: webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/download.xml
URL: http://svn.apache.org/viewvc/webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/download.xml?rev=633039&r1=633038&r2=633039&view=diff
==============================================================================
--- webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/download.xml (original)
+++ webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/download.xml Mon Mar 3 03:20:37 2008
@@ -19,45 +19,53 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
-<body>
-<h2>Apache Rampart Releases</h2>
-<p>This page provides links to the release versions of Apache Rampart Java.</p>
-<table border="1" style="border-collapse: collapse" width="93%" id=
-"table1">
-<tbody>
-<tr>
-<th>Version</th>
-<th>Date</th>
-<th>Description</th>
-</tr>
-<tr>
-<td><a href=
-"download/1.3/download.cgi"><strong>1.3</strong></a></td>
-<td> </td>
-<td>1.3 Release (Mirrored)</td>
-</tr>
-<tr>
-<td><a href=
-"download/1.2/download.cgi"><strong>1.2</strong></a></td>
-<td> </td>
-<td>1.2 Release (Mirrored)</td>
-</tr>
-<tr>
-<td><a href=
-"download/1.1/download.cgi"><strong>1.1</strong></a></td>
-<td></td>
-<td>1.1 Release (Mirrored)</td>
-</tr>
-</tbody>
-</table>
-<p><strong>Apache Rampart Distributions : <a href=
-"http://people.apache.org/~ruchithf/rampart/SNAPSHOT">Nightly
-builds</a></strong></p>
-<p><strong>Maven Repository: <a href=
-"http://people.apache.org/repo/m2-ibiblio-rsync-repository/">
-Released Apache Rampart jars</a> | <a href=
-"http://people.apache.org/repo/m2-snapshot-repository/">Nightly
-SNAPSHOT</a><a href=
-""></a></strong></p>
-</body>
+ <body>
+ <h2>Apache Rampart Releases</h2>
+ <p>This page provides links to the release versions of Apache Rampart Java.</p>
+ <table border="1" style="border-collapse: collapse" width="93%" id="table1">
+ <tbody>
+ <tr>
+ <th>Version</th>
+ <th>Date</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>
+ <a href="download/1.3/download.cgi">
+ <strong>1.3</strong>
+ </a>
+ </td>
+ <td></td>
+ <td>1.3 Release (Mirrored)</td>
+ </tr>
+ <tr>
+ <td>
+ <a href="download/1.2/download.cgi">
+ <strong>1.2</strong>
+ </a>
+ </td>
+ <td></td>
+ <td>1.2 Release (Mirrored)</td>
+ </tr>
+ <tr>
+ <td>
+ <a href="download/1.1/download.cgi">
+ <strong>1.1</strong>
+ </a>
+ </td>
+ <td></td>
+ <td>1.1 Release (Mirrored)</td>
+ </tr>
+ </tbody>
+ </table>
+ <p>
+ <strong>Apache Rampart Distributions : <a href="http://people.apache.org/~ruchithf/rampart/SNAPSHOT">Nightly builds</a>
+ </strong>
+ </p>
+ <p>
+ <strong>Maven Repository: <a href="http://people.apache.org/repo/m2-ibiblio-rsync-repository/">Released Apache Rampart jars</a> | <a href="http://people.apache.org/repo/m2-snapshot-repository/">Nightly SNAPSHOT</a>
+ <a href=""></a>
+ </strong>
+ </p>
+ </body>
</html>
Modified: webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/index.xml?rev=633039&r1=633038&r2=633039&view=diff
==============================================================================
--- webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/index.xml (original)
+++ webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/index.xml Mon Mar 3 03:20:37 2008
@@ -20,24 +20,24 @@
<document>
- <properties>
- <title>Apache Rampart</title>
- </properties>
+ <properties>
+ <title>Apache Rampart</title>
+ </properties>
-<body>
-
-<section name="Apache Rampart">
-<p>Rampart is the security module of Axis2. It secures SOAP messages
+ <body>
+
+ <section name="Apache Rampart">
+ <p>Rampart is the security module of Axis2. It secures SOAP messages
according to specifications in the WS-Security stack. Rampart implements the
following specifications:</p>
-<ul>
- <li>WS - Security 1.0</li>
- <li>WS - Secure Conversation - February 2005</li>
- <li>WS - Security Policy - 1.1 - July 2005</li>
- <li>WS - Trust - February 2005</li>
- <li>WS - Trust - WS-SX spec - EXPERIMENTAL</li>
-</ul>
-</section>
+ <ul>
+ <li>WS - Security 1.0</li>
+ <li>WS - Secure Conversation - February 2005</li>
+ <li>WS - Security Policy - 1.1 - July 2005</li>
+ <li>WS - Trust - February 2005</li>
+ <li>WS - Trust - WS-SX spec - EXPERIMENTAL</li>
+ </ul>
+ </section>
-</body>
+ </body>
</document>
Modified: webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/quick-start.xml
URL: http://svn.apache.org/viewvc/webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/quick-start.xml?rev=633039&r1=633038&r2=633039&view=diff
==============================================================================
--- webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/quick-start.xml (original)
+++ webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/quick-start.xml Mon Mar 3 03:20:37 2008
@@ -1,55 +1,66 @@
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
- <title>Apache Rampart - Source Repository</title>
- </head>
- <body>
-<h2>Rampart Quick Start Guide</h2>
-
-<h3>Installing Rampart in Axis2</h3>
-<p>Steps to install</p>
-<ol>
-<li>If you haven't installed Axis2, then download and extract the standard binary distribution. Make sure you have set the AXIS2_HOME environment variable</li>
-<li>Run ant from the "samples" directory to copy the required libraries and modules to relevant directories in AXIS2_HOME.</li>
-<li>Download xalan-2.7.0.jar from <a href="http://www.apache.org/dist/java-repository/xalan/jars/">here</a> and put under AXIS2_HOME\lib folder, if you use JDK 1.5.</li>
-<li>Download log4j.jar from <a href="http://people.apache.org/repo/m1-ibiblio-rsync-repository/log4j/jars/">here</a> and put under AXIS2_HOME\lib</li>
-</ol>
-<p></p>
-<h3>Running Samples</h3>
-<p>Now we'll look at how to run the first sample inside samples/policy folder.</p>
-<ol>
-<li>Open a console and change the directory to sample/policy and give the following command. This will start the server at port 8080</li>
-<pre><code>$ant service.01</code></pre>
-<li>Open a new console and change the directory to sample/policy and type the following command.</li>
-<pre><code>$ant client.01</code></pre>
-</ol>
-<p>Congratulations! Now you have executed the first sample. Rest of the samples can be run by changing the sample number.</p>
-
-<h3>Understanding the first sample</h3>
-
-<ul><li>Engaging Rampart</li></ul>
-<p>When securing a SOAP message, the sender must know the security actions to be performed on the message and the receiver must know enough details to process and validate the security of the message. Therefore when using Rampart with Axis2, it must be engaged at both ends.</p>
-<p>Observe how module has been engaged in server side by opening samples/policy/sample01/services.xml. The following line has engaged the module.</p>
-<p>Engaging Rampart at client side is done programatically as follows.</p>
-<pre>
+ <head>
+ <title>Apache Rampart - Source Repository</title>
+ </head>
+ <body>
+ <h2>Rampart Quick Start Guide</h2>
+
+ <h3>Installing Rampart in Axis2</h3>
+ <p>Steps to install</p>
+ <ol>
+ <li>If you haven't installed Axis2, then download and extract the standard binary distribution. Make sure you have set the AXIS2_HOME environment variable</li>
+ <li>Run ant from the "samples" directory to copy the required libraries and modules to relevant directories in AXIS2_HOME.</li>
+ <li>Download xalan-2.7.0.jar from <a href="http://www.apache.org/dist/java-repository/xalan/jars/">here</a> and put under AXIS2_HOME\lib folder, if you use JDK 1.5.</li>
+ <li>Download log4j.jar from <a href="http://people.apache.org/repo/m1-ibiblio-rsync-repository/log4j/jars/">here</a> and put under AXIS2_HOME\lib</li>
+ </ol>
+ <p></p>
+ <h3>Running Samples</h3>
+ <p>Now we'll look at how to run the first sample inside samples/policy folder.</p>
+ <ol>
+ <li>Open a console and change the directory to sample/policy and give the following command. This will start the server at port 8080</li>
+ <pre>
+<code>$ant service.01</code>
+ </pre>
+ <li>Open a new console and change the directory to sample/policy and type the following command.</li>
+ <pre>
+<code>$ant client.01</code>
+ </pre>
+ </ol>
+ <p>Congratulations! Now you have executed the first sample. Rest of the samples can be run by changing the sample number.</p>
+
+ <h3>Understanding the first sample</h3>
+
+ <ul>
+ <li>Engaging Rampart</li>
+ </ul>
+ <p>When securing a SOAP message, the sender must know the security actions to be performed on the message and the receiver must know enough details to process and validate the security of the message. Therefore when using Rampart with Axis2, it must be engaged at both ends.</p>
+ <p>Observe how module has been engaged in server side by opening samples/policy/sample01/services.xml. The following line has engaged the module.</p>
+ <p>Engaging Rampart at client side is done programatically as follows.</p>
+ <pre>
ServiceClient client = new ServiceClient(ctx, null);<br/>
client.engageModule("rampart");
</pre>
-<ul><li>Understanding policy</li></ul>
-<p>WS-Security Policy can be used to indicate what security actions that needs be performed on SOAP messages and and what actions should be validated. The file 'samples/policy/sample01/policy.xml' configures Rampart to add Username Token with Timestamp to this message. The element <RampartConfig> in policy.xml defines Rampart specific configurations. </p>
-<p>Policy at serverside is included in samples/policy/sample01/services.xml file. This configures Rampart module at serverside to validate the message for Username Token an Timestamp.</p>
-<p>More details on RampartConfig can be found <a href="ampartconfig-guide.html">here</a>.</p>
-
-<ul><li>Viewing the Message on wire</li></ul>
-<p>It is interesting to view the secured SOAP message on the wire using TCP monitor. Change the "client.port" property in samples/policy/build.xml file to the listening port of TCP monitor. This will send all the messages through TCP monitor when you execute the ant script. Observe the <wsse:Security> header in the SOAP message.</p>
-
-<h3>Setting up a Security Token Service</h3>
-<p>Security Token Service can be set up as per WS-Trust specification using Rampart. The default security token service shipped with the rampart distribution is contained in the rampart-trust.mar module. It can issue SCT tokens and SAML tokens. Sample05 contains a client that connects to the default STS and obtain a SAML token. The services.xml in the sample contains "saml-issuer-config" parameter that is used to configure the default SAML issuer.</p>
-<strong>STS with a custom issuer</strong>
-<p>First the default rampart.mar has to be removed from the modules. Then write you own issuer implementing the <code>"org.apache.rahas.TokenIssuer"</code> interface. Let's say that your issuer is <code>"org.custom.MyIssuer"</code>. Then create a Axis2 service archive with the following in the services.xml. Drop the archive into the repository and you have a STS with a CustomToken issuer.</p>
+ <ul>
+ <li>Understanding policy</li>
+ </ul>
+ <p>WS-Security Policy can be used to indicate what security actions that needs be performed on SOAP messages and and what actions should be validated. The file 'samples/policy/sample01/policy.xml' configures Rampart to add Username Token with Timestamp to this message. The element <RampartConfig> in policy.xml defines Rampart specific configurations. </p>
+ <p>Policy at serverside is included in samples/policy/sample01/services.xml file. This configures Rampart module at serverside to validate the message for Username Token an Timestamp.</p>
+ <p>More details on RampartConfig can be found <a href="rampartconfig-guide.html">here</a>.</p>
+
+ <ul>
+ <li>Viewing the Message on wire</li>
+ </ul>
+ <p>It is interesting to view the secured SOAP message on the wire using TCP monitor. Change the "client.port" property in samples/policy/build.xml file to the listening port of TCP monitor. This will send all the messages through TCP monitor when you execute the ant script. Observe the <wsse:Security> header in the SOAP message.</p>
+
+ <h3>Setting up a Security Token Service</h3>
+ <p>Security Token Service can be set up as per WS-Trust specification using Rampart. The default security token service shipped with the rampart distribution is contained in the rampart-trust.mar module. It can issue SCT tokens and SAML tokens. Sample05 contains a client that connects to the default STS and obtain a SAML token. The services.xml in the sample contains "saml-issuer-config" parameter that is used to configure the default SAML issuer.</p>
+ <strong>STS with a custom issuer</strong>
+ <p>First the default rampart.mar has to be removed from the modules. Then write you own issuer implementing the <code>"org.apache.rahas.TokenIssuer"</code> interface. Let's say that your issuer is <code>"org.custom.MyIssuer"</code>. Then create a Axis2 service archive with the following in the services.xml. Drop the archive into the repository and you have a STS with a CustomToken issuer.</p>
-<pre>
+ <pre>
<module ref="rampart" />
@@ -81,6 +92,6 @@
</pre>
-</body>
+ </body>
</html>