You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by dk...@apache.org on 2013/06/24 19:10:57 UTC
svn commit: r867253 [27/46] - in /websites/production/cxf/content: ./
2008/04/28/ 2008/06/20/ 2009/02/10/ 2009/08/04/ cache/ docs/
docs/cxf-architecture.thumbs/ docs/cxf-dependency-graphs.thumbs/
docs/logbrowser-configuration.thumbs/ docs/logbrowser-so...
Modified: websites/production/cxf/content/docs/jax-rs-xml-security.html
==============================================================================
--- websites/production/cxf/content/docs/jax-rs-xml-security.html (original)
+++ websites/production/cxf/content/docs/jax-rs-xml-security.html Mon Jun 24 17:10:51 2013
@@ -25,6 +25,18 @@
<meta http-equiv="Content-type" content="text/html;charset=UTF-8">
<meta name="keywords" content="business integration, EAI, SOA, Service Oriented Architecture, web services, SOAP, JBI, JMS, WSDL, XML, EDI, Electronic Data Interchange, standards support, integration standards, application integration, middleware, software, solutions, services, CXF, open source">
<meta name="description" content="Apache CXF, Services Framework - JAX-RS XML Security">
+
+ <link href='http://cxf.apache.org/resources/highlighter/styles/shCore.css' rel='stylesheet' type='text/css' />
+ <link href='http://cxf.apache.org/resources/highlighter/styles/shThemeCXF.css' rel='stylesheet' type='text/css' />
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shCore.js' type='text/javascript'></script>
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shBrushXml.js' type='text/javascript'></script>
+
+ <script type="text/javascript">
+ SyntaxHighlighter.defaults['toolbar'] = false;
+ SyntaxHighlighter.all();
+ </script>
+
<title>
Apache CXF -- JAX-RS XML Security
</title>
@@ -42,19 +54,15 @@ Apache CXF -- JAX-RS XML Security
<td id="cell-1-0"> </td>
<td id="cell-1-1"> </td>
<td id="cell-1-2">
- <div style="padding: 5px;">
- <div id="banner">
- <!-- Banner -->
-<div id="banner-content">
+ <!-- Banner -->
+<div class="banner" id="banner"><p>
<table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td align="left" colspan="1" nowrap>
<a shape="rect" href="http://cxf.apache.org/" title="Apache CXF"><span style="font-weight: bold; font-size: 170%; color: white">Apache CXF</span></a>
</td><td align="right" colspan="1" nowrap>
<a shape="rect" href="http://www.apache.org/" title="The Apache Sofware Foundation"><img border="0" alt="ASF Logo" src="http://cxf.apache.org/images/asf-logo.png"></a>
</td></tr></table>
-</div>
- <!-- Banner -->
- </div>
- </div>
+</p></div>
+ <!-- Banner -->
<div id="top-menu">
<table border="0" cellpadding="1" cellspacing="0" width="100%">
<tr>
@@ -94,7 +102,7 @@ Apache CXF -- JAX-RS XML Security
<hr>
-<ul class="alternate" type="square"><li>Search
+<ul class="alternate" type="square"><li>Search<br clear="none">
<form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
<div>
@@ -135,13 +143,13 @@ This is a work in progress and the enhan
<h1><a shape="rect" name="JAX-RSXMLSecurity-Mavendependencies"></a>Maven dependencies</h1>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><dependency></span>
- <span class="code-tag"><groupId></span>org.apache.cxf<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>cxf-rt-rs-security-xml<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>2.5.2<span class="code-tag"></version></span>
-<span class="code-tag"></dependency></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<dependency>
+ <groupId>org.apache.cxf</groupId>
+ <artifactId>cxf-rt-rs-security-xml</artifactId>
+ <version>2.5.2</version>
+</dependency>
+]]></script>
</div></div>
<h1><a shape="rect" name="JAX-RSXMLSecurity-XMLSignature"></a>XML Signature</h1>
@@ -156,41 +164,41 @@ This is a work in progress and the enhan
<p>Payload:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><Book ID=<span class="code-quote">"4bd59819-7b78-47a5-bb61-cc08348e9d48"</span>></span>
- <span class="code-tag"><id></span>126<span class="code-tag"></id></span>
- <span class="code-tag"><name></span>CXF<span class="code-tag"></name></span>
-
- <span class="code-tag"><ds:Signature <span class="code-keyword">xmlns:ds</span>=<span class="code-quote">"http://www.w3.org/2000/09/xmldsig#"</span>></span>
- <span class="code-tag"><ds:SignedInfo></span>
- <span class="code-tag"><ds:CanonicalizationMethod Algorithm=<span class="code-quote">"http://www.w3.org/TR/2001/REC-xml-c14n-20010315"</span>/></span>
- <span class="code-tag"><ds:SignatureMethod Algorithm=<span class="code-quote">"http://www.w3.org/2000/09/xmldsig#rsa-sha1"</span>/></span>
- <span class="code-tag"><ds:Reference URI=<span class="code-quote">"#4bd59819-7b78-47a5-bb61-cc08348e9d48"</span>></span>
- <span class="code-tag"><ds:Transforms></span>
- <span class="code-tag"><ds:Transform Algorithm=<span class="code-quote">"http://www.w3.org/2000/09/xmldsig#enveloped-signature"</span>/></span>
- <span class="code-tag"><ds:Transform Algorithm=<span class="code-quote">"http://www.w3.org/2001/10/xml-exc-c14n#"</span>/></span>
- <span class="code-tag"></ds:Transforms></span>
- <span class="code-tag"><ds:DigestMethod Algorithm=<span class="code-quote">"http://www.w3.org/2000/09/xmldsig#sha1"</span>/></span>
- <span class="code-tag"><ds:DigestValue></span>eFduzs6Cg1/Wd6jagUmr8vRYxHY=<span class="code-tag"></ds:DigestValue></span>
- <span class="code-tag"></ds:Reference></span>
- <span class="code-tag"></ds:SignedInfo></span>
-<span class="code-tag"><ds:SignatureValue></span>DLD+wU85G+Q+H/SNoMr1I7tOCAZAjd3lYE84sBGU5tuMtzbwxKOIgg10g2F1SUbpujy1CZZ9BPkQNA+gA1CH4FE3uiBzp3DDSVv6o5l6Q76Ci0XI28ylO7O1OCY+q2nbP0WtERFWOn9f9nniVKbduz6YQHjv6cNLd8pf4+k2U3g=<span class="code-tag"></ds:SignatureValue></span>
-
- <span class="code-tag"><ds:KeyInfo></span>
- <span class="code-tag"><ds:X509Data></span><span class="code-tag"><ds:X509Certificate></span>MIICGjCCAYOgAwIBAgIESVRgATANBgkqhkiG9w0BAQUFADAzMRMwEQYDVQQKEwphcGFjaGUub3JnMQwwCgYDVQQLEwNlbmcxDjAMBgNVBAMTBWN4ZmNhMB4XDTcwMDEwMTAwMDAwMFoXDTM4MDExOTAzMTQwN1owMzETMBEGA1UEChMKYXBhY2hlLm9yZzEMMAoGA1UECxMDZW5nMQ4wDAYDVQQDEwVhbGljZTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAvu747/VShQ85f16DGSc4Ixh9PVpGguyEqrCsK8q9XHOYX9l9/g5wEC6ZcR2FwfNsoaHcKNPjd5sSTzVtBWmQjfBEfIqwTR7vuihOxyNTwEzVwIJzvo7p8/aYxk+VdBtQxq4UweIcf/iFkUbM1cZ1oiXRQzciRBi+C1BQCQE0qzsCAwEAAaM7MDkwIQYDVR0SBBowGIIWTk9UX0ZPUl9QUk9EVUNUSU9OX1VTRTAUBgNVHREEDTALgglsb2NhbGhvc3QwDQYJKoZIhvcNAQEFBQADgYEAhLwkm+8psKt4gnbikGzV0TgpSWGcWxWKBi+z8tI2n6hFA5v1jVHHa4G9h3s0nxQ2TewzeR/k7gmgV2sI483NgrYHmTmLKaDBWza2pAuZuDhQH8GAEhJakFtKBP++EC9rNNpZnqqHxx3qb2tW25qRtBzDmK921gg9PMomMc7uqRQ=<span class="code-tag"></ds:X509Certificate></span>
- <span class="code-tag"></ds:X509Data></span>
-
- <span class="code-tag"><ds:KeyValue></span>
- <span class="code-tag"><ds:RSAKeyValue></span>
- <span class="code-tag"><ds:Modulus></span>vu747/VShQ85f16DGSc4Ixh9PVpGguyEqrCsK8q9XHOYX9l9/g5wEC6ZcR2FwfNsoaHcKNPjd5sSTzVtBWmQjfBEfIqwTR7vuihOxyNTwEzVwIJzvo7p8/aYxk+VdBtQxq4UweIcf/iFkUbM1cZ1oiXRQzciRBi+C1BQCQE0qzs=<span class="code-tag"></ds:Modulus></span>
- <span class="code-tag"><ds:Exponent></span>AQAB<span class="code-tag"></ds:Exponent></span>
- <span class="code-tag"></ds:RSAKeyValue></span>
- <span class="code-tag"></ds:KeyValue></span>
- <span class="code-tag"></ds:KeyInfo></span>
- <span class="code-tag"></ds:Signature></span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<Book ID="4bd59819-7b78-47a5-bb61-cc08348e9d48">
+ <id>126</id>
+ <name>CXF</name>
+
+ <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
+ <ds:SignedInfo>
+ <ds:CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
+ <ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
+ <ds:Reference URI="#4bd59819-7b78-47a5-bb61-cc08348e9d48">
+ <ds:Transforms>
+ <ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
+ <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
+ </ds:Transforms>
+ <ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
+ <ds:DigestValue>eFduzs6Cg1/Wd6jagUmr8vRYxHY=</ds:DigestValue>
+ </ds:Reference>
+ </ds:SignedInfo>
+<ds:SignatureValue>DLD+wU85G+Q+H/SNoMr1I7tOCAZAjd3lYE84sBGU5tuMtzbwxKOIgg10g2F1SUbpujy1CZZ9BPkQNA+gA1CH4FE3uiBzp3DDSVv6o5l6Q76Ci0XI28ylO7O1OCY+q2nbP0WtERFWOn9f9nniVKbduz6YQHjv6cNLd8pf4+k2U3g=</ds:SignatureValue>
+
+ <ds:KeyInfo>
+ <ds:X509Data><ds:X509Certificate>MIICGjCCAYOgAwIBAgIESVRgATANBgkqhkiG9w0BAQUFADAzMRMwEQYDVQQKEwphcGFjaGUub3JnMQwwCgYDVQQLEwNlbmcxDjAMBgNVBAMTBWN4ZmNhMB4XDTcwMDEwMTAwMDAwMFoXDTM4MDExOTAzMTQwN1owMzETMBEGA1UEChMKYXBhY2hlLm9yZzEMMAoGA1UECxMDZW5nMQ4wDAYDVQQDEwVhbGljZTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAvu747/VShQ85f16DGSc4Ixh9PVpGguyEqrCsK8q9XHOYX9l9/g5wEC6ZcR2FwfNsoaHcKNPjd5sSTzVtBWmQjfBEfIqwTR7vuihOxyNTwEzVwIJzvo7p8/aYxk+VdBtQxq4UweIcf/iFkUbM1cZ1oiXRQzciRBi+C1BQCQE0qzsCAwEAAaM7MDkwIQYDVR0SBBowGIIWTk9UX0ZPUl9QUk9EVUNUSU9OX1VTRTAUBgNVHREEDTALgglsb2NhbGhvc3QwDQYJKoZIhvcNAQEFBQADgYEAhLwkm+8psKt4gnbikGzV0TgpSWGcWxWKBi+z8tI2n6hFA5v1jVHHa4G9h3s0nxQ2TewzeR/k7gmgV2sI483NgrYHmTmLKaDBWza2pAuZuDhQH8GAEhJakFtKBP++EC9rNNpZnqqHxx3qb2tW25qRtBzDmK921gg9PMomMc7uqRQ=</ds:X509Certificate>
+ </ds:X509Data>
+
+ <ds:KeyValue>
+ <ds:RSAKeyValue>
+ <ds:Modulus>vu747/VShQ85f16DGSc4Ixh9PVpGguyEqrCsK8q9XHOYX9l9/g5wEC6ZcR2FwfNsoaHcKNPjd5sSTzVtBWmQjfBEfIqwTR7vuihOxyNTwEzVwIJzvo7p8/aYxk+VdBtQxq4UweIcf/iFkUbM1cZ1oiXRQzciRBi+C1BQCQE0qzs=</ds:Modulus>
+ <ds:Exponent>AQAB</ds:Exponent>
+ </ds:RSAKeyValue>
+ </ds:KeyValue>
+ </ds:KeyInfo>
+ </ds:Signature>
-<span class="code-tag"></Book></span>
-</pre>
+</Book>
+]]></script>
</div></div>
<p>Note that the Book root element is signed including its name and id children, and a signature ds:Reference links to Book. </p>
@@ -198,39 +206,39 @@ This is a work in progress and the enhan
<p>Server Configuration fragment:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
-<span class="code-tag"><bean id=<span class="code-quote">"serviceBean"</span> class=<span class="code-quote">"org.apache.cxf.systest.jaxrs.security.BookStore"</span>/></span>
-<span class="code-tag"><bean id=<span class="code-quote">"xmlSigHandler"</span> class=<span class="code-quote">"org.apache.cxf.rs.security.xml.XmlSigInHandler"</span>/></span>
-<span class="code-tag"><bean id=<span class="code-quote">"xmlSigOutHandler"</span> class=<span class="code-quote">"org.apache.cxf.rs.security.xml.XmlSigOutInterceptor"</span>/></span>
-
-<span class="code-tag"><jaxrs:server address=<span class="code-quote">"/xmlsig"</span>></span>
- <span class="code-tag"><jaxrs:serviceBeans></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"serviceBean"</span>/></span>
- <span class="code-tag"></jaxrs:serviceBeans></span>
+<bean id="serviceBean" class="org.apache.cxf.systest.jaxrs.security.BookStore"/>
+<bean id="xmlSigHandler" class="org.apache.cxf.rs.security.xml.XmlSigInHandler"/>
+<bean id="xmlSigOutHandler" class="org.apache.cxf.rs.security.xml.XmlSigOutInterceptor"/>
+
+<jaxrs:server address="/xmlsig">
+ <jaxrs:serviceBeans>
+ <ref bean="serviceBean"/>
+ </jaxrs:serviceBeans>
<!--
Required for validating the in signature and removing it from the payload.
It also persists the signature on the current Message which can be disabled.
-->
- <span class="code-tag"><jaxrs:providers></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"xmlSigHandler"</span>/></span>
- <span class="code-tag"></jaxrs:providers></span>
+ <jaxrs:providers>
+ <ref bean="xmlSigHandler"/>
+ </jaxrs:providers>
<!--
Required for adding a new signature to the outbound payload
-->
- <span class="code-tag"><jaxrs:outInterceptors></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"xmlSigOutHandler"</span>/></span>
- <span class="code-tag"></jaxrs:outInterceptors></span>
-
- <span class="code-tag"><jaxrs:properties></span>
- <entry key=<span class="code-quote">"ws-security.callback-handler"</span>
- value=<span class="code-quote">"org.apache.cxf.systest.jaxrs.security.saml.KeystorePasswordCallback"</span>/>
- <entry key=<span class="code-quote">"ws-security.signature.properties"</span>
- value=<span class="code-quote">"org/apache/cxf/systest/jaxrs/security/alice.properties"</span>/>
- <span class="code-tag"></jaxrs:properties></span>
-<span class="code-tag"></jaxrs:server></span>
+ <jaxrs:outInterceptors>
+ <ref bean="xmlSigOutHandler"/>
+ </jaxrs:outInterceptors>
+
+ <jaxrs:properties>
+ <entry key="ws-security.callback-handler"
+ value="org.apache.cxf.systest.jaxrs.security.saml.KeystorePasswordCallback"/>
+ <entry key="ws-security.signature.properties"
+ value="org/apache/cxf/systest/jaxrs/security/alice.properties"/>
+ </jaxrs:properties>
+</jaxrs:server>
-</pre>
+]]></script>
</div></div>
<p>Note that org.apache.cxf.rs.security.xml.XmlSigInHandler is responsible for validating the signature attached to the inbound payload and is capable of processing all 3 types of XML Signature. </p>
@@ -240,39 +248,39 @@ This is a work in progress and the enhan
<p>Client code:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-<span class="code-object">String</span> address = <span class="code-quote">"https:<span class="code-comment">//localhost:8080/xmlsig/bookstore/books"</span>;
-</span>JAXRSClientFactoryBean bean = <span class="code-keyword">new</span> JAXRSClientFactoryBean();
+String address = "https://localhost:8080/xmlsig/bookstore/books";
+JAXRSClientFactoryBean bean = new JAXRSClientFactoryBean();
bean.setAddress(address);
-<span class="code-comment">// setup properties
-</span>Map<<span class="code-object">String</span>, <span class="code-object">Object</span>> properties = <span class="code-keyword">new</span> HashMap<<span class="code-object">String</span>, <span class="code-object">Object</span>>();
-properties.put(<span class="code-quote">"ws-security.callback-handler"</span>,
- <span class="code-quote">"org.apache.cxf.systest.jaxrs.security.saml.KeystorePasswordCallback"</span>);
-properties.put(<span class="code-quote">"ws-security.signature.username"</span>, <span class="code-quote">"alice"</span>);
-properties.put(<span class="code-quote">"ws-security.signature.properties"</span>,
- <span class="code-quote">"org/apache/cxf/systest/jaxrs/security/alice.properties"</span>);
+// setup properties
+Map<String, Object> properties = new HashMap<String, Object>();
+properties.put("ws-security.callback-handler",
+ "org.apache.cxf.systest.jaxrs.security.saml.KeystorePasswordCallback");
+properties.put("ws-security.signature.username", "alice");
+properties.put("ws-security.signature.properties",
+ "org/apache/cxf/systest/jaxrs/security/alice.properties");
bean.setProperties(properties);
-<span class="code-comment">// add the interceptor which will add a signature to the outbound payload
-</span>XmlSigOutInterceptor sigOutInterceptor = <span class="code-keyword">new</span> XmlSigOutInterceptor();
+// add the interceptor which will add a signature to the outbound payload
+XmlSigOutInterceptor sigOutInterceptor = new XmlSigOutInterceptor();
bean.getOutInterceptors().add(sigOutInterceptor);
-<span class="code-comment">// add the interceptor which will validate a signature in the inbound payload
-</span>XmlSigInInterceptor sigInInterceptor = <span class="code-keyword">new</span> XmlSigInInterceptor();
+// add the interceptor which will validate a signature in the inbound payload
+XmlSigInInterceptor sigInInterceptor = new XmlSigInInterceptor();
bean.getInInterceptors().add(sigInInterceptor);
-<span class="code-comment">// load a bus with HTTPS configuration:
-</span>SpringBusFactory bf = <span class="code-keyword">new</span> SpringBusFactory();
+// load a bus with HTTPS configuration:
+SpringBusFactory bf = new SpringBusFactory();
Bus bus = bf.createBus(configLocation);
bean.setBus(bus);
-<span class="code-comment">// use WebClient (or proxy) as usual
-</span>WebClient wc = bean.createWebClient();
-Book book = wc.post(<span class="code-keyword">new</span> Book(<span class="code-quote">"CXF"</span>, 126L), Book.class);
-</pre>
+// use WebClient (or proxy) as usual
+WebClient wc = bean.createWebClient();
+Book book = wc.post(new Book("CXF", 126L), Book.class);
+]]></script>
</div></div>
<p>Spring configuration can also be used.<br clear="none">
@@ -283,38 +291,38 @@ Please also check <a shape="rect" href="
<p>Payload:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><ds:Signature <span class="code-keyword">xmlns:ds</span>=<span class="code-quote">"http://www.w3.org/2000/09/xmldsig#"</span>></span>
- <span class="code-tag"><ds:SignedInfo></span>
- <span class="code-tag"><ds:CanonicalizationMethod Algorithm=<span class="code-quote">"http://www.w3.org/TR/2001/REC-xml-c14n-20010315"</span>/></span>
- <span class="code-tag"><ds:SignatureMethod Algorithm=<span class="code-quote">"http://www.w3.org/2000/09/xmldsig#rsa-sha1"</span>/></span>
- <span class="code-tag"><ds:Reference URI=<span class="code-quote">"#88e688e6-6512-406f-9e88-a58e5d781ff0"</span>></span>
- <span class="code-tag"><ds:Transforms></span>
- <span class="code-tag"><ds:Transform Algorithm=<span class="code-quote">"http://www.w3.org/2001/10/xml-exc-c14n#"</span>/></span>
- <span class="code-tag"></ds:Transforms></span>
- <span class="code-tag"><ds:DigestMethod Algorithm=<span class="code-quote">"http://www.w3.org/2000/09/xmldsig#sha1"</span>/></span>
- <span class="code-tag"><ds:DigestValue></span>Cq3zl3t3DqWTvuZ+4EtZgGs4ikk=<span class="code-tag"></ds:DigestValue></span>
- <span class="code-tag"></ds:Reference></span>
- <span class="code-tag"></ds:SignedInfo></span><span class="code-tag"><ds:SignatureValue></span>NvcCS8vx3YJkc8fHMf8bQkC+lwasC6CwiS7HfKSm8t+6TtYdM7TRbYxSuqfCTkF4vBIldWIzl6UngON592FfJdbvrgE2CusCkIybrP7BBmP7zTSV0GjH4/60L6ObkhGPkMNoKzw4V+zgF7Zo+F7ngsz5ZUWZX/GWETmTtYtcfT0=<span class="code-tag"></ds:SignatureValue></span>
- <span class="code-tag"><ds:KeyInfo></span>
- <span class="code-tag"><ds:X509Data></span>
- <span class="code-tag"><ds:X509Certificate></span><span class="code-tag"><span class="code-comment"><!-- Omitted for brevity--></span></span><span class="code-tag"></ds:X509Certificate></span>
- <span class="code-tag"></ds:X509Data></span>
- <span class="code-tag"><ds:KeyValue></span>
- <span class="code-tag"><ds:RSAKeyValue></span><span class="code-tag"><ds:Modulus></span>vu747/VShQ85f16DGSc4Ixh9PVpGguyEqrCsK8q9XHOYX9l9/g5wEC6ZcR2FwfNsoaHcKNPjd5sSTzVtBWmQjfBEfIqwTR7vuihOxyNTwEzVwIJzvo7p8/aYxk+VdBtQxq4UweIcf/iFkUbM1cZ1oiXRQzciRBi+C1BQCQE0qzs=<span class="code-tag"></ds:Modulus></span>
- <span class="code-tag"><ds:Exponent></span>AQAB<span class="code-tag"></ds:Exponent></span>
- <span class="code-tag"></ds:RSAKeyValue></span>
- <span class="code-tag"></ds:KeyValue></span>
- <span class="code-tag"></ds:KeyInfo></span>
- <span class="code-tag"><ds:Object ID=<span class="code-quote">"88e688e6-6512-406f-9e88-a58e5d781ff0"</span>></span>
-
- <span class="code-tag"><Book></span>
- <span class="code-tag"><id></span>126<span class="code-tag"></id></span>
- <span class="code-tag"><name></span>CXF<span class="code-tag"></name></span>
- <span class="code-tag"></Book></span>
- <span class="code-tag"></ds:Object></span>
-<span class="code-tag"></ds:Signature></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
+ <ds:SignedInfo>
+ <ds:CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
+ <ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
+ <ds:Reference URI="#88e688e6-6512-406f-9e88-a58e5d781ff0">
+ <ds:Transforms>
+ <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
+ </ds:Transforms>
+ <ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
+ <ds:DigestValue>Cq3zl3t3DqWTvuZ+4EtZgGs4ikk=</ds:DigestValue>
+ </ds:Reference>
+ </ds:SignedInfo><ds:SignatureValue>NvcCS8vx3YJkc8fHMf8bQkC+lwasC6CwiS7HfKSm8t+6TtYdM7TRbYxSuqfCTkF4vBIldWIzl6UngON592FfJdbvrgE2CusCkIybrP7BBmP7zTSV0GjH4/60L6ObkhGPkMNoKzw4V+zgF7Zo+F7ngsz5ZUWZX/GWETmTtYtcfT0=</ds:SignatureValue>
+ <ds:KeyInfo>
+ <ds:X509Data>
+ <ds:X509Certificate><!-- Omitted for brevity--></ds:X509Certificate>
+ </ds:X509Data>
+ <ds:KeyValue>
+ <ds:RSAKeyValue><ds:Modulus>vu747/VShQ85f16DGSc4Ixh9PVpGguyEqrCsK8q9XHOYX9l9/g5wEC6ZcR2FwfNsoaHcKNPjd5sSTzVtBWmQjfBEfIqwTR7vuihOxyNTwEzVwIJzvo7p8/aYxk+VdBtQxq4UweIcf/iFkUbM1cZ1oiXRQzciRBi+C1BQCQE0qzs=</ds:Modulus>
+ <ds:Exponent>AQAB</ds:Exponent>
+ </ds:RSAKeyValue>
+ </ds:KeyValue>
+ </ds:KeyInfo>
+ <ds:Object ID="88e688e6-6512-406f-9e88-a58e5d781ff0">
+
+ <Book>
+ <id>126</id>
+ <name>CXF</name>
+ </Book>
+ </ds:Object>
+</ds:Signature>
+]]></script>
</div></div>
<p>This time the signature is enveloping the Book element using a ds:Object wrapper which ds:Reference links to.</p>
@@ -323,13 +331,13 @@ Please also check <a shape="rect" href="
<p>Client code is nearly identical to the one shown in the Enveloped signatures section except that XmlSigOutInterceptor need to have an additional property set:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-<span class="code-comment">// add the interceptor dealing with adding a signature
-</span>XmlSigOutInterceptor sigInterceptor = <span class="code-keyword">new</span> XmlSigOutInterceptor();
-sigInterceptor.setStyle(<span class="code-quote">"enveloping"</span>);
+// add the interceptor dealing with adding a signature
+XmlSigOutInterceptor sigInterceptor = new XmlSigOutInterceptor();
+sigInterceptor.setStyle("enveloping");
-</pre>
+]]></script>
</div></div>
<h2><a shape="rect" name="JAX-RSXMLSecurity-Detachedsignatures"></a>Detached signatures</h2>
@@ -337,53 +345,53 @@ sigInterceptor.setStyle(<span class="cod
<p>Payload:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><env:Envelope <span class="code-keyword">xmlns:env</span>=<span class="code-quote">"http://org.apache.cxf/rs/env"</span>></span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<env:Envelope xmlns:env="http://org.apache.cxf/rs/env">
- <span class="code-tag"><Book ID=<span class="code-quote">"e9836bc2-cb5a-453f-b967-a9ddbaf9a6de"</span>></span>
- <span class="code-tag"><id></span>125<span class="code-tag"></id></span>
- <span class="code-tag"><name></span>CXF<span class="code-tag"></name></span>
- <span class="code-tag"></Book></span>
- <span class="code-tag"><ds:Signature <span class="code-keyword">xmlns:ds</span>=<span class="code-quote">"http://www.w3.org/2000/09/xmldsig#"</span>></span>
- <span class="code-tag"><ds:SignedInfo></span>
- <span class="code-tag"><ds:CanonicalizationMethod Algorithm=<span class="code-quote">"http://www.w3.org/TR/2001/REC-xml-c14n-20010315"</span>/></span>
- <span class="code-tag"><ds:SignatureMethod Algorithm=<span class="code-quote">"http://www.w3.org/2000/09/xmldsig#rsa-sha1"</span>/></span>
- <span class="code-tag"><ds:Reference URI=<span class="code-quote">"#e9836bc2-cb5a-453f-b967-a9ddbaf9a6de"</span>></span>
- <span class="code-tag"><ds:Transforms></span>
- <span class="code-tag"><ds:Transform Algorithm=<span class="code-quote">"http://www.w3.org/2001/10/xml-exc-c14n#"</span>/></span>
- <span class="code-tag"></ds:Transforms></span>
- <span class="code-tag"><ds:DigestMethod Algorithm=<span class="code-quote">"http://www.w3.org/2000/09/xmldsig#sha1"</span>/></span>
- <span class="code-tag"><ds:DigestValue></span>Pxz77Hlg6I/MRsJz4gixkaMFtYI=<span class="code-tag"></ds:DigestValue></span>
- <span class="code-tag"></ds:Reference></span>
- <span class="code-tag"></ds:SignedInfo></span>
-<span class="code-tag"><ds:SignatureValue></span>JSwgiVqZT1EtJ9xqtb90juS54pvZguzFMne7cQyGMQDvBW7b65aAAIfVx/PmFB7Tuy4qB4zqNFCzCwHlhDurNP9NYB7PEzFsA3v3vSyEcHnpUhu41xmBvjT5HWEKbuzqX0dHekizuUefbfzG5WpluVPmOgjashrm9DIhfEf+Hyg=<span class="code-tag"></ds:SignatureValue></span>
- <span class="code-tag"><ds:KeyInfo></span>
- <span class="code-tag"><ds:X509Data></span>
- <span class="code-tag"><ds:X509Certificate></span><span class="code-tag"><span class="code-comment"><!--Omitted for Brewity--></span></span><span class="code-tag"></ds:X509Certificate></span>
- <span class="code-tag"></ds:X509Data></span>
- <span class="code-tag"><ds:KeyValue></span>
- <span class="code-tag"><ds:RSAKeyValue></span>
- <span class="code-tag"><ds:Modulus></span>vu747/VShQ85f16DGSc4Ixh9PVpGguyEqrCsK8q9XHOYX9l9/g5wEC6ZcR2FwfNsoaHcKNPjd5sSTzVtBWmQjfBEfIqwTR7vuihOxyNTwEzVwIJzvo7p8/aYxk+VdBtQxq4UweIcf/iFkUbM1cZ1oiXRQzciRBi+C1BQCQE0qzs=<span class="code-tag"></ds:Modulus></span>
- <span class="code-tag"><ds:Exponent></span>AQAB<span class="code-tag"></ds:Exponent></span>
- <span class="code-tag"></ds:RSAKeyValue></span>
- <span class="code-tag"></ds:KeyValue></span>
- <span class="code-tag"></ds:KeyInfo></span>
- <span class="code-tag"></ds:Signature></span>
+ <Book ID="e9836bc2-cb5a-453f-b967-a9ddbaf9a6de">
+ <id>125</id>
+ <name>CXF</name>
+ </Book>
+ <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
+ <ds:SignedInfo>
+ <ds:CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
+ <ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
+ <ds:Reference URI="#e9836bc2-cb5a-453f-b967-a9ddbaf9a6de">
+ <ds:Transforms>
+ <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
+ </ds:Transforms>
+ <ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
+ <ds:DigestValue>Pxz77Hlg6I/MRsJz4gixkaMFtYI=</ds:DigestValue>
+ </ds:Reference>
+ </ds:SignedInfo>
+<ds:SignatureValue>JSwgiVqZT1EtJ9xqtb90juS54pvZguzFMne7cQyGMQDvBW7b65aAAIfVx/PmFB7Tuy4qB4zqNFCzCwHlhDurNP9NYB7PEzFsA3v3vSyEcHnpUhu41xmBvjT5HWEKbuzqX0dHekizuUefbfzG5WpluVPmOgjashrm9DIhfEf+Hyg=</ds:SignatureValue>
+ <ds:KeyInfo>
+ <ds:X509Data>
+ <ds:X509Certificate><!--Omitted for Brewity--></ds:X509Certificate>
+ </ds:X509Data>
+ <ds:KeyValue>
+ <ds:RSAKeyValue>
+ <ds:Modulus>vu747/VShQ85f16DGSc4Ixh9PVpGguyEqrCsK8q9XHOYX9l9/g5wEC6ZcR2FwfNsoaHcKNPjd5sSTzVtBWmQjfBEfIqwTR7vuihOxyNTwEzVwIJzvo7p8/aYxk+VdBtQxq4UweIcf/iFkUbM1cZ1oiXRQzciRBi+C1BQCQE0qzs=</ds:Modulus>
+ <ds:Exponent>AQAB</ds:Exponent>
+ </ds:RSAKeyValue>
+ </ds:KeyValue>
+ </ds:KeyInfo>
+ </ds:Signature>
- <span class="code-tag"><saml2:Assertion <span class="code-keyword">xmlns:saml2</span>=<span class="code-quote">"urn:oasis:names:tc:SAML:2.0:assertion"</span> <span class="code-keyword">xmlns:xs</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema"</span> <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span> ID=<span class="code-quote">"_E462768C678896CE9913202742137181"</span> IssueInstant=<span class="code-quote">"2011-11-02T22:50:13.718Z"</span> Version=<span class="code-quote">"2.0"</span> xsi:type=<span class="code-quote">"saml2:AssertionType"</span>></span>
+ <saml2:Assertion xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ID="_E462768C678896CE9913202742137181" IssueInstant="2011-11-02T22:50:13.718Z" Version="2.0" xsi:type="saml2:AssertionType">
-<span class="code-tag"><saml2:Issuer></span>https://idp.example.org/SAML2<span class="code-tag"></saml2:Issuer></span>
+<saml2:Issuer>https://idp.example.org/SAML2</saml2:Issuer>
-<span class="code-tag"><ds:Signature <span class="code-keyword">xmlns:ds</span>=<span class="code-quote">"http://www.w3.org/2000/09/xmldsig#"</span>></span>
+<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
<!--
Enveloped/embedded SAML Assertion XML Signature is omitted for brevity
See the JAX-RS SAML section for more info
-->
-<span class="code-tag"></ds:Signature></span>
-<span class="code-tag"><span class="code-comment"><!-- the rest of SAML assertion --></span></span>
-<span class="code-tag"></saml2:Assertion></span>
-<span class="code-tag"></env:Envelope></span>
-</pre>
+</ds:Signature>
+<!-- the rest of SAML assertion -->
+</saml2:Assertion>
+</env:Envelope>
+]]></script>
</div></div>
<p>Note that the whole payload is enveloped by a configurable element wrapper. The Book instance is one part of the envelope and it's signed by a detached signature (see the first ds:Signature, with its ds:Reference linking to Book). The envelope also has an embedded SAML assertion which has its own enveloped signature.</p>
@@ -393,13 +401,13 @@ sigInterceptor.setStyle(<span class="cod
<p>Client code is nearly identical to the one shown in the Enveloped signatures section except that XmlSigOutInterceptor need to have an additional property set:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-<span class="code-comment">// add the interceptor dealing with adding a signature
-</span>XmlSigOutInterceptor sigInterceptor = <span class="code-keyword">new</span> XmlSigOutInterceptor();
-sigInterceptor.setStyle(<span class="code-quote">"detached"</span>);
+// add the interceptor dealing with adding a signature
+XmlSigOutInterceptor sigInterceptor = new XmlSigOutInterceptor();
+sigInterceptor.setStyle("detached");
-</pre>
+]]></script>
</div></div>
<h2><a shape="rect" name="JAX-RSXMLSecurity-Customizingthesignature"></a>Customizing the signature</h2>
@@ -419,56 +427,56 @@ The following properties can be set on i
<p>Here is a payload example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><xenc:EncryptedData <span class="code-keyword">xmlns:xenc</span>=<span class="code-quote">"http://www.w3.org/2001/04/xmlenc#"</span>></span>
- <span class="code-tag"><xenc:EncryptionMethod Algorithm=<span class="code-quote">"http://www.w3.org/2001/04/xmlenc#aes128-cbc"</span>/></span>
- <span class="code-tag"><ds:KeyInfo <span class="code-keyword">xmlns:ds</span>=<span class="code-quote">"http://www.w3.org/2000/09/xmldsig#"</span>></span>
- <span class="code-tag"><ds:RetrievalMethod Type=<span class="code-quote">"http://www.w3.org/2001/04/xmlenc#EncryptedKey"</span>/></span>
- <span class="code-tag"><xenc:EncryptedKey Id=<span class="code-quote">"EK-B353DDCEE7C575B6A213203188664772"</span>></span>
- <span class="code-tag"><xenc:EncryptionMethod Algorithm=<span class="code-quote">"http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p"</span>/></span>
- <span class="code-tag"><ds:KeyInfo></span>
- <span class="code-tag"><ds:X509Data></span>
- <span class="code-tag"><ds:X509Certificate></span><span class="code-tag"><span class="code-comment"><!-- Omitted for brevity --></span></span><span class="code-tag"></ds:X509Certificate></span>
- <span class="code-tag"></ds:X509Data></span>
- <span class="code-tag"></ds:KeyInfo></span>
- <span class="code-tag"><xenc:CipherData></span><span class="code-tag"><xenc:CipherValue></span>tPtZz4pnVWquaV2a7O0y+VrHoeWwk3Eu5Jnu3RHz5rGDB/MLyG6rBamhit03J2xWaV52zUtDAPEj8sr4oy5y2KLB09Hu317IbQjinePabUpd+DLnwNn5iHZpHWJPfndkh07JdYZSrMwqOvJ3fqrNJ+LQeLzZDneT8sC1vRyhSDU=<span class="code-tag"></xenc:CipherValue></span>
- <span class="code-tag"></xenc:CipherData></span>
- <span class="code-tag"></xenc:EncryptedKey></span>
- <span class="code-tag"></ds:KeyInfo></span>
- <span class="code-tag"><xenc:CipherData></span>
- <span class="code-tag"><xenc:CipherValue></span>3ZPQ3SapAxemJwqG58sWh+r8B5SMRf/DZ2w/REswgl0zr8kpk0x4tayC5hl7IbSE8CPQYYHX8sXVnUFUoHOtJA==<span class="code-tag"></xenc:CipherValue></span>
- <span class="code-tag"></xenc:CipherData></span>
-<span class="code-tag"></xenc:EncryptedData></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<xenc:EncryptedData xmlns:xenc="http://www.w3.org/2001/04/xmlenc#">
+ <xenc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#aes128-cbc"/>
+ <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
+ <ds:RetrievalMethod Type="http://www.w3.org/2001/04/xmlenc#EncryptedKey"/>
+ <xenc:EncryptedKey Id="EK-B353DDCEE7C575B6A213203188664772">
+ <xenc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p"/>
+ <ds:KeyInfo>
+ <ds:X509Data>
+ <ds:X509Certificate><!-- Omitted for brevity --></ds:X509Certificate>
+ </ds:X509Data>
+ </ds:KeyInfo>
+ <xenc:CipherData><xenc:CipherValue>tPtZz4pnVWquaV2a7O0y+VrHoeWwk3Eu5Jnu3RHz5rGDB/MLyG6rBamhit03J2xWaV52zUtDAPEj8sr4oy5y2KLB09Hu317IbQjinePabUpd+DLnwNn5iHZpHWJPfndkh07JdYZSrMwqOvJ3fqrNJ+LQeLzZDneT8sC1vRyhSDU=</xenc:CipherValue>
+ </xenc:CipherData>
+ </xenc:EncryptedKey>
+ </ds:KeyInfo>
+ <xenc:CipherData>
+ <xenc:CipherValue>3ZPQ3SapAxemJwqG58sWh+r8B5SMRf/DZ2w/REswgl0zr8kpk0x4tayC5hl7IbSE8CPQYYHX8sXVnUFUoHOtJA==</xenc:CipherValue>
+ </xenc:CipherData>
+</xenc:EncryptedData>
+]]></script>
</div></div>
<p>Here is a server configuration fragment:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><bean id=<span class="code-quote">"serviceBean"</span> class=<span class="code-quote">"org.apache.cxf.systest.jaxrs.security.BookStore"</span>/></span>
-<span class="code-tag"><bean id=<span class="code-quote">"xmlSigInHandler"</span> class=<span class="code-quote">"org.apache.cxf.rs.security.xml.XmlSigInHandler"</span>/></span>
-<span class="code-tag"><bean id=<span class="code-quote">"xmlEncInHandler"</span> class=<span class="code-quote">"org.apache.cxf.rs.security.xml.XmlEncInHandler"</span>/></span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<bean id="serviceBean" class="org.apache.cxf.systest.jaxrs.security.BookStore"/>
+<bean id="xmlSigInHandler" class="org.apache.cxf.rs.security.xml.XmlSigInHandler"/>
+<bean id="xmlEncInHandler" class="org.apache.cxf.rs.security.xml.XmlEncInHandler"/>
-<span class="code-tag"><jaxrs:server address=<span class="code-quote">"/xmlsig"</span>></span>
- <span class="code-tag"><jaxrs:serviceBeans></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"serviceBean"</span>/></span>
- <span class="code-tag"></jaxrs:serviceBeans></span>
- <span class="code-tag"><jaxrs:providers></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"xmlEncHandler"</span>/></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"xmlSigHandler"</span>/></span>
- <span class="code-tag"></jaxrs:providers></span>
- <span class="code-tag"><jaxrs:properties></span>
- <entry key=<span class="code-quote">"ws-security.callback-handler"</span>
- value=<span class="code-quote">"org.apache.cxf.systest.jaxrs.security.saml.KeystorePasswordCallback"</span>/>
- <entry key=<span class="code-quote">"ws-security.encryption.properties"</span>
- value=<span class="code-quote">"org/apache/cxf/systest/jaxrs/security/bob.properties"</span>/>
- <entry key=<span class="code-quote">"ws-security.signature.properties"</span>
- value=<span class="code-quote">"org/apache/cxf/systest/jaxrs/security/alice.properties"</span>/>
- <span class="code-tag"></jaxrs:properties></span>
-<span class="code-tag"></jaxrs:server></span>
+<jaxrs:server address="/xmlsig">
+ <jaxrs:serviceBeans>
+ <ref bean="serviceBean"/>
+ </jaxrs:serviceBeans>
+ <jaxrs:providers>
+ <ref bean="xmlEncHandler"/>
+ <ref bean="xmlSigHandler"/>
+ </jaxrs:providers>
+ <jaxrs:properties>
+ <entry key="ws-security.callback-handler"
+ value="org.apache.cxf.systest.jaxrs.security.saml.KeystorePasswordCallback"/>
+ <entry key="ws-security.encryption.properties"
+ value="org/apache/cxf/systest/jaxrs/security/bob.properties"/>
+ <entry key="ws-security.signature.properties"
+ value="org/apache/cxf/systest/jaxrs/security/alice.properties"/>
+ </jaxrs:properties>
+</jaxrs:server>
-</pre>
+]]></script>
</div></div>
<p>This configuration supports receiving signed and then encrypted XML payloads.</p>
@@ -476,43 +484,43 @@ The following properties can be set on i
<p>The code:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-object">String</span> address = <span class="code-quote">"https:<span class="code-comment">//localhost:8080/xmlencryption/bookstore/books"</span>;
-</span>JAXRSClientFactoryBean bean = <span class="code-keyword">new</span> JAXRSClientFactoryBean();
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+String address = "https://localhost:8080/xmlencryption/bookstore/books";
+JAXRSClientFactoryBean bean = new JAXRSClientFactoryBean();
bean.setAddress(address);
-<span class="code-comment">// setup properties
-</span>Map<<span class="code-object">String</span>, <span class="code-object">Object</span>> properties = <span class="code-keyword">new</span> HashMap<<span class="code-object">String</span>, <span class="code-object">Object</span>>();
+// setup properties
+Map<String, Object> properties = new HashMap<String, Object>();
-properties.put(<span class="code-quote">"ws-security.callback-handler"</span>,
- <span class="code-quote">"org.apache.cxf.systest.jaxrs.security.saml.KeystorePasswordCallback"</span>);
-properties.put(<span class="code-quote">"ws-security.encryption.username"</span>, <span class="code-quote">"bob"</span>);
-properties.put(<span class="code-quote">"ws-security.encryption.properties"</span>,
- <span class="code-quote">"org/apache/cxf/systest/jaxrs/security/bob.properties"</span>);
-
-<span class="code-comment">// <span class="code-keyword">if</span> signature required:
-</span>properties.put(<span class="code-quote">"ws-security.signature.username"</span>, <span class="code-quote">"alice"</span>);
-properties.put(<span class="code-quote">"ws-security.signature.properties"</span>,
- <span class="code-quote">"org/apache/cxf/systest/jaxrs/security/alice.properties"</span>);
+properties.put("ws-security.callback-handler",
+ "org.apache.cxf.systest.jaxrs.security.saml.KeystorePasswordCallback");
+properties.put("ws-security.encryption.username", "bob");
+properties.put("ws-security.encryption.properties",
+ "org/apache/cxf/systest/jaxrs/security/bob.properties");
+
+// if signature required:
+properties.put("ws-security.signature.username", "alice");
+properties.put("ws-security.signature.properties",
+ "org/apache/cxf/systest/jaxrs/security/alice.properties");
bean.setProperties(properties);
-<span class="code-comment">// <span class="code-keyword">if</span> signature required: add the interceptor dealing with adding a signature
-</span>XmlSigOutInterceptor sigInterceptor = <span class="code-keyword">new</span> XmlSigOutInterceptor();
+// if signature required: add the interceptor dealing with adding a signature
+XmlSigOutInterceptor sigInterceptor = new XmlSigOutInterceptor();
bean.getOutInterceptors().add(sigInterceptor);
-<span class="code-comment">// add the interceptor dealing with the encryption
-</span>
-XmlEncOutInterceptor encInterceptor = <span class="code-keyword">new</span> XmlEncOutInterceptor();
-encInterceptor.setSymmetricEncAlgorithm(<span class="code-quote">"http:<span class="code-comment">//www.w3.org/2001/04/xmlenc#aes128-cbc"</span>);
-</span>bean.getOutInterceptors().add(encInterceptor);
+// add the interceptor dealing with the encryption
+
+XmlEncOutInterceptor encInterceptor = new XmlEncOutInterceptor();
+encInterceptor.setSymmetricEncAlgorithm("http://www.w3.org/2001/04/xmlenc#aes128-cbc");
+bean.getOutInterceptors().add(encInterceptor);
-<span class="code-comment">// use WebClient (or proxy) as usual
-</span>WebClient wc = bean.createWebClient();
-Response r = wc.post(<span class="code-keyword">new</span> Book(<span class="code-quote">"CXF"</span>, 126L), Book.class);
+// use WebClient (or proxy) as usual
+WebClient wc = bean.createWebClient();
+Response r = wc.post(new Book("CXF", 126L), Book.class);
assertEquals(200, r.getStatus());
-</pre>
+]]></script>
</div></div>
<p>Note that XmlEncOutInterceptor interceptor has a "symmetricEncAlgorithm" property set to a weaker type just to get CXF tests passing.</p>
@@ -520,51 +528,51 @@ assertEquals(200, r.getStatus());
<p>The actual application client code does not expect a payload such as Book back but if it did then configuring the server to encrypt the response would be straightforward:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><bean id=<span class="code-quote">"serviceBean"</span> class=<span class="code-quote">"org.apache.cxf.systest.jaxrs.security.BookStore"</span>/></span>
-<span class="code-tag"><bean id=<span class="code-quote">"xmlSigInHandler"</span> class=<span class="code-quote">"org.apache.cxf.rs.security.xml.XmlSigInHandler"</span>/></span>
-<span class="code-tag"><bean id=<span class="code-quote">"xmlSigOutHandler"</span> class=<span class="code-quote">"org.apache.cxf.rs.security.xml.XmlSigOutInterceptor"</span>/></span>
-
-<span class="code-tag"><bean id=<span class="code-quote">"xmlEncInHandler"</span> class=<span class="code-quote">"org.apache.cxf.rs.security.xml.XmlEncInHandler"</span>/></span>
-<span class="code-tag"><bean id=<span class="code-quote">"xmlEncOutHandler"</span> class=<span class="code-quote">"org.apache.cxf.rs.security.xml.XmlEncOutInterceptor"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"symmetricEncAlgorithm"</span> value=<span class="code-quote">"aes128-cbc"</span>/></span>
-<span class="code-tag"></bean></span>
-
-<span class="code-tag"><jaxrs:server address=<span class="code-quote">"/xmlsec"</span>></span>
- <span class="code-tag"><jaxrs:serviceBeans></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"serviceBean"</span>/></span>
- <span class="code-tag"></jaxrs:serviceBeans></span>
- <span class="code-tag"><jaxrs:providers></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"xmlEncInHandler"</span>/></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"xmlSigInHandler"</span>/></span>
- <span class="code-tag"></jaxrs:providers></span>
- <span class="code-tag"><jaxrs:outInterceptors></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"xmlSigOutHandler"</span>/></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"xmlEncOutHandler"</span>/></span>
- <span class="code-tag"></jaxrs:outInterceptors></span>
- <span class="code-tag"><jaxrs:properties></span>
- <entry key=<span class="code-quote">"ws-security.callback-handler"</span>
- value=<span class="code-quote">"org.apache.cxf.systest.jaxrs.security.saml.KeystorePasswordCallback"</span>/>
- <entry key=<span class="code-quote">"ws-security.encryption.properties"</span>
- value=<span class="code-quote">"org/apache/cxf/systest/jaxrs/security/alice.properties"</span>/>
- <entry key=<span class="code-quote">"ws-security.signature.properties"</span>
- value=<span class="code-quote">"org/apache/cxf/systest/jaxrs/security/bob.properties"</span>/>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<bean id="serviceBean" class="org.apache.cxf.systest.jaxrs.security.BookStore"/>
+<bean id="xmlSigInHandler" class="org.apache.cxf.rs.security.xml.XmlSigInHandler"/>
+<bean id="xmlSigOutHandler" class="org.apache.cxf.rs.security.xml.XmlSigOutInterceptor"/>
+
+<bean id="xmlEncInHandler" class="org.apache.cxf.rs.security.xml.XmlEncInHandler"/>
+<bean id="xmlEncOutHandler" class="org.apache.cxf.rs.security.xml.XmlEncOutInterceptor">
+ <property name="symmetricEncAlgorithm" value="aes128-cbc"/>
+</bean>
+
+<jaxrs:server address="/xmlsec">
+ <jaxrs:serviceBeans>
+ <ref bean="serviceBean"/>
+ </jaxrs:serviceBeans>
+ <jaxrs:providers>
+ <ref bean="xmlEncInHandler"/>
+ <ref bean="xmlSigInHandler"/>
+ </jaxrs:providers>
+ <jaxrs:outInterceptors>
+ <ref bean="xmlSigOutHandler"/>
+ <ref bean="xmlEncOutHandler"/>
+ </jaxrs:outInterceptors>
+ <jaxrs:properties>
+ <entry key="ws-security.callback-handler"
+ value="org.apache.cxf.systest.jaxrs.security.saml.KeystorePasswordCallback"/>
+ <entry key="ws-security.encryption.properties"
+ value="org/apache/cxf/systest/jaxrs/security/alice.properties"/>
+ <entry key="ws-security.signature.properties"
+ value="org/apache/cxf/systest/jaxrs/security/bob.properties"/>
- <span class="code-tag"></jaxrs:properties></span>
-<span class="code-tag"></jaxrs:server></span>
-</pre>
+ </jaxrs:properties>
+</jaxrs:server>
+]]></script>
</div></div>
<p>Now the client code can be updated to expect an encrypted and signed Book back:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-comment">// Use the previous code fragment, add the in interceptors:
-</span>XmlEncInInterceptor encInInterceptor = <span class="code-keyword">new</span> XmlEncInInterceptor();
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+// Use the previous code fragment, add the in interceptors:
+XmlEncInInterceptor encInInterceptor = new XmlEncInInterceptor();
bean.getInInterceptors().add(encInInterceptor);
-XmlSigInInterceptor sigInInterceptor = <span class="code-keyword">new</span> XmlSigInInterceptor();
+XmlSigInInterceptor sigInInterceptor = new XmlSigInInterceptor();
bean.getInInterceptors().add(sigInInterceptor);
-</pre>
+]]></script>
</div></div>
@@ -575,33 +583,33 @@ bean.getInInterceptors().add(sigInInterc
<p>When multiple clients are posting the encrypted and signed payloads, the following configuration will lead to the request signature certificates being utilized for encrypting the symmetric key used to encrypt the response:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><span class="code-comment"><!-- server --></span></span>
-<span class="code-tag"><jaxrs:server></span>
-<span class="code-tag"><jaxrs:properties></span>
- <entry key=<span class="code-quote">"ws-security.callback-handler"</span>
- value=<span class="code-quote">"org.apache.cxf.systest.jaxrs.security.saml.KeystorePasswordCallback"</span>/>
- <entry key=<span class="code-quote">"ws-security.encryption.properties"</span>
- value=<span class="code-quote">"org/apache/cxf/systest/jaxrs/security/alice.properties"</span>/>
- <span class="code-tag"><entry key=<span class="code-quote">"ws-security.encryption.username"</span> value=<span class="code-quote">"useReqSigCert"</span>/></span>
- <entry key=<span class="code-quote">"ws-security.signature.properties"</span>
- value=<span class="code-quote">"org/apache/cxf/systest/jaxrs/security/bob.properties"</span>/>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<!-- server -->
+<jaxrs:server>
+<jaxrs:properties>
+ <entry key="ws-security.callback-handler"
+ value="org.apache.cxf.systest.jaxrs.security.saml.KeystorePasswordCallback"/>
+ <entry key="ws-security.encryption.properties"
+ value="org/apache/cxf/systest/jaxrs/security/alice.properties"/>
+ <entry key="ws-security.encryption.username" value="useReqSigCert"/>
+ <entry key="ws-security.signature.properties"
+ value="org/apache/cxf/systest/jaxrs/security/bob.properties"/>
- <span class="code-tag"></jaxrs:properties></span>
-<span class="code-tag"></jaxrs:server></span>
-<span class="code-tag"><jaxrs:client></span>
- <span class="code-tag"><jaxrs:properties></span>
- <entry key=<span class="code-quote">"ws-security.callback-handler"</span>
- value=<span class="code-quote">"org.apache.cxf.systest.jaxrs.security.saml.KeystorePasswordCallback"</span>/>
- <entry key=<span class="code-quote">"ws-security.encryption.properties"</span>
- value=<span class="code-quote">"org/apache/cxf/systest/jaxrs/security/bob.properties"</span>/>
- <span class="code-tag"><entry key=<span class="code-quote">"ws-security.encryption.username"</span> value=<span class="code-quote">"bob"</span>/></span>
- <entry key=<span class="code-quote">"ws-security.signature.properties"</span>
- value=<span class="code-quote">"org/apache/cxf/systest/jaxrs/security/alice.properties"</span>/>
- <span class="code-tag"><entry key=<span class="code-quote">"ws-security.signature.username"</span> value=<span class="code-quote">"alice"</span>/></span>
- <span class="code-tag"></jaxrs:properties></span>
-<span class="code-tag"></jaxrs:client></span>
-</pre>
+ </jaxrs:properties>
+</jaxrs:server>
+<jaxrs:client>
+ <jaxrs:properties>
+ <entry key="ws-security.callback-handler"
+ value="org.apache.cxf.systest.jaxrs.security.saml.KeystorePasswordCallback"/>
+ <entry key="ws-security.encryption.properties"
+ value="org/apache/cxf/systest/jaxrs/security/bob.properties"/>
+ <entry key="ws-security.encryption.username" value="bob"/>
+ <entry key="ws-security.signature.properties"
+ value="org/apache/cxf/systest/jaxrs/security/alice.properties"/>
+ <entry key="ws-security.signature.username" value="alice"/>
+ </jaxrs:properties>
+</jaxrs:client>
+]]></script>
</div></div>
<p>The "ws-security.encryption.username" server property is set to "useReqSigCert".</p>
@@ -631,42 +639,42 @@ The following properties can be set on i
<p>It is possible to configure the in encryption and signature handlers with the properties restricting the encryption and signature algorithms that clients can use, for example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><bean id=<span class="code-quote">"sigProps"</span> class=<span class="code-quote">"org.apache.cxf.rs.security.xml.SignatureProperties"</span>></span>
- <property name=<span class="code-quote">"signatureAlgo"</span>
- value=<span class="code-quote">"http://www.w3.org/2000/09/xmldsig#rsa-sha1"</span>/>
- <property name=<span class="code-quote">"signatureDigestAlgo"</span>
- value=<span class="code-quote">"http://www.w3.org/2000/09/xmldsig#sha1"</span>/>
- <property name=<span class="code-quote">"signatureC14Method"</span>
- value=<span class="code-quote">"http://www.w3.org/TR/2001/REC-xml-c14n-20010315"</span>/>
- <property name=<span class="code-quote">"signatureC14Transform"</span>
- value=<span class="code-quote">"http://www.w3.org/2001/10/xml-exc-c14n#"</span>/>
- <span class="code-tag"></bean></span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <bean id="sigProps" class="org.apache.cxf.rs.security.xml.SignatureProperties">
+ <property name="signatureAlgo"
+ value="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
+ <property name="signatureDigestAlgo"
+ value="http://www.w3.org/2000/09/xmldsig#sha1"/>
+ <property name="signatureC14Method"
+ value="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
+ <property name="signatureC14Transform"
+ value="http://www.w3.org/2001/10/xml-exc-c14n#"/>
+ </bean>
- <span class="code-tag"><bean id=<span class="code-quote">"encProps"</span> class=<span class="code-quote">"org.apache.cxf.rs.security.xml.EncryptionProperties"</span>></span>
- <property name=<span class="code-quote">"encryptionKeyTransportAlgo"</span>
- value=<span class="code-quote">"http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p"</span>/>
- <property name=<span class="code-quote">"encryptionSymmetricKeyAlgo"</span>
- value=<span class="code-quote">"http://www.w3.org/2001/04/xmlenc#aes128-cbc"</span>/>
- <span class="code-tag"></bean></span>
+ <bean id="encProps" class="org.apache.cxf.rs.security.xml.EncryptionProperties">
+ <property name="encryptionKeyTransportAlgo"
+ value="http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p"/>
+ <property name="encryptionSymmetricKeyAlgo"
+ value="http://www.w3.org/2001/04/xmlenc#aes128-cbc"/>
+ </bean>
- <span class="code-tag"><bean id=<span class="code-quote">"xmlSigInHandlerWithProps"</span> class=<span class="code-quote">"org.apache.cxf.rs.security.xml.XmlSigInHandler"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"signatureProperties"</span> ref=<span class="code-quote">"sigProps"</span>/></span>
- <span class="code-tag"></bean></span>
+ <bean id="xmlSigInHandlerWithProps" class="org.apache.cxf.rs.security.xml.XmlSigInHandler">
+ <property name="signatureProperties" ref="sigProps"/>
+ </bean>
- <span class="code-tag"><bean id=<span class="code-quote">"xmlEncInHandlerWithProps"</span> class=<span class="code-quote">"org.apache.cxf.rs.security.xml.XmlEncInHandler"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"encryptionProperties"</span> ref=<span class="code-quote">"encProps"</span>/></span>
- <span class="code-tag"></bean></span>
-
- <span class="code-tag"><span class="code-comment"><!-- the following ensures that the outbound handlers will use the same algorithms that the client used --></span></span>
- <span class="code-tag"><bean id=<span class="code-quote">"xmlSigOutHandlerWithProps"</span> class=<span class="code-quote">"org.apache.cxf.rs.security.xml.XmlSigOutInterceptor"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"signatureProperties"</span> ref=<span class="code-quote">"sigProps"</span>/></span>
- <span class="code-tag"></bean></span>
+ <bean id="xmlEncInHandlerWithProps" class="org.apache.cxf.rs.security.xml.XmlEncInHandler">
+ <property name="encryptionProperties" ref="encProps"/>
+ </bean>
+
+ <!-- the following ensures that the outbound handlers will use the same algorithms that the client used -->
+ <bean id="xmlSigOutHandlerWithProps" class="org.apache.cxf.rs.security.xml.XmlSigOutInterceptor">
+ <property name="signatureProperties" ref="sigProps"/>
+ </bean>
- <span class="code-tag"><bean id=<span class="code-quote">"xmlEncOutHandlerWithProps"</span> class=<span class="code-quote">"org.apache.cxf.rs.security.xml.XmlEncOutInterceptor"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"encryptionProperties"</span> ref=<span class="code-quote">"encProps"</span>/></span>
- <span class="code-tag"></bean></span>
-</pre>
+ <bean id="xmlEncOutHandlerWithProps" class="org.apache.cxf.rs.security.xml.XmlEncOutInterceptor">
+ <property name="encryptionProperties" ref="encProps"/>
+ </bean>
+]]></script>
</div></div>
<p>Getting the same SignatureProperties and EncryptionProperties beans (with "sigProps" and "encProps" ids) registered with the outbound<br clear="none">
Modified: websites/production/cxf/content/docs/jax-rs.html
==============================================================================
--- websites/production/cxf/content/docs/jax-rs.html (original)
+++ websites/production/cxf/content/docs/jax-rs.html Mon Jun 24 17:10:51 2013
@@ -25,6 +25,18 @@
<meta http-equiv="Content-type" content="text/html;charset=UTF-8">
<meta name="keywords" content="business integration, EAI, SOA, Service Oriented Architecture, web services, SOAP, JBI, JMS, WSDL, XML, EDI, Electronic Data Interchange, standards support, integration standards, application integration, middleware, software, solutions, services, CXF, open source">
<meta name="description" content="Apache CXF, Services Framework - JAX-RS">
+
+ <link href='http://cxf.apache.org/resources/highlighter/styles/shCore.css' rel='stylesheet' type='text/css' />
+ <link href='http://cxf.apache.org/resources/highlighter/styles/shThemeCXF.css' rel='stylesheet' type='text/css' />
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shCore.js' type='text/javascript'></script>
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shBrushXml.js' type='text/javascript'></script>
+
+ <script type="text/javascript">
+ SyntaxHighlighter.defaults['toolbar'] = false;
+ SyntaxHighlighter.all();
+ </script>
+
<title>
Apache CXF -- JAX-RS
</title>
@@ -42,19 +54,15 @@ Apache CXF -- JAX-RS
<td id="cell-1-0"> </td>
<td id="cell-1-1"> </td>
<td id="cell-1-2">
- <div style="padding: 5px;">
- <div id="banner">
- <!-- Banner -->
-<div id="banner-content">
+ <!-- Banner -->
+<div class="banner" id="banner"><p>
<table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td align="left" colspan="1" nowrap>
<a shape="rect" href="http://cxf.apache.org/" title="Apache CXF"><span style="font-weight: bold; font-size: 170%; color: white">Apache CXF</span></a>
</td><td align="right" colspan="1" nowrap>
<a shape="rect" href="http://www.apache.org/" title="The Apache Sofware Foundation"><img border="0" alt="ASF Logo" src="http://cxf.apache.org/images/asf-logo.png"></a>
</td></tr></table>
-</div>
- <!-- Banner -->
- </div>
- </div>
+</p></div>
+ <!-- Banner -->
<div id="top-menu">
<table border="0" cellpadding="1" cellspacing="0" width="100%">
<tr>
@@ -94,7 +102,7 @@ Apache CXF -- JAX-RS
<hr>
-<ul class="alternate" type="square"><li>Search
+<ul class="alternate" type="square"><li>Search<br clear="none">
<form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
<div>
@@ -171,13 +179,13 @@ There have been just a few minor modific
<p>The cxf-rt-frontend-jaxrs dependency is required:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><dependency></span>
- <span class="code-tag"><groupId></span>org.apache.cxf<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>cxf-rt-frontend-jaxrs<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>${cxf.version}<span class="code-tag"></version></span>
- <span class="code-tag"></dependency></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <dependency>
+ <groupId>org.apache.cxf</groupId>
+ <artifactId>cxf-rt-frontend-jaxrs</artifactId>
+ <version>${cxf.version}</version>
+ </dependency>
+]]></script>
</div></div>
<p>This will in turn pull in other <a shape="rect" href="http://cxf.apache.org/project-status.html">CXF modules</a> such <tt>cxf-api</tt>, <tt>cxf-rt-core</tt>, <tt>cxf-rt-transports-http</tt> and <tt>cxf-rt-bindings-xml</tt> as well as <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/rt/frontend/jaxrs/pom.xml">the following 3rd-party dependencies</a>.</p>
@@ -197,25 +205,25 @@ There have been just a few minor modific
<p>Optional providers (including the default JSONProvider) are located in this module:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><dependency></span>
- <span class="code-tag"><groupId></span>org.apache.cxf<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>cxf-rt-rs-extension-providers<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>2.6.0<span class="code-tag"></version></span>
- <span class="code-tag"></dependency></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <dependency>
+ <groupId>org.apache.cxf</groupId>
+ <artifactId>cxf-rt-rs-extension-providers</artifactId>
+ <version>2.6.0</version>
+ </dependency>
+]]></script>
</div></div>
<p>The Search extension is now located in</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><dependency></span>
- <span class="code-tag"><groupId></span>org.apache.cxf<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>cxf-rt-rs-extension-search<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>2.6.0<span class="code-tag"></version></span>
- <span class="code-tag"></dependency></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <dependency>
+ <groupId>org.apache.cxf</groupId>
+ <artifactId>cxf-rt-rs-extension-search</artifactId>
+ <version>2.6.0</version>
+ </dependency>
+]]></script>
</div></div>
<h3><a shape="rect" name="JAX-RS-CXF2.5.xCXF2.3.x"></a>CXF 2.5.x - CXF 2.3.x</h3>
@@ -231,30 +239,30 @@ There have been just a few minor modific
<p><b>Note that starting from CXF 2.4.x the <tt>cxf-rt-databindings-aegis</tt> and <tt>org.apache.xmlbeans/xmlbeans/2.4.0</tt> dependencies are optional</b>. If you are not working with the CXF distributions containing these dependencies but using Maven to pull in either the CXF JAX-RS Bundle or the <tt>cxf-rt-frontend-jaxrs</tt> frontend then please make sure one of the following dependencies are also included:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><dependency></span>
- <span class="code-tag"><groupId></span>org.apache.cxf<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>cxf-rt-databinding-aegis<span class="code-tag"></artifactId></span>
- <span class="code-tag"><span class="code-comment"><!-- 2.4.4 or 2.5.0 --></span></span>
- <span class="code-tag"><version></span>${cxf.version}<span class="code-tag"></version></span>
- <span class="code-tag"></dependency></span>
- <span class="code-tag"><dependency></span>
- <span class="code-tag"><groupId></span>org.apache.xmlbeans<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>xmlbeans<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>2.4.0<span class="code-tag"></version></span>
- <span class="code-tag"></dependency></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <dependency>
+ <groupId>org.apache.cxf</groupId>
+ <artifactId>cxf-rt-databinding-aegis</artifactId>
+ <!-- 2.4.4 or 2.5.0 -->
+ <version>${cxf.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.xmlbeans</groupId>
+ <artifactId>xmlbeans</artifactId>
+ <version>2.4.0</version>
+ </dependency>
+]]></script>
</div></div>
<p><b>Starting from CXF 2.4.0</b> the wsdl4j transitive dependency is only required for running the CXF JAX-RS client code due to one of the HTTP transport extensions indirectly depending on wsdl4j. When running the server endpoints only, you can add the wsdl4j exclusion to either cxf-frontend-jaxrs or cxf-bundle-jaxrs dependency: </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><exclusion></span>
- <span class="code-tag"><groupId></span>wsdl4j<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>wsdl4j<span class="code-tag"></artifactId></span>
-<span class="code-tag"></exclusion></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<exclusion>
+ <groupId>wsdl4j</groupId>
+ <artifactId>wsdl4j</artifactId>
+</exclusion>
+]]></script>
</div></div>
<p>Please check the <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/rt/frontend/jaxrs/pom.xml">pom.xml</a> for the list of cxf components used by the JAX-RS implementation. Snapshots are available from <a shape="rect" class="external-link" href="http://repository.apache.org/snapshots/org/apache/cxf/apache-cxf/">http://repository.apache.org/snapshots/org/apache/cxf/apache-cxf/</a>.</p>
@@ -293,20 +301,20 @@ There have been just a few minor modific
<p>Please note that this bundle has a transitive Maven dependency on the Jetty server modules. If you are using Maven and working with other servlet containers such as Tomcat then please add the following exclusion:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><dependency></span>
- <span class="code-tag"><groupId></span>org.apache.cxf<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>cxf-bundle-jaxrs<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>${cxf.version}<span class="code-tag"></version></span>
- <span class="code-tag"><exclusions></span>
- <span class="code-tag"><exclusion></span>
- <span class="code-tag"><groupId></span>org.eclipse.jetty<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>jetty-server<span class="code-tag"></artifactId></span>
- <span class="code-tag"></exclusion></span>
- <span class="code-tag"></exclusions></span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <dependency>
+ <groupId>org.apache.cxf</groupId>
+ <artifactId>cxf-bundle-jaxrs</artifactId>
+ <version>${cxf.version}</version>
+ <exclusions>
+ <exclusion>
+ <groupId>org.eclipse.jetty</groupId>
+ <artifactId>jetty-server</artifactId>
+ </exclusion>
+ </exclusions>
- <span class="code-tag"></dependency></span>
-</pre>
+ </dependency>
+]]></script>
</div></div>
<h1><a shape="rect" name="JAX-RS-WhatisNew"></a>What is New</h1>
@@ -381,21 +389,21 @@ Please see the <a shape="rect" class="ex
<p>The runtime will replace '.xml' or '.en' with an appropriate header value. For it to know the type or language value associated with a given URI suffix, some configuration needs to be done. Here's an example of how it can be done with Spring:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
- <span class="code-tag"><jaxrs:server id=<span class="code-quote">"customerService"</span> address=<span class="code-quote">"/"</span>></span>
- <span class="code-tag"><jaxrs:serviceBeans></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.jaxrs.systests.CustomerService"</span> /></span>
- <span class="code-tag"></jaxrs:serviceBeans></span>
- <span class="code-tag"><jaxrs:extensionMappings></span>
- <span class="code-tag"><entry key=<span class="code-quote">"json"</span> value=<span class="code-quote">"application/json"</span>/></span>
- <span class="code-tag"><entry key=<span class="code-quote">"xml"</span> value=<span class="code-quote">"application/xml"</span>/></span>
- <span class="code-tag"></jaxrs:extensionMappings></span>
- <span class="code-tag"><jaxrs:languageMappings></span>
- <span class="code-tag"><entry key=<span class="code-quote">"en"</span> value=<span class="code-quote">"en-gb"</span>/></span>
- <span class="code-tag"></jaxrs:languageMappings></span>
- <span class="code-tag"></jaxrs:server></span>
-</pre>
+ <jaxrs:server id="customerService" address="/">
+ <jaxrs:serviceBeans>
+ <bean class="org.apache.cxf.jaxrs.systests.CustomerService" />
+ </jaxrs:serviceBeans>
+ <jaxrs:extensionMappings>
+ <entry key="json" value="application/json"/>
+ <entry key="xml" value="application/xml"/>
+ </jaxrs:extensionMappings>
+ <jaxrs:languageMappings>
+ <entry key="en" value="en-gb"/>
+ </jaxrs:languageMappings>
+ </jaxrs:server>
+]]></script>
</div></div>
<p>CXF also supports a _type query as an alternative to appending extensions like '.xml' to request URIs:</p>
@@ -422,17 +430,17 @@ by Java HTTPUrlConnection. When needed,
<p>Many of the existing CXF features can be applied either to <tt>jaxrs:server</tt> or <tt>jaxrs:client</tt>. For example, to enable logging of requests and responses, simply do:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<beans <span class="code-keyword">xmlns:cxf</span>=<span class="code-quote">"http://cxf.apache.org/core"</span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<beans xmlns:cxf="http://cxf.apache.org/core"
xsi:schemaLocation="http://cxf.apache.org/core
http://cxf.apache.org/schemas/core.xsd">
-<span class="code-tag"><jaxrs:server></span>
-<span class="code-tag"><jaxrs:features></span>
- <span class="code-tag"><cxf:logging/></span>
-<span class="code-tag"></jaxrs:features></span>
-<span class="code-tag"><jaxrs:server></span>
-<span class="code-tag"></beans></span>
-</pre>
+<jaxrs:server>
+<jaxrs:features>
+ <cxf:logging/>
+</jaxrs:features>
+<jaxrs:server>
+</beans>
+]]></script>
</div></div>
<p>Please make sure the <tt><a shape="rect" href="http://cxf.apache.org/core">http://cxf.apache.org/core</a></tt> namespace is in scope.</p>