Author: coheigea
Date: Mon Feb 17 12:23:28 2014
New Revision: 1568958
URL: http://svn.apache.org/r1568958
Log:
Updating the "Using WSS4J" page of the user guide
Modified:
webservices/wss4j/site/src/site/xdoc/using.xml
Modified: webservices/wss4j/site/src/site/xdoc/using.xml
URL:
http://svn.apache.org/viewvc/webservices/wss4j/site/src/site/xdoc/using.xml?rev=1568958&r1=1568957&r2=1568958&view=diff
==============================================================================
--- webservices/wss4j/site/src/site/xdoc/using.xml (original)
+++ webservices/wss4j/site/src/site/xdoc/using.xml Mon Feb 17 12:23:28 2014
@@ -3,101 +3,118 @@
<body>
<section name="Using Apache WSS4J">
<p>
-This page describes how to use Apache WSS4J, either in a standalone manner, or
in conjunction with
-other software packages. For information about how to configure WSS4J 1.6, see
the
-<a href="config.html">configuration page</a>.
+This page describes how to use Apache WSS4J. For information about how to
+configure WSS4J, see the <a href="config.html">configuration page</a>. WSS4J
+can essentially be used in three different ways. For information about using
+WSS4J with a SOAP stack, see the sections on Apache CXF and Apache
Rampart/Axis.
</p>
-<subsection name="Standalone">
+<ul>
+<li>Action based approach: WSS4J offers an "Action" based approach to
+applying WS-Security to a SOAP request or response, in conjunction with a SOAP
+stack.</li>
+<li>WS-SecurityPolicy based approach: WSS4J can be configured for a SOAP
+request/response via WS-SecurityPolicy, in conjunction with a SOAP Stack.
+This is the recommended approach.</li>
+<li>Standalone approach: WSS4J offers a low-level (DOM) API to
+construct/sign/encrypt/etc. tokens directly.</li>
+</ul>
+
+<subsection name="Action based approach">
+
+</subsection>
+
+<subsection name="WS-SecurityPolicy based approach">
+
+</subsection>
+
+<subsection name="Standalone approach">
<p>
-Apache WSS4J provides a set of APIs to implement WS-Security functionality on
a SOAP message. It is
-possible to use these APIs directly in a standalone manner. The best way of
finding out how to do
-this is to take a look at the test sources. For example:
+Apache WSS4J provides a set of APIs to implement WS-Security functionality on
+a SOAP message. It is possible to use these APIs directly in a standalone
+manner, although it is far more common to use either the "Action" or
+WS-SecurityPolicy based approaches. This functionality is only available for
+the DOM code. The best way of finding out how to do this is to take a look at
+the test sources. For example:
</p>
<ul>
<li>
-<a
href="xref-test/org/apache/ws/security/message/UsernameTokenTest.html">Username
Token Test</a>
+<a
href="http://svn.apache.org/viewvc/webservices/wss4j/trunk/ws-security-dom/src/test/java/org/apache/wss4j/dom/message/UsernameTokenTest.java?view=markup";>Username
Token Test</a>
</li>
<li>
-<a
href="xref-test/org/apache/ws/security/message/EncryptionTest.html">Encryption
Test</a>
+<a
href="http://svn.apache.org/viewvc/webservices/wss4j/trunk/ws-security-dom/src/test/java/org/apache/wss4j/dom/message/EncryptionTest.java?view=markup";>Encryption
Test</a>
</li>
<li>
-<a
href="xref-test/org/apache/ws/security/message/SignatureTest.html">Signature
Test</a>
+<a
href="http://svn.apache.org/viewvc/webservices/wss4j/trunk/ws-security-dom/src/test/java/org/apache/wss4j/dom/message/SignatureTest.java?view=markup";>Signature
Test</a>
</li>
<li>
-<a
href="xref-test/org/apache/ws/security/message/TimestampTest.html">Timestamp
Test</a>
+<a
href="http://svn.apache.org/viewvc/webservices/wss4j/trunk/ws-security-dom/src/test/java/org/apache/wss4j/dom/message/TimestampTest.java?view=markup";>Timestamp
Test</a>
</li>
<li>
-<a href="xref-test/org/apache/ws/security/saml/SamlTokenTest.html">SAML Token
Test</a>
+<a
href="http://svn.apache.org/viewvc/webservices/wss4j/trunk/ws-security-dom/src/test/java/org/apache/wss4j/dom/saml/SamlTokenTest.java?view=markup";>SAML
Token Test</a>
</li>
</ul>
</subsection>
+
<subsection name="Apache CXF">
<p>
-<a href="http://cxf.apache.org";>Apache CXF</a> is an open-source web services
stack. CXF uses
-WSS4J to perform the core WS-Security functionality, and provides extended
security functionality
-based around the WS-SecurityPolicy, WS-SecureConversation and WS-Trust
specifications. More
-information:
+<a href="http://cxf.apache.org";>Apache CXF</a> is an open-source web services
+stack. CXF uses WSS4J to perform the core WS-Security functionality, and
+provides extended security functionality based around the WS-SecurityPolicy,
+WS-SecureConversation and WS-Trust specifications. More information:
</p>
<ul>
<li>
-<a href="http://cxf.apache.org/docs/ws-security.html";>CXF WS-Security
configuration</a>
+<a href="http://cxf.apache.org/docs/ws-security.html";>CXF WS-Security
+configuration</a>
</li>
<li>
-<a href="http://cxf.apache.org/docs/ws-secureconversation.html";>CXF
WS-SecureConversation
-configuration</a>
+<a href="http://cxf.apache.org/docs/ws-secureconversation.html";>CXF
+WS-SecureConversation configuration</a>
</li>
<li>
-<a href="http://cxf.apache.org/docs/ws-securitypolicy.html";>CXF
WS-SecurityPolicy configuration</a>
+<a href="http://cxf.apache.org/docs/ws-securitypolicy.html";>CXF
+WS-SecurityPolicy configuration</a>
</li>
<li>
-<a href="http://cxf.apache.org/docs/ws-trust.html";>CXF WS-Trust
configuration</a>
+<a href="http://cxf.apache.org/docs/ws-trust.html";>CXF WS-Trust
+configuration</a>
</li>
<li>
-<a href="http://cxf.apache.org/resources-and-articles.html";>CXF Security
articles</a>
+<a href="http://cxf.apache.org/resources-and-articles.html";>CXF Security
+articles</a>
</li>
</ul>
</subsection>
-<subsection name="Apache Rampart">
+
+<subsection name="Apache Rampart/Axis">
<p>
-<a href="http://axis.apache.org/axis2/java/rampart/";>Apache Rampart</a> is the
security module
-for the Axis2 web services stack. Rampart uses WSS4J to perform the core
WS-Security functionality,
-and provides extended security functionality based around the
WS-SecurityPolicy,
-WS-SecureConversation and WS-Trust specifications. More information:
+<a href="http://axis.apache.org/axis2/java/rampart/";>Apache Rampart</a> is the
+security module for the Axis2 web services stack. Rampart uses WSS4J to
+perform the core WS-Security functionality, and provides extended security
+functionality based around the WS-SecurityPolicy, WS-SecureConversation and
+WS-Trust specifications. Note that support for Apache Axis1 via the WSS4J
+1.5.x series of releases is no longer supported. More information:
</p>
<ul>
<li>
-<a
href="http://axis.apache.org/axis2/java/rampart/developer-guide.html";>Rampart
developer guide</a>
-</li>
-<li>
-<a href="http://axis.apache.org/axis2/java/rampart/samples.html";>Rampart
samples</a>
-</li>
-<li>
-<a
href="http://axis.apache.org/axis2/java/rampart/rampartconfig-guide.html";>Rampart
configuration
-guide</a>
+<a href="http://axis.apache.org/axis2/java/rampart/developer-guide.html";>
+Rampart developer guide</a>
</li>
<li>
-<a href="http://axis.apache.org/axis2/java/rampart/articles.html";>Rampart
articles</a>
+<a href="http://axis.apache.org/axis2/java/rampart/samples.html";>Rampart
+samples</a>
</li>
-</ul>
-</subsection>
-<subsection name="Apache Axis 1">
-<p>
-The 1.5.x branch of WSS4J contains special support for
-<a href="http://ws.apache.org/axis/";>Apache Axis 1</a>, the open-source web
services stack which has been
-replaced by Axis2. For some information about how to use WSS4J 1.5.x with Axis
1 see:
-</p>
-<ul>
<li>
-<a href="axis.html">Axis deployment tutorial 1</a>
+<a href="http://axis.apache.org/axis2/java/rampart/rampartconfig-guide.html";>
+Rampart configuration guide</a>
</li>
<li>
-<a href="package.html">Axis deployment tutorial 2</a>
+<a href="http://axis.apache.org/axis2/java/rampart/articles.html";>Rampart
+articles</a>
</li>
</ul>
-<p>
-Please note that these deployment tutorials do not apply to WSS4J 1.6+, only
WSS4J 1.5.x.
-</p>
</subsection>
+
</section>
</body>
-</document>
\ No newline at end of file
+</document>
