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 [21/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-data-bindings.html
==============================================================================
--- websites/production/cxf/content/docs/jax-rs-data-bindings.html (original)
+++ websites/production/cxf/content/docs/jax-rs-data-bindings.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 Data Bindings">
+
+ <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 Data Bindings
</title>
@@ -42,19 +54,15 @@ Apache CXF -- JAX-RS Data Bindings
<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 Data Bindings
<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,81 +143,81 @@ Apache CXF -- JAX-RS Data Bindings
<p>For example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-@XmlRootElement(name = <span class="code-quote">"Customer"</span>)
-<span class="code-keyword">public</span> class Customer {
- <span class="code-keyword">private</span> <span class="code-object">String</span> name;
- <span class="code-keyword">private</span> <span class="code-object">long</span> id;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+@XmlRootElement(name = "Customer")
+public class Customer {
+ private String name;
+ private long id;
- <span class="code-keyword">public</span> Customer() {
+ public Customer() {
}
- <span class="code-keyword">public</span> void setName(<span class="code-object">String</span> n) {
+ public void setName(String n) {
name = n;
}
- <span class="code-keyword">public</span> <span class="code-object">String</span> getName() {
- <span class="code-keyword">return</span> name;
+ public String getName() {
+ return name;
}
- <span class="code-keyword">public</span> void setId(<span class="code-object">long</span> i) {
+ public void setId(long i) {
id = i;
}
- <span class="code-keyword">public</span> <span class="code-object">long</span> getId() {
- <span class="code-keyword">return</span> id;
+ public long getId() {
+ return id;
}
}
-</pre>
+]]></script>
</div></div>
<p>In the example below, the Customer object returned by getCustomer is marshaled using JAXB data binding:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-@Path(<span class="code-quote">"/customerservice/"</span>)
-<span class="code-keyword">public</span> class CustomerService {
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+@Path("/customerservice/")
+public class CustomerService {
@GET
- @Path(<span class="code-quote">"/customers/{customerId}/"</span>)
- <span class="code-keyword">public</span> Customer getCustomer(@PathParam(<span class="code-quote">"customerId"</span>) <span class="code-object">String</span> id) {
+ @Path("/customers/{customerId}/")
+ public Customer getCustomer(@PathParam("customerId") String id) {
....
}
}
-</pre>
+]]></script>
</div></div>
<p>The wire representation of Customer object is:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><Customer></span>
- <span class="code-tag"><id></span>123<span class="code-tag"></id></span>
- <span class="code-tag"><name></span>John<span class="code-tag"></name></span>
-<span class="code-tag"></Customer></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<Customer>
+ <id>123</id>
+ <name>John</name>
+</Customer>
+]]></script>
</div></div>
<p>The simplest way to work with the collections is to define a type representing a collection. For example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-@XmlRootElement(name = <span class="code-quote">"Customers"</span>)
-<span class="code-keyword">public</span> class Customers {
- <span class="code-keyword">private</span> Collection<Customer> customers;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+@XmlRootElement(name = "Customers")
+public class Customers {
+ private Collection<Customer> customers;
- <span class="code-keyword">public</span> Collection<Customer> getCustomer() {
- <span class="code-keyword">return</span> customers;
+ public Collection<Customer> getCustomer() {
+ return customers;
}
- <span class="code-keyword">public</span> void setCustomer(Collection<Customer> c) {
- <span class="code-keyword">this</span>.customers = c;
+ public void setCustomer(Collection<Customer> c) {
+ this.customers = c;
}
}
-@Path(<span class="code-quote">"/customerservice/"</span>)
-<span class="code-keyword">public</span> class CustomerService {
+@Path("/customerservice/")
+public class CustomerService {
@GET
- @Path(<span class="code-quote">"/customers/"</span>)
- <span class="code-keyword">public</span> Customers getCustomers() {
+ @Path("/customers/")
+ public Customers getCustomers() {
....
}
}
-</pre>
+]]></script>
</div></div>
<p>Alternatively to using @XmlRootElement and Collection wrappers, one can provide an Object factory which will tell JAXB how to marshal a given type (in case of Collections - its template type). Another option is to return/accept a JAXBElement directly from/in a given method.</p>
@@ -223,18 +231,18 @@ Apache CXF -- JAX-RS Data Bindings
<p>The default JAXB provider can be configured in a number of ways. For example, here's how to set up marshall properties :</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><beans <span class="code-keyword">xmlns:util</span>=<span class="code-quote">"http://www.springframework.org/schema/util"</span>></span>
-<span class="code-tag"><bean id=<span class="code-quote">"jaxbProvider"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.JAXBElementProvider"</span>></span>
-<span class="code-tag"><property name=<span class="code-quote">"marshallerProperties"</span> ref=<span class="code-quote">"propertiesMap"</span>/></span>
-<span class="code-tag"></bean></span>
-<span class="code-tag"><util:map id=<span class="code-quote">"propertiesMap"</span>></span>
-<span class="code-tag"><entry key=<span class="code-quote">"jaxb.formatted.output"</span>></span>
- <span class="code-tag"><value type=<span class="code-quote">"java.lang.Boolean"</span>></span>true<span class="code-tag"></value></span>
-<span class="code-tag"></entry></span>
-<span class="code-tag"></util:map></span>
-/<span class="code-tag"><beans></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<beans xmlns:util="http://www.springframework.org/schema/util">
+<bean id="jaxbProvider" class="org.apache.cxf.jaxrs.provider.JAXBElementProvider">
+<property name="marshallerProperties" ref="propertiesMap"/>
+</bean>
+<util:map id="propertiesMap">
+<entry key="jaxb.formatted.output">
+ <value type="java.lang.Boolean">true</value>
+</entry>
+</util:map>
+/<beans>
+]]></script>
</div></div>
<p>Individual marshal properties can be injected as simple properties. At the moment, Marshaller.JAXB_SCHEMA_LOCATION can be injected as "schemaLocation" property. Schema validation can be enabled and custom @Consume and @Produce media types can be injected, see <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/systests/jaxrs/src/test/resources/jaxrs/WEB-INF/beans.xml">this example</a> and "Customizing media types for message body providers" and "Schema Validation" sections for more information. </p>
@@ -260,16 +268,16 @@ If Moxy is used to handle beans without
<p>Following code returns a Customer object that is marshaled to JSON format:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-@Path(<span class="code-quote">"/customerservice/"</span>)
-<span class="code-keyword">public</span> class CustomerService {
- @Produces(<span class="code-quote">"application/json"</span>)
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+@Path("/customerservice/")
+public class CustomerService {
+ @Produces("application/json")
@GET
- @Path(<span class="code-quote">"/customers/{customerId}/"</span>)
- <span class="code-keyword">public</span> Customer getCustomer(@PathParam(<span class="code-quote">"customerId"</span>) <span class="code-object">String</span> id) {
+ @Path("/customers/{customerId}/")
+ public Customer getCustomer(@PathParam("customerId") String id) {
....
}
-</pre>
+]]></script>
</div></div>
<h2><a shape="rect" name="JAX-RSDataBindings-Jettison"></a>Jettison</h2>
@@ -281,16 +289,16 @@ If Moxy is used to handle beans without
<p>The default JSON provider can be configured in a number of ways. For example, here's how to set up namespace-to-prefix mappings :</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><beans <span class="code-keyword">xmlns:util</span>=<span class="code-quote">"http://www.springframework.org/schema/util"</span>></span>
-<span class="code-tag"><bean id=<span class="code-quote">"jaxbProvider"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.json.JSONProvider"</span>></span>
-<span class="code-tag"><property name=<span class="code-quote">"namespaceMap"</span> ref=<span class="code-quote">"jsonNamespaceMap"</span>/></span>
-<span class="code-tag"></bean></span>
-<span class="code-tag"><util:map id=<span class="code-quote">"jsonNamespaceMap"</span> map-class=<span class="code-quote">"java.util.Hashtable"</span>></span>
-<span class="code-tag"><entry key=<span class="code-quote">"http://www.example.org/books"</span> value=<span class="code-quote">"b"</span>/></span>
-<span class="code-tag"></util:map></span>
-/<span class="code-tag"><beans></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<beans xmlns:util="http://www.springframework.org/schema/util">
+<bean id="jaxbProvider" class="org.apache.cxf.jaxrs.provider.json.JSONProvider">
+<property name="namespaceMap" ref="jsonNamespaceMap"/>
+</bean>
+<util:map id="jsonNamespaceMap" map-class="java.util.Hashtable">
+<entry key="http://www.example.org/books" value="b"/>
+</util:map>
+/<beans>
+]]></script>
</div></div>
<p><b>Note</b> that starting from CXF 2.3.0 it may not be needed to set up a custom namespace map on the write side with JSONProvider making a 'best' effort to retrieve them during the JAXB Marshaller calls. Starting from CXF 2.6.1 and 2.5.4 setting the namespace maps will additionally configure a Marshaller namespace mapper.</p>
@@ -304,38 +312,38 @@ If Moxy is used to handle beans without
<p>Note that 'serializeAsArray' and 'arrayKeys' can be combined to produce so called natural convention sequences. For example, given the following two class definitions :</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[
@XmlRootElement()
-@XmlType(name = <span class="code-quote">"", propOrder = {"</span>title<span class="code-quote">", "</span>comments" })
-<span class="code-keyword">public</span> <span class="code-keyword">static</span> class Post {
- <span class="code-keyword">private</span> <span class="code-object">String</span> title;
- <span class="code-keyword">private</span> List<Comment> comments = <span class="code-keyword">new</span> ArrayList<Comment>();
- <span class="code-keyword">public</span> void setTitle(<span class="code-object">String</span> title) {
- <span class="code-keyword">this</span>.title = title;
+@XmlType(name = "", propOrder = {"title", "comments" })
+public static class Post {
+ private String title;
+ private List<Comment> comments = new ArrayList<Comment>();
+ public void setTitle(String title) {
+ this.title = title;
}
- <span class="code-keyword">public</span> <span class="code-object">String</span> getTitle() {
- <span class="code-keyword">return</span> title;
+ public String getTitle() {
+ return title;
}
- <span class="code-keyword">public</span> void setComments(List<Comment> comments) {
- <span class="code-keyword">this</span>.comments = comments;
+ public void setComments(List<Comment> comments) {
+ this.comments = comments;
}
- <span class="code-keyword">public</span> List<Comment> getComments() {
- <span class="code-keyword">return</span> comments;
+ public List<Comment> getComments() {
+ return comments;
}
}
-<span class="code-keyword">public</span> <span class="code-keyword">static</span> class Comment {
- <span class="code-keyword">private</span> <span class="code-object">String</span> title;
+public static class Comment {
+ private String title;
- <span class="code-keyword">public</span> void setTitle(<span class="code-object">String</span> title) {
- <span class="code-keyword">this</span>.title = title;
+ public void setTitle(String title) {
+ this.title = title;
}
- <span class="code-keyword">public</span> <span class="code-object">String</span> getTitle() {
- <span class="code-keyword">return</span> title;
+ public String getTitle() {
+ return title;
}
}
-</pre>
+]]></script>
</div></div>
<p>an instance of Post class can be serialized like this if a JSONProvider has had its 'serializeAsArray' property set to 'true' and 'arrayKeys' list property set to contain 'comments' value :</p>
@@ -366,33 +374,33 @@ If Moxy is used to handle beans without
<p>If you prefer working with Jackson JSON providers then register either JacksonJsonProvider:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><jaxrs:providers></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.codehaus.jackson.jaxrs.JacksonJsonProvider"</span>/></span>
-<span class="code-tag"></jaxrs:providers></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<jaxrs:providers>
+ <bean class="org.codehaus.jackson.jaxrs.JacksonJsonProvider"/>
+</jaxrs:providers>
+]]></script>
</div></div>
<p>or JacksonJaxbJsonProvider (when working with JAXB beans):</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><jaxrs:providers></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.codehaus.jackson.jaxrs.JacksonJaxbJsonProvider"</span>/></span>
-<span class="code-tag"></jaxrs:providers></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<jaxrs:providers>
+ <bean class="org.codehaus.jackson.jaxrs.JacksonJaxbJsonProvider"/>
+</jaxrs:providers>
+]]></script>
</div></div>
<p>and add this Maven dependency:</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.codehaus.jackson<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>jackson-jaxrs<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>1.9.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.codehaus.jackson</groupId>
+ <artifactId>jackson-jaxrs</artifactId>
+ <version>1.9.0</version>
+</dependency>
+]]></script>
</div></div>
<h1><a shape="rect" name="JAX-RSDataBindings-CommonJAXBandJSONconfiguration"></a>Common JAXB and JSON configuration</h1>
@@ -404,17 +412,17 @@ If Moxy is used to handle beans without
<p>By default JAXBContexts are created on demand. Starting from CXF 2.3.2 and 2.4.0 it is possible to configure JAXB-based providers to support the creation of a single JAXBContext, 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">"jaxb"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.JAXBElementProvider"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"singleJaxbContext"</span> value=<span class="code-quote">"true"</span>/></span>
- <span class="code-tag"><property name=<span class="code-quote">"extraClass"</span>></span>
- <span class="code-tag"><list></span>
- <span class="code-tag"><value></span>org.apache.cxf.jaxrs.resources.SuperBook<span class="code-tag"></value></span>
- <span class="code-tag"><value></span>org.apache.cxf.jaxrs.resources.SuperBook<span class="code-tag"></value></span>
- <span class="code-tag"></list></span>
- <span class="code-tag"></property></span>
-<span class="code-tag"></bean></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<bean id="jaxb" class="org.apache.cxf.jaxrs.provider.JAXBElementProvider">
+ <property name="singleJaxbContext" value="true"/>
+ <property name="extraClass">
+ <list>
+ <value>org.apache.cxf.jaxrs.resources.SuperBook</value>
+ <value>org.apache.cxf.jaxrs.resources.SuperBook</value>
+ </list>
+ </property>
+</bean>
+]]></script>
</div></div>
<p>Please note that if an extraClass property is set then the JAXBContext (single as in the above example or the one created dynamically on a per-class or per-package basis) will also include the extra user classes thus making it possible to avoid setting an XmlSeeAlso JAXB annotation or dealing with JAXB jaxb.index or ObjectFactory resources. This property is identical to a CXF JAXBDataBinding 'extraClass' property. </p>
@@ -451,20 +459,20 @@ One can override it by setting a 'collec
<p>There's also a 'collectionWrapperMap' property available for use in more advanced cases, when collections of different types are used, for example, when mixed collections of objects descended from abstract classes having no @XmlRootElement tags are returned :</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"><!-- Configure JAXB Provider --></span></span>
-<bean id=<span class="code-quote">"jaxbProvider"</span>
-class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.JAXBElementProvider"</span>>
- <span class="code-tag"><property name=<span class="code-quote">"collectionWrapperMap"</span>></span>
- <span class="code-tag"><map></span>
- <span class="code-tag"><entry></span>
- <span class="code-tag"><key></span><span class="code-tag"><value></span>com.foo.bar.MyObject<span class="code-tag"></value></span><span class="code-tag"></key></span>
- <span class="code-tag"><value></span>MyObjects<span class="code-tag"></value></span>
- <span class="code-tag"></entry></span>
- <span class="code-tag"></map></span>
- <span class="code-tag"></property></span>
-<span class="code-tag"></bean></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<!-- Configure JAXB Provider -->
+<bean id="jaxbProvider"
+class="org.apache.cxf.jaxrs.provider.JAXBElementProvider">
+ <property name="collectionWrapperMap">
+ <map>
+ <entry>
+ <key><value>com.foo.bar.MyObject</value></key>
+ <value>MyObjects</value>
+ </entry>
+ </map>
+ </property>
+</bean>
+]]></script>
</div></div>
<p>JSONProvider can only serialize explicit collections at the moment. If needed, it can be told to drop a collection element name using a boolean 'dropCollectionWrapperElementName'. For example, a 'dropCollectionWrapperElementName' and 'serializeAsArray' properties can be used to make the Dojo JSON RestStore consume the resulting JSON sequence (in CXF 2.2.5).</p>
@@ -492,25 +500,25 @@ Typically one would delegate to a super
<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">"jaxbProvider"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.JAXBElementProvider"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"outTransformElements"</span>></span>
- <span class="code-tag"><map></span>
- <span class="code-tag"><span class="code-comment"><!-- change <span class="code-quote">"book"</span> to <span class="code-quote">"thebook"</span> --></span></span>
- <span class="code-tag"><entry key=<span class="code-quote">"book"</span> value=<span class="code-quote">"thebook"</span>/></span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<bean id="jaxbProvider" class="org.apache.cxf.jaxrs.provider.JAXBElementProvider">
+ <property name="outTransformElements">
+ <map>
+ <!-- change "book" to "thebook" -->
+ <entry key="book" value="thebook"/>
- <span class="code-tag"><span class="code-comment"><!-- drop the namespace from <span class="code-quote">"book"</span> --></span></span>
- <span class="code-tag"><entry key=<span class="code-quote">"{http://books}book"</span> value=<span class="code-quote">"book"</span>/></span>
+ <!-- drop the namespace from "book" -->
+ <entry key="{http://books}book" value="book"/>
- <span class="code-tag"><span class="code-comment"><!-- qualify <span class="code-quote">"book"</span> with <span class="code-quote">"http://books"</span> --></span></span>
- <span class="code-tag"><entry key=<span class="code-quote">"book"</span> value=<span class="code-quote">"{http://books}thebook"</span>/></span>
+ <!-- qualify "book" with "http://books" -->
+ <entry key="book" value="{http://books}thebook"/>
- <span class="code-tag"><span class="code-comment"><!-- change namespace to <span class="code-quote">"http://books"</span> for all the elements with the <span class="code-quote">"http://book"</span> namespace --></span></span>
- <span class="code-tag"><entry key=<span class="code-quote">"{http://book}*"</span> value=<span class="code-quote">"{http://books}*"</span>/></span>
- <span class="code-tag"></map></span>
- <span class="code-tag"></property></span>
-<span class="code-tag"></bean></span>
-</pre>
+ <!-- change namespace to "http://books" for all the elements with the "http://book" namespace -->
+ <entry key="{http://book}*" value="{http://books}*"/>
+ </map>
+ </property>
+</bean>
+]]></script>
</div></div>
<ul class="alternate" type="square"><li>"inTransformElements" map property: can be used to change the input element names and change or drop namespaces; see the "outTransfromElements" property description for an example.</li></ul>
@@ -520,25 +528,25 @@ Typically one would delegate to a super
<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">"jaxbProvider"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.JAXBElementProvider"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"outAppendElements"</span>></span>
- <span class="code-tag"><map></span>
- <span class="code-tag"><span class="code-comment"><!-- append <span class="code-quote">"book"</span> before <span class="code-quote">"thebook"</span> --></span></span>
- <span class="code-tag"><entry key=<span class="code-quote">"book"</span> value=<span class="code-quote">"thebook"</span>/></span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<bean id="jaxbProvider" class="org.apache.cxf.jaxrs.provider.JAXBElementProvider">
+ <property name="outAppendElements">
+ <map>
+ <!-- append "book" before "thebook" -->
+ <entry key="book" value="thebook"/>
- <span class="code-tag"><span class="code-comment"><!-- qualify <span class="code-quote">"book"</span> with <span class="code-quote">"http://books"</span> --></span></span>
- <span class="code-tag"><entry key=<span class="code-quote">"{http://books}book"</span> value=<span class="code-quote">"book"</span>/></span>
+ <!-- qualify "book" with "http://books" -->
+ <entry key="{http://books}book" value="book"/>
- <span class="code-tag"><span class="code-comment"><!-- drop the namespace from the <span class="code-quote">"book"</span> --></span></span>
- <span class="code-tag"><entry key=<span class="code-quote">"book"</span> value=<span class="code-quote">"{http://books}thebook"</span>/></span>
+ <!-- drop the namespace from the "book" -->
+ <entry key="book" value="{http://books}thebook"/>
- <span class="code-tag"><span class="code-comment"><!-- change namespace to <span class="code-quote">"http://book"</span> for all the elements with the <span class="code-quote">"http://books"</span> namespace --></span></span>
- <span class="code-tag"><entry key=<span class="code-quote">"{http://book}*"</span> value=<span class="code-quote">"{http://books}*"</span>/></span>
- <span class="code-tag"></map></span>
- <span class="code-tag"></property></span>
-<span class="code-tag"></bean></span>
-</pre>
+ <!-- change namespace to "http://book" for all the elements with the "http://books" namespace -->
+ <entry key="{http://book}*" value="{http://books}*"/>
+ </map>
+ </property>
+</bean>
+]]></script>
</div></div>
<ul class="alternate" type="square"><li>"inAppendElements" map property : can be used to append new simple or qualified elements to the input; see the "outAppendElements" property description for an example.</li></ul>
@@ -548,17 +556,17 @@ Typically one would delegate to a super
<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">"jaxbProvider"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.JAXBElementProvider"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"outDropElements"</span>></span>
- <span class="code-tag"><list></span>
- <span class="code-tag"><span class="code-comment"><!-- ignore drop and {http://numbers}number elements --></span></span>
- <span class="code-tag"><value></span>{http://numbers}number<span class="code-tag"></value></span>
- <span class="code-tag"><value></span>index<span class="code-tag"></value></span>
- <span class="code-tag"></list></span>
- <span class="code-tag"></property></span>
-<span class="code-tag"></bean></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<bean id="jaxbProvider" class="org.apache.cxf.jaxrs.provider.JAXBElementProvider">
+ <property name="outDropElements">
+ <list>
+ <!-- ignore drop and {http://numbers}number elements -->
+ <value>{http://numbers}number</value>
+ <value>index</value>
+ </list>
+ </property>
+</bean>
+]]></script>
</div></div>
<ul class="alternate" type="square"><li>"inDropElements" list property : can be used to drop elements during the deserialization; note that children elements if any of a given dropped element are not affected. Please see the "outDropElements" property description for an example.</li></ul>
@@ -578,68 +586,68 @@ Typically one would delegate to a super
<p>Additionally it is possible to configure JAXBElementProvider or JSONProvider with contextual properties or <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/api/src/main/java/org/apache/cxf/staxutils/DocumentDepthProperties.java">DocumentDepthProperties</a>:</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">"depthProperties"</span> class=<span class="code-quote">"org.apache.cxf.staxutils.DocumentDepthProperties"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"innerElementCountThreshold"</span> value=<span class="code-quote">"500"</span>/></span>
-<span class="code-tag"></bean></span>
-
-<span class="code-tag"><bean id=<span class="code-quote">"jaxbProvider"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.JAXBElementProvider"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"depthProperties"</span> ref=<span class="code-quote">"depthProperties"</span>/></span>
-<span class="code-tag"></bean></span>
-
-<span class="code-tag"><bean id=<span class="code-quote">"jsonProvider"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.json.JSONProvider"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"depthProperties"</span> ref=<span class="code-quote">"depthProperties"</span>/></span>
-<span class="code-tag"></bean></span>
-
-<span class="code-tag"><jaxrs:server id=<span class="code-quote">"endpoint1"</span>></span>
- <span class="code-tag"><jaxrs:serviceBeans></span>
- <span class="code-tag"><bean class=<span class="code-quote">"my.package.RootResource"</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">"jaxbProvider"</span>/></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"jsonProvider"</span>/></span>
- <span class="code-tag"></jaxrs:providers></span>
-<span class="code-tag"></jaxrs:server></span>
-
-<span class="code-tag"><jaxrs:server id=<span class="code-quote">"endpoint2"</span>></span>
- <span class="code-tag"><jaxrs:serviceBeans></span>
- <span class="code-tag"><bean class=<span class="code-quote">"my.package.RootResource"</span>/></span>
- <span class="code-tag"></jaxrs:serviceBeans></span>
- <span class="code-tag"><jaxrs:properties></span>
- <entry key=<span class="code-quote">"depthInnerElementCountThreshold"</span> value=<span class="code-quote">"500"</span>/
- <span class="code-tag"></jaxrs:properties></span>
-<span class="code-tag"></jaxrs:server></span>
+<bean id="depthProperties" class="org.apache.cxf.staxutils.DocumentDepthProperties">
+ <property name="innerElementCountThreshold" value="500"/>
+</bean>
+
+<bean id="jaxbProvider" class="org.apache.cxf.jaxrs.provider.JAXBElementProvider">
+ <property name="depthProperties" ref="depthProperties"/>
+</bean>
+
+<bean id="jsonProvider" class="org.apache.cxf.jaxrs.provider.json.JSONProvider">
+ <property name="depthProperties" ref="depthProperties"/>
+</bean>
+
+<jaxrs:server id="endpoint1">
+ <jaxrs:serviceBeans>
+ <bean class="my.package.RootResource"/>
+ </jaxrs:serviceBeans>
+ <jaxrs:providers>
+ <ref bean="jaxbProvider"/>
+ <ref bean="jsonProvider"/>
+ </jaxrs:providers>
+</jaxrs:server>
+
+<jaxrs:server id="endpoint2">
+ <jaxrs:serviceBeans>
+ <bean class="my.package.RootResource"/>
+ </jaxrs:serviceBeans>
+ <jaxrs:properties>
+ <entry key="depthInnerElementCountThreshold" value="500"/
+ </jaxrs:properties>
+</jaxrs:server>
-</pre>
+]]></script>
</div></div>
<h1><a shape="rect" name="JAX-RSDataBindings-JSONWithPadding%28JSONP%29"></a>JSON With Padding (JSONP)</h1>
<p>One option for supporting "JSON With Padding" (<a shape="rect" class="external-link" href="http://en.wikipedia.org/wiki/JSONP" rel="nofollow">JSONP</a>) is to extend the default JSONProvider and override its writeTo method as follows:</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[
-@Produces(<span class="code-quote">"application/javascript"</span>)
-class JsonpProvider <span class="code-keyword">extends</span> JSONProvider {
+@Produces("application/javascript")
+class JsonpProvider extends JSONProvider {
@Override
- <span class="code-keyword">public</span> void writeTo(<span class="code-object">Object</span> obj, <span class="code-object">Class</span><?> cls, Type genericType, Annotation[] anns, MediaType m, MultivaluedMap<<span class="code-object">String</span>, <span class="code-object">Object</span>> headers,
- OutputStream os) <span class="code-keyword">throws</span> IOException {
- <span class="code-object">String</span> prefix = getContext().getHttpServletRequest().getParameter(<span class="code-quote">"_jsonp"</span>);
- <span class="code-object">boolean</span> hasPrefix = !isEmpty(prefix);
- <span class="code-keyword">if</span>(hasPrefix) {
- os.write(prefix.getBytes(HttpUtils.getSetEncoding(m, headers, <span class="code-quote">"UTF-8"</span>)));
+ public void writeTo(Object obj, Class<?> cls, Type genericType, Annotation[] anns, MediaType m, MultivaluedMap<String, Object> headers,
+ OutputStream os) throws IOException {
+ String prefix = getContext().getHttpServletRequest().getParameter("_jsonp");
+ boolean hasPrefix = !isEmpty(prefix);
+ if(hasPrefix) {
+ os.write(prefix.getBytes(HttpUtils.getSetEncoding(m, headers, "UTF-8")));
os.write('(');
}
- <span class="code-keyword">super</span>.writeTo(obj, cls, genericType, anns, m, headers, os);
- <span class="code-keyword">if</span>(hasPrefix) {
+ super.writeTo(obj, cls, genericType, anns, m, headers, os);
+ if(hasPrefix) {
os.write(')');
}
}
}
-</pre>
+]]></script>
</div></div>
<p>Similar approach can work when Jackson is used.</p>
@@ -649,48 +657,48 @@ class JsonpProvider <span class="code-ke
<p>Starting from CXF 2.3.4 and 2.4.0, JSONP can be supported with the help of CXF in/out interceptors:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><jaxrs:server id=<span class="code-quote">"bookJsonp"</span> address=<span class="code-quote">"/jsonp"</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:inInterceptors></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.jsonp.JsonpInInterceptor"</span>/></span>
- <span class="code-tag"></jaxrs:inInterceptors></span>
- <span class="code-tag"><jaxrs:outInterceptors></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.jsonp.JsonpPreStreamInterceptor"</span>/></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.jsonp.JsonpPostStreamInterceptor"</span>/></span>
- <span class="code-tag"></jaxrs:outInterceptors></span>
-<span class="code-tag"></jaxrs:server></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<jaxrs:server id="bookJsonp" address="/jsonp">
+ <jaxrs:serviceBeans>
+ <ref bean="serviceBean" />
+ </jaxrs:serviceBeans>
+
+ <jaxrs:inInterceptors>
+ <bean class="org.apache.cxf.jaxrs.provider.jsonp.JsonpInInterceptor"/>
+ </jaxrs:inInterceptors>
+ <jaxrs:outInterceptors>
+ <bean class="org.apache.cxf.jaxrs.provider.jsonp.JsonpPreStreamInterceptor"/>
+ <bean class="org.apache.cxf.jaxrs.provider.jsonp.JsonpPostStreamInterceptor"/>
+ </jaxrs:outInterceptors>
+</jaxrs:server>
+]]></script>
</div></div>
<p>JsonpInInterceptor checks if a JSONP callback query parameter is available (default is _jsonp) and if yes then it saves its value on the current exchange for out interceptors to know if they have to write the paddings or not. The name of the expected callback parameter can be customized. JsonpPreStreamInterceptor and JsonpPostStreamInterceptor ensure the actual JSON stream is 'padded' properly. JsonpPreStreamInterceptor will also set Content-Type to "application/x+javascript" by default but this can be changed:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><jaxrs:server id=<span class="code-quote">"bookJsonp"</span> address=<span class="code-quote">"/jsonp"</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:inInterceptors></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.jsonp.JsonpInInterceptor"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"callbackParam"</span> value=<span class="code-quote">"myjsonp"</span>/></span>
- <span class="code-tag"></bean></span>
- <span class="code-tag"></jaxrs:inInterceptors></span>
- <span class="code-tag"><jaxrs:outInterceptors></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.jsonp.JsonpPreStreamInterceptor"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"mediaType"</span> value=<span class="code-quote">"text/x+javascript"</span>/></span>
- <span class="code-tag"></bean></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.jsonp.JsonpPostStreamInterceptor"</span>></span>
- <span class="code-tag"><span class="code-comment"><!-- default is ');' --></span></span>
- <span class="code-tag"><property name=<span class="code-quote">"paddingEnd"</span> value=<span class="code-quote">")"</span>/></span>
- <span class="code-tag"></bean></span>
- <span class="code-tag"></jaxrs:outInterceptors></span>
-<span class="code-tag"></jaxrs:server></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<jaxrs:server id="bookJsonp" address="/jsonp">
+ <jaxrs:serviceBeans>
+ <ref bean="serviceBean" />
+ </jaxrs:serviceBeans>
+
+ <jaxrs:inInterceptors>
+ <bean class="org.apache.cxf.jaxrs.provider.jsonp.JsonpInInterceptor">
+ <property name="callbackParam" value="myjsonp"/>
+ </bean>
+ </jaxrs:inInterceptors>
+ <jaxrs:outInterceptors>
+ <bean class="org.apache.cxf.jaxrs.provider.jsonp.JsonpPreStreamInterceptor">
+ <property name="mediaType" value="text/x+javascript"/>
+ </bean>
+ <bean class="org.apache.cxf.jaxrs.provider.jsonp.JsonpPostStreamInterceptor">
+ <!-- default is ');' -->
+ <property name="paddingEnd" value=")"/>
+ </bean>
+ </jaxrs:outInterceptors>
+</jaxrs:server>
+]]></script>
</div></div>
<h1><a shape="rect" name="JAX-RSDataBindings-Formpayloads"></a>Form payloads</h1>
@@ -699,30 +707,30 @@ class JsonpProvider <span class="code-ke
One can capture the form data by using either JAX-RS FormParam annotation or MultivaluedMap, for example:</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-keyword">import</span> javax.ws.rs.FormParam;
-<span class="code-keyword">import</span> javax.ws.rs.MultivaluedMap;
+import javax.ws.rs.FormParam;
+import javax.ws.rs.MultivaluedMap;
-@Path(<span class="code-quote">"resource"</span>)
-<span class="code-keyword">public</span> class FormResource {
+@Path("resource")
+public class FormResource {
@POST
- @Path(<span class="code-quote">"/form1"</span>)
- @Consumes(<span class="code-quote">"application/x-www-form-urlencoded"</span>)
- <span class="code-keyword">public</span> void form1(@FormParam(<span class="code-quote">"name"</span>) <span class="code-object">String</span> name, @FormParam(<span class="code-quote">"age"</span>) <span class="code-object">int</span> age) {
+ @Path("/form1")
+ @Consumes("application/x-www-form-urlencoded")
+ public void form1(@FormParam("name") String name, @FormParam("age") int age) {
}
@POST
- @Path(<span class="code-quote">"/form2"</span>)
- @Consumes(<span class="code-quote">"application/x-www-form-urlencoded"</span>)
- <span class="code-keyword">public</span> void form1(MultivaluedMap<<span class="code-object">String</span>, <span class="code-object">String</span>> params) {
- <span class="code-object">String</span> name = params.getFirst(<span class="code-quote">"name"</span>);
- <span class="code-object">String</span> age = params.getFirst(<span class="code-quote">"age"</span>);
+ @Path("/form2")
+ @Consumes("application/x-www-form-urlencoded")
+ public void form1(MultivaluedMap<String, String> params) {
+ String name = params.getFirst("name");
+ String age = params.getFirst("age");
}
}
-</pre>
+]]></script>
</div></div>
<p>Note that it is possible to control the maximum number of the expected form parameters by setting a "maxFormParameterCount" contextual property (set within the jaxrs:properties). The client will receive HTTP 413 if the limit is reached.</p>
@@ -744,27 +752,27 @@ One can capture the form data by using e
<p>AtomPojoProvider offers users a way to have no Abdera Feed/Entry classes referenced from the 'main' application code, example :</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-@Path(<span class="code-quote">"books"</span>)
-<span class="code-keyword">public</span> class BooksRootResource {
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+@Path("books")
+public class BooksRootResource {
- <span class="code-keyword">private</span> Books books;
+ private Books books;
@GET
- @Produces({<span class="code-quote">"application/xml"</span>, <span class="code-quote">"application/json"</span>, <span class="code-quote">"application/atom+xml;type=feed"</span>})
- <span class="code-keyword">public</span> Books getCollectionOfBooks() {
- <span class="code-keyword">return</span> books;
+ @Produces({"application/xml", "application/json", "application/atom+xml;type=feed"})
+ public Books getCollectionOfBooks() {
+ return books;
}
@GET
- @Produces({<span class="code-quote">"application/xml"</span>, <span class="code-quote">"application/json"</span>, <span class="code-quote">"application/atom+xml;type=entry"</span>})
- @Path(<span class="code-quote">"{id}"</span>)
- <span class="code-keyword">public</span> Book getBook(@PathParam(<span class="code-quote">"id"</span>) <span class="code-object">Long</span> id) {
- <span class="code-keyword">return</span> books.get(id);
+ @Produces({"application/xml", "application/json", "application/atom+xml;type=entry"})
+ @Path("{id}")
+ public Book getBook(@PathParam("id") Long id) {
+ return books.get(id);
}
}
-</pre>
+]]></script>
</div></div>
<p>Note that when an object such as Books is about to be converted to/read from Feed (which in our case is essentially a collection of entries each of them representing an individual Book) the AtomPojoProvider needs to know about the collection getters and/or setters so that it can create individual Entries. The "collectionGetters" and "collectionSetters" map properties with keys being the names of collection classes and values being the method names need to be used for providing this information, example a pair "org.apache.cxf.systest.jaxrs.Books:getBooks" tells AtomPojoProvider that when creating a Books Feed, the objects representing individual entries can be retrieved from Book with the help of "getBooks". If these properties are not set then AtomPojoProvider will try to get a method adding the simple class name to either 'get' or 'set', for example, an "org.apache.cxf.systest.jaxrs.Books:getBooks" pair is redundant if the Books class has a getBooks method.</p>
@@ -803,36 +811,36 @@ Please see <a shape="rect" class="extern
<p>org.apache.cxf.jaxrs.provider.JAXRSDataBinding is a CXF DataBinding implementation which wraps JAX-RS providers and can be used by CXF JAX-WS endpoints thus making it possible to use JAX-RS providers for reading and writing XML payloads during SOAP and RESTful invocations. Example :</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><jaxrs:server id=<span class="code-quote">"hello_rest"</span> address=<span class="code-quote">"/hello-rest"</span>></span>
- <span class="code-tag"><jaxrs:serviceBeans></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.systest.jaxrs.jaxws.HelloWorldImpl"</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">"jaxbProviderSoap"</span>/></span>
- <span class="code-tag"></jaxrs:providers></span>
- <span class="code-tag"></jaxrs:server></span>
-
- <jaxws:endpoint <span class="code-keyword">xmlns:s</span>=<span class="code-quote">"http://hello.com"</span>
- serviceName=<span class="code-quote">"s:HelloWorld"</span>
- endpointName=<span class="code-quote">"s:HelloWorldPort"</span>
- id=<span class="code-quote">"hello_soap-databinding"</span>
- implementor=<span class="code-quote">"org.apache.cxf.systest.jaxrs.jaxws.HelloWorldImpl"</span>
- address=<span class="code-quote">"/hello-soap-databinding"</span>>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <jaxrs:server id="hello_rest" address="/hello-rest">
+ <jaxrs:serviceBeans>
+ <bean class="org.apache.cxf.systest.jaxrs.jaxws.HelloWorldImpl"/>
+ </jaxrs:serviceBeans>
+
+ <jaxrs:providers>
+ <ref bean="jaxbProviderSoap"/>
+ </jaxrs:providers>
+ </jaxrs:server>
+
+ <jaxws:endpoint xmlns:s="http://hello.com"
+ serviceName="s:HelloWorld"
+ endpointName="s:HelloWorldPort"
+ id="hello_soap-databinding"
+ implementor="org.apache.cxf.systest.jaxrs.jaxws.HelloWorldImpl"
+ address="/hello-soap-databinding">
- <span class="code-tag"><jaxws:dataBinding></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"jaxrs-data-binding"</span>/></span>
- <span class="code-tag"></jaxws:dataBinding></span>
+ <jaxws:dataBinding>
+ <ref bean="jaxrs-data-binding"/>
+ </jaxws:dataBinding>
- <span class="code-tag"></jaxws:endpoint></span>
+ </jaxws:endpoint>
- <span class="code-tag"><bean id=<span class="code-quote">"jaxrs-data-binding"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.JAXRSDataBinding"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"provider"</span> ref=<span class="code-quote">"jaxbProviderSoap"</span>/></span>
- <span class="code-tag"></bean></span>
+ <bean id="jaxrs-data-binding" class="org.apache.cxf.jaxrs.provider.JAXRSDataBinding">
+ <property name="provider" ref="jaxbProviderSoap"/>
+ </bean>
- <span class="code-tag"><bean id=<span class="code-quote">"jaxbProviderSoap"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.JAXBElementProvider"</span>/></span>
-</pre>
+ <bean id="jaxbProviderSoap" class="org.apache.cxf.jaxrs.provider.JAXBElementProvider"/>
+]]></script>
</div></div>
<p>This option is similar to the one involving wrapping CXF DataBindings as JAX-RS providers and using them for handling the data for the JAX-RS endpoints. This time though it is SOAP endpoints which are relying on the JAX-RS providers to handle the data properly. </p>
@@ -840,69 +848,69 @@ Please see <a shape="rect" class="extern
<p>If you would like to write your own custom XML provider and have it wrapped by the JAXRSDataBinding then custom MessageBodyReader and MessageBodyWriter implementations should be ready to accept null InputStream and OutputStream parameters and retrieve XMLStreamReader and XMLStreamWriter instances from the current CXF Message. To make the custom provider as portable as possible, one may want to follow the following approach :</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-keyword">public</span> class PortableXMLProvider <span class="code-keyword">implements</span> MessageBodyReader, MessageBodyWriter {
+public class PortableXMLProvider implements MessageBodyReader, MessageBodyWriter {
- <span class="code-keyword">public</span> <span class="code-object">Object</span> readFrom(<span class="code-object">Class</span><<span class="code-object">Object</span>> type, Type genericType, Annotation[] anns, MediaType mt,
- MultivaluedMap<<span class="code-object">String</span>, <span class="code-object">String</span>> headers, InputStream is)
- <span class="code-keyword">throws</span> IOException {
+ public Object readFrom(Class<Object> type, Type genericType, Annotation[] anns, MediaType mt,
+ MultivaluedMap<String, String> headers, InputStream is)
+ throws IOException {
XMLStreamReader reader = createReaderUsingStandardStaxApi(is);
- <span class="code-keyword">return</span> readFromStream(reader);
+ return readFromStream(reader);
}
- <span class="code-keyword">public</span> void writeTo(<span class="code-object">Object</span> obj, <span class="code-object">Class</span><?> cls, Type genericType, Annotation[] anns,
- MediaType m, MultivaluedMap<<span class="code-object">String</span>, <span class="code-object">Object</span>> headers, OutputStream os)
- <span class="code-keyword">throws</span> IOException {
+ public void writeTo(Object obj, Class<?> cls, Type genericType, Annotation[] anns,
+ MediaType m, MultivaluedMap<String, Object> headers, OutputStream os)
+ throws IOException {
XMLStreamWriter writer = createWriterUsingStandardStaxApi(os);
writeToStream(writer);
}
- <span class="code-comment">// add more parameters <span class="code-keyword">if</span> needed
-</span> <span class="code-keyword">protected</span> <span class="code-object">Object</span> readFromStream(XMLStreamReader reader) {
- <span class="code-comment">// read from XMLStreamReader
-</span> }
+ // add more parameters if needed
+ protected Object readFromStream(XMLStreamReader reader) {
+ // read from XMLStreamReader
+ }
- <span class="code-comment">// add more parameters <span class="code-keyword">if</span> needed
-</span> <span class="code-keyword">protected</span> void writeToStream(XMLStreamWriter writer) {
- <span class="code-comment">// write to XMLStreamWriter
-</span> }
+ // add more parameters if needed
+ protected void writeToStream(XMLStreamWriter writer) {
+ // write to XMLStreamWriter
+ }
}
-<span class="code-keyword">public</span> class CXFCustomXMLProvider <span class="code-keyword">extends</span> PortableXMLProvider {
+public class CXFCustomXMLProvider extends PortableXMLProvider {
@Override
- <span class="code-keyword">public</span> <span class="code-object">Object</span> readFrom(<span class="code-object">Class</span><<span class="code-object">Object</span>> type, Type genericType, Annotation[] anns, MediaType mt,
- MultivaluedMap<<span class="code-object">String</span>, <span class="code-object">String</span>> headers, InputStream is)
- <span class="code-keyword">throws</span> IOException {
+ public Object readFrom(Class<Object> type, Type genericType, Annotation[] anns, MediaType mt,
+ MultivaluedMap<String, String> headers, InputStream is)
+ throws IOException {
XMLStreamReader reader = getStaxHandlerFromCurrentMessage(XMLStreamReader.class);
- <span class="code-keyword">return</span> readFromStream(reader);
+ return readFromStream(reader);
}
@Override
- <span class="code-keyword">public</span> void writeTo(<span class="code-object">Object</span> obj, <span class="code-object">Class</span><?> cls, Type genericType, Annotation[] anns,
- MediaType m, MultivaluedMap<<span class="code-object">String</span>, <span class="code-object">Object</span>> headers, OutputStream os)
- <span class="code-keyword">throws</span> IOException {
+ public void writeTo(Object obj, Class<?> cls, Type genericType, Annotation[] anns,
+ MediaType m, MultivaluedMap<String, Object> headers, OutputStream os)
+ throws IOException {
XMLStreamWriter writer = getStaxHandlerFromCurrentMessage(XMLStreamWriter.class);
writeToStream(writer);
}
- <span class="code-keyword">protected</span> <T> T getStaxHandlerFromCurrentMessage(<span class="code-object">Class</span><T> staxCls) {
+ protected <T> T getStaxHandlerFromCurrentMessage(Class<T> staxCls) {
Message m = PhaseInterceptorChain.getCurrentMessage();
- <span class="code-keyword">if</span> (m != <span class="code-keyword">null</span>) {
- <span class="code-keyword">return</span> staxCls.<span class="code-keyword">cast</span>(m.getContent(staxCls));
+ if (m != null) {
+ return staxCls.cast(m.getContent(staxCls));
}
- <span class="code-keyword">return</span> <span class="code-keyword">null</span>;
+ return null;
}
}
-</pre>
+]]></script>
</div></div>
<p>Please note that if you need the advanced DataBinding support for your JAX-WS endpoints (such as the schema validation with the schemas being available in the WSDL documents - likely to be supported, un-wrapping the XML payloads into multiple method parameters) then you are recommended to use one of the CXF DataBindings supported by CXF JAX-WS endpoints directly. </p>
@@ -918,16 +926,16 @@ Please see <a shape="rect" class="extern
<p>1. Using jaxrs:schemaLocations element</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><beans></span>
-<span class="code-tag"><jaxrs:server address=<span class="code-quote">"/"</span> serviceClass=<span class="code-quote">"org.apache.cxf.systest.jaxrs.BookStore"</span>></span>
- <span class="code-tag"><jaxrs:schemaLocations></span>
- <span class="code-tag"><jaxrs:schemaLocation></span>classpath:/schemas/a.xsd<span class="code-tag"></jaxrs:schemaLocation></span>
- <span class="code-tag"><jaxrs:schemaLocation></span>classpath:/schemas/b.xsd<span class="code-tag"></jaxrs:schemaLocation></span>
- <span class="code-tag"></jaxrs:schemaLocations></span>
-<span class="code-tag"></jaxrs:server></span>
-<span class="code-tag"></beans></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<beans>
+<jaxrs:server address="/" serviceClass="org.apache.cxf.systest.jaxrs.BookStore">
+ <jaxrs:schemaLocations>
+ <jaxrs:schemaLocation>classpath:/schemas/a.xsd</jaxrs:schemaLocation>
+ <jaxrs:schemaLocation>classpath:/schemas/b.xsd</jaxrs:schemaLocation>
+ </jaxrs:schemaLocations>
+</jaxrs:server>
+</beans>
+]]></script>
</div></div>
<p>Using this option is handy when you have multiple bindings involved which support the schema validation. In this case<br clear="none">
@@ -938,55 +946,55 @@ individual MessageBodyReader implementat
<p>JAXB and JSON providers can be configured explicitly, for example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><beans <span class="code-keyword">xmlns:util</span>=<span class="code-quote">"http://www.springframework.org/schema/util"</span>></span>
-<span class="code-tag"><jaxrs:server address=<span class="code-quote">"/"</span> serviceClass=<span class="code-quote">"org.apache.cxf.systest.jaxrs.BookStore"</span>></span>
- <span class="code-tag"><jaxrs:providers></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"jaxbProvider"</span>/></span>
- <span class="code-tag"></jaxrs:providers></span>
-<span class="code-tag"></jaxrs:server></span>
-
-<span class="code-tag"><bean id=<span class="code-quote">"jaxbProvider"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.JAXBElementProvider"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"schemaLocations"</span> ref=<span class="code-quote">"schemaHolder"</span>/></span>
-<span class="code-tag"></bean></span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<beans xmlns:util="http://www.springframework.org/schema/util">
+<jaxrs:server address="/" serviceClass="org.apache.cxf.systest.jaxrs.BookStore">
+ <jaxrs:providers>
+ <ref bean="jaxbProvider"/>
+ </jaxrs:providers>
+</jaxrs:server>
+
+<bean id="jaxbProvider" class="org.apache.cxf.jaxrs.provider.JAXBElementProvider">
+ <property name="schemaLocations" ref="schemaHolder"/>
+</bean>
-<span class="code-tag"><util:list id=<span class="code-quote">"theSchemas"</span>></span>
- <span class="code-tag"><value></span>classpath:/WEB-INF/schemas/bookid.xsd<span class="code-tag"></value></span>
- <span class="code-tag"><value></span>classpath:/org/apache/cxf/systest/jaxrs/resources/book.xsd<span class="code-tag"></value></span>
-<span class="code-tag"></util:list></span>
-<span class="code-tag"></beans></span>
-</pre>
+<util:list id="theSchemas">
+ <value>classpath:/WEB-INF/schemas/bookid.xsd</value>
+ <value>classpath:/org/apache/cxf/systest/jaxrs/resources/book.xsd</value>
+</util:list>
+</beans>
+]]></script>
</div></div>
<p>If you have both JAXB and JSON providers validating the input data then you can get schemas shared between them, for example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><beans <span class="code-keyword">xmlns:util</span>=<span class="code-quote">"http://www.springframework.org/schema/util"</span>></span>
- <span class="code-tag"><jaxrs:server address=<span class="code-quote">"/"</span> serviceClass=<span class="code-quote">"org.apache.cxf.systest.jaxrs.BookStore"</span>></span>
- <span class="code-tag"><jaxrs:providers></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"jaxbProvider"</span>/></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"jsonProvider"</span>/></span>
- <span class="code-tag"></jaxrs:providers></span>
- <span class="code-tag"></jaxrs:server></span>
-
-<span class="code-tag"><bean id=<span class="code-quote">"jaxbProvider"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.JAXBElementProvider"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"schemaHandler"</span> ref=<span class="code-quote">"schemaHolder"</span>/></span>
-<span class="code-tag"></bean></span>
-
-<span class="code-tag"><bean id=<span class="code-quote">"jsonProvider"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.json.JSONProvider"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"schemaHandler"</span> ref=<span class="code-quote">"schemaHolder"</span>/></span>
-<span class="code-tag"></bean></span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<beans xmlns:util="http://www.springframework.org/schema/util">
+ <jaxrs:server address="/" serviceClass="org.apache.cxf.systest.jaxrs.BookStore">
+ <jaxrs:providers>
+ <ref bean="jaxbProvider"/>
+ <ref bean="jsonProvider"/>
+ </jaxrs:providers>
+ </jaxrs:server>
+
+<bean id="jaxbProvider" class="org.apache.cxf.jaxrs.provider.JAXBElementProvider">
+ <property name="schemaHandler" ref="schemaHolder"/>
+</bean>
+
+<bean id="jsonProvider" class="org.apache.cxf.jaxrs.provider.json.JSONProvider">
+ <property name="schemaHandler" ref="schemaHolder"/>
+</bean>
-<span class="code-tag"><bean id=<span class="code-quote">"schemaHolder"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.utils.schemas.SchemaHandler"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"schemas"</span> ref=<span class="code-quote">"theSchemas"</span>/></span>
-<span class="code-tag"></bean></span>
+<bean id="schemaHolder" class="org.apache.cxf.jaxrs.utils.schemas.SchemaHandler">
+ <property name="schemas" ref="theSchemas"/>
+</bean>
-<span class="code-tag"><util:list id=<span class="code-quote">"theSchemas"</span>></span>
- <span class="code-tag"><value></span>classpath:/WEB-INF/schemas/bookid.xsd<span class="code-tag"></value></span>
- <span class="code-tag"><value></span>classpath:/org/apache/cxf/systest/jaxrs/resources/book.xsd<span class="code-tag"></value></span>
-<span class="code-tag"></util:list></span>
-<span class="code-tag"></beans></span>
-</pre>
+<util:list id="theSchemas">
+ <value>classpath:/WEB-INF/schemas/bookid.xsd</value>
+ <value>classpath:/org/apache/cxf/systest/jaxrs/resources/book.xsd</value>
+</util:list>
+</beans>
+]]></script>
</div></div>
<h2><a shape="rect" name="JAX-RSDataBindings-Supportforcatalogs"></a>Support for catalogs</h2>
@@ -997,22 +1005,22 @@ individual MessageBodyReader implementat
By default, a "META-INF/jax-rs-catalog.xml" will be checked however the catalog location can be set either on JAXBElementProvider or JSONProvider:</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">"jaxbProvider"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.JAXBElementProvider"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"catalogLocation"</span> value=<span class="code-quote">"classpath:/schemas/mycatalog.xml"</span>/></span>
-<span class="code-tag"></bean></span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<bean id="jaxbProvider" class="org.apache.cxf.jaxrs.provider.JAXBElementProvider">
+ <property name="catalogLocation" value="classpath:/schemas/mycatalog.xml"/>
+</bean>
-</pre>
+]]></script>
</div></div>
<p>where mycatalog.xml may look like this:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><catalog xmlns=<span class="code-quote">"urn:oasis:names:tc:entity:<span class="code-keyword">xmlns:xml:catalog"> prefer=<span class="code-quote">"system"</span>></span>
- <span class="code-tag"><system systemId=<span class="code-quote">"http://schemas/bookid.xsd"</span> uri=<span class="code-quote">"classpath:WEB-INF/schemas/bookid.xsd"</span>/></span>
-<span class="code-tag"></catalog></span>
-</span></span></pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog" prefer="system">
+ <system systemId="http://schemas/bookid.xsd" uri="classpath:WEB-INF/schemas/bookid.xsd"/>
+</catalog>
+]]></script>
</div></div>
@@ -1030,42 +1038,42 @@ Starting from CXF 2.3.4 and 2.4, the fol
<p>You can enable the <a shape="rect" class="external-link" href="https://fi.dev.java.net/standardization.html" rel="nofollow">FastInfoset</a> by explicitly registering CXF FastInfoset interceptors with a JAXRS endpoint and configuring JAXBElementProvider to support an "application/fastinfoset" media type :<br clear="none">
for example :</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">"restservice3"</span> address=<span class="code-quote">"/rest3"</span>></span>
+<jaxrs:server id="restservice3" address="/rest3">
- <span class="code-tag"><jaxrs:serviceBeans></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"bookstore"</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">"jaxbProvider"</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">"fastInfosetOutInterceptor"</span>/></span>
- <span class="code-tag"></jaxrs:outInterceptors></span>
-
- <span class="code-tag"><jaxrs:inInterceptors></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"fastInfosetInInterceptor"</span>/></span>
- <span class="code-tag"></jaxrs:inInterceptors></span>
-
- <span class="code-tag"><jaxrs:properties></span>
- <span class="code-tag"><entry key=<span class="code-quote">"org.apache.cxf.endpoint.private"</span> value=<span class="code-quote">"true"</span>/></span>
- <span class="code-tag"></jaxrs:properties></span>
-<span class="code-tag"></jaxrs:server></span>
-
-<span class="code-tag"><util:list id=<span class="code-quote">"fastinfosetType"</span>></span>
- <span class="code-tag"><value></span>application/fastinfoset<span class="code-tag"></value></span>
-<span class="code-tag"></util:list></span>
-
-<span class="code-tag"><bean id=<span class="code-quote">"jaxbProvider"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.JAXBElementProvider"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"produceMediaTypes"</span> ref=<span class="code-quote">"fastinfosetType"</span>/></span>
- <span class="code-tag"><property name=<span class="code-quote">"consumeMediaTypes"</span> ref=<span class="code-quote">"fastinfosetType"</span>/></span>
-<span class="code-tag"></bean></span>
-<span class="code-tag"><bean id=<span class="code-quote">"fastInfosetOutInterceptor"</span> class=<span class="code-quote">"org.apache.cxf.interceptor.FIStaxOutInterceptor"</span>/></span>
-<span class="code-tag"><bean id=<span class="code-quote">"fastInfosetInInterceptor"</span> class=<span class="code-quote">"org.apache.cxf.interceptor.FIStaxInInterceptor"</span>/></span>
-</pre>
+ <jaxrs:serviceBeans>
+ <ref bean="bookstore"/>
+ </jaxrs:serviceBeans>
+
+ <jaxrs:providers>
+ <ref bean="jaxbProvider"/>
+ </jaxrs:providers>
+
+ <jaxrs:outInterceptors>
+ <ref bean="fastInfosetOutInterceptor"/>
+ </jaxrs:outInterceptors>
+
+ <jaxrs:inInterceptors>
+ <ref bean="fastInfosetInInterceptor"/>
+ </jaxrs:inInterceptors>
+
+ <jaxrs:properties>
+ <entry key="org.apache.cxf.endpoint.private" value="true"/>
+ </jaxrs:properties>
+</jaxrs:server>
+
+<util:list id="fastinfosetType">
+ <value>application/fastinfoset</value>
+</util:list>
+
+<bean id="jaxbProvider" class="org.apache.cxf.jaxrs.provider.JAXBElementProvider">
+ <property name="produceMediaTypes" ref="fastinfosetType"/>
+ <property name="consumeMediaTypes" ref="fastinfosetType"/>
+</bean>
+<bean id="fastInfosetOutInterceptor" class="org.apache.cxf.interceptor.FIStaxOutInterceptor"/>
+<bean id="fastInfosetInInterceptor" class="org.apache.cxf.interceptor.FIStaxInInterceptor"/>
+]]></script>
</div></div>
<p>Note that explicitly registering the interceptors is not required anymore given that CXF FastInfoset and Feature annotations are also currently supported.</p></div>
Modified: websites/production/cxf/content/docs/jax-rs-deployment.html
==============================================================================
--- websites/production/cxf/content/docs/jax-rs-deployment.html (original)
+++ websites/production/cxf/content/docs/jax-rs-deployment.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 Deployment">
+
+ <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 Deployment
</title>
@@ -42,19 +54,15 @@ Apache CXF -- JAX-RS Deployment
<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 Deployment
<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>
@@ -158,12 +166,12 @@ use a <a shape="rect" href="http://cxf.a
<p>If you configure CXFServlet to redirect to custom JSP pages then you need to add the following declaration to web.xml:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><servlet></span>
- <span class="code-tag"><servlet-name></span>jsp<span class="code-tag"></servlet-name></span>
- <span class="code-tag"><servlet-class></span>weblogic.servlet.JSPServlet<span class="code-tag"></servlet-class></span>
-<span class="code-tag"></servlet></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<servlet>
+ <servlet-name>jsp</servlet-name>
+ <servlet-class>weblogic.servlet.JSPServlet</servlet-class>
+</servlet>
+]]></script>
</div></div>
<h3><a shape="rect" name="JAX-RSDeployment-CXFRuntimeDelegate"></a>CXF RuntimeDelegate</h3>
@@ -174,12 +182,12 @@ use a <a shape="rect" href="http://cxf.a
<p>WebLogic requires the following update to the proprietary deployment descriptor weblogic.xml:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><container-descriptor></span>
- <span class="code-tag"><span class="code-comment"><!-- SNIP --></span></span>
- <span class="code-tag"><prefer-web-inf-classes></span>true<span class="code-tag"></prefer-web-inf-classes></span>
- <span class="code-tag"></container-descriptor></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <container-descriptor>
+ <!-- SNIP -->
+ <prefer-web-inf-classes>true</prefer-web-inf-classes>
+ </container-descriptor>
+]]></script>
</div></div>
<p>This instructs WebLogic's classloaders to look FIRST in the JARS from the application's WEB-INF/lib directory for Service Provider Implementations (in this case, to find META-INF/services/javax.xml.stream.XMLInputFactory in the Woodstox JAR) rather than to the system classloader.<br clear="none">