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 2017/09/11 19:56:30 UTC
svn commit: r1018013 [3/6] - in /websites/production/cxf/content: ./ cache/
docs/ docs/using-opentracing.data/
Modified: websites/production/cxf/content/docs/jax-rs-rxjava.html
==============================================================================
--- websites/production/cxf/content/docs/jax-rs-rxjava.html (original)
+++ websites/production/cxf/content/docs/jax-rs-rxjava.html Mon Sep 11 19:56:29 2017
@@ -117,19 +117,53 @@ Apache CXF -- JAX-RS RxJava
<!-- Content -->
<div class="wiki-content">
<div id="ConfluenceContent"><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1504004879079 {padding: 0px;}
-div.rbtoc1504004879079 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1504004879079 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1505159708675 {padding: 0px;}
+div.rbtoc1505159708675 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1505159708675 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1504004879079">
-<ul class="toc-indentation"><li><a shape="rect" href="#JAX-RSRxJava-RxJavarx.Observablesupport">RxJava rx.Observable support</a>
+/*]]>*/</style></p><div class="toc-macro rbtoc1505159708675">
+<ul class="toc-indentation"><li><a shape="rect" href="#JAX-RSRxJava-RxJava2FlowableandObservablesupport">RxJava2 Flowable and Observable support</a>
<ul class="toc-indentation"><li><a shape="rect" href="#JAX-RSRxJava-Introduction">Introduction</a></li><li><a shape="rect" href="#JAX-RSRxJava-Client">Client</a></li><li><a shape="rect" href="#JAX-RSRxJava-Server">Server</a>
-<ul class="toc-indentation"><li><a shape="rect" href="#JAX-RSRxJava-Asamethodreturnvalue">As a method return value</a></li><li><a shape="rect" href="#JAX-RSRxJava-CombiningwithAsyncResponse">Combining with AsyncResponse</a></li></ul>
+<ul class="toc-indentation"><li><a shape="rect" href="#JAX-RSRxJava-Asamethodreturnvalue">As a method return value</a></li><li><a shape="rect" href="#JAX-RSRxJava-CombiningFlowablewithAsyncResponse">Combining Flowable with AsyncResponse</a></li></ul>
</li></ul>
+</li><li><a shape="rect" href="#JAX-RSRxJava-RxJava1rx.Observablesupport">RxJava1 rx.Observable support</a>
+<ul class="toc-indentation"><li><a shape="rect" href="#JAX-RSRxJava-Introduction.1">Introduction</a></li><li><a shape="rect" href="#JAX-RSRxJava-Client.1">Client</a></li><li><a shape="rect" href="#JAX-RSRxJava-Server.1">Server</a>
+<ul class="toc-indentation"><li><a shape="rect" href="#JAX-RSRxJava-Asamethodreturnvalue.1">As a method return value</a></li></ul>
</li></ul>
-</div><h1 id="JAX-RSRxJava-RxJavarx.Observablesupport">RxJava rx.Observable support</h1><h2 id="JAX-RSRxJava-Introduction">Introduction</h2><p>RxJava 1 rx.Observable is supported on the client and the server side starting from CXF 3.2.0.</p><p>org.apache.cxf/cxf-rt-rs-extension-rx/3.2.0 dependency is required.</p><h2 id="JAX-RSRxJava-Client">Client</h2><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">import org.apache.cxf.jaxrs.rx.client.ObservableRxInvoker;
+</li></ul>
+</div><h1 id="JAX-RSRxJava-RxJava2FlowableandObservablesupport">RxJava2 Flowable and Observable support</h1><h2 id="JAX-RSRxJava-Introduction">Introduction</h2><p>RxJava 2 Flowable and Observable are supported on the client and the server side starting from CXF 3.2.0.</p><p>org.apache.cxf/cxf-rt-rs-extension-rx/3.2.0 and io.reactivex.rxjava2/rxjava/2.1.3 dependencies are required.</p><h2 id="JAX-RSRxJava-Client">Client</h2><p>The following simple example uses FlowableRxInvoker. org.apache.cxf.jaxrs.rx2.client.ObservableRxInvoker can be used if needed instead.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Confluence" style="font-size:12px;"> </pre>
+</div></div><h2 id="JAX-RSRxJava-Server">Server</h2><h3 id="JAX-RSRxJava-Asamethodreturnvalue">As a method return value</h3><p>One simply returns io.reactivex.Flowable from the method and the runtime will make sure the response is finalized once the Flowable flow is complete.</p><p>The only requirement is that one has to register a custom JAX-RS invoker, org.apache.cxf.jaxrs.rx2.server.FlowableInvoker. It does all the default JAXRSInvoker does and only checks if Flowable is returned - if yes then it links it internally with the JAX-RS AsyncResponse.</p><p>If needed, io.reactivex.Observable can be returned instead (with org.apache.cxf.jaxrs.rx2.server.ObservableInvoker registered)</p><h3 id="JAX-RSRxJava-CombiningFlowablewithAsyncResponse">Combining Flowable with AsyncResponse</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Confluence" style="font-size:12px;">JAXRSServerFactoryBean sf = new JAXRSServerFactoryBean();
+sf.setInvoker(new FlowableInvoker());
+sf.setProvider(new JacksonJsonProvider());
+StreamingResponseProvider<HelloWorldBean> streamProvider = new StreamingResponseProvider<HelloWorldBean>();
+streamProvider.setProduceMediaTypes(Collections.singletonList("application/json"));
+sf.setProvider(streamProvider);
+sf.setResourceClasses(RxJava2FlowableService.class);
+sf.setResourceProvider(RxJava2FlowableService.class,
+ new SingletonResourceProvider(new RxJava2FlowableService(), true));
+sf.setAddress("http://localhost:" + PORT + "/");
+server = sf.create();</pre>
+</div></div><p> </p><p> </p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Confluence" style="font-size:12px;">import org.apache.cxf.jaxrs.rx2.server.JsonStreamingAsyncSubscriber;
+import io.reactive.Flowable;
+import io.reactivex.schedulers.Schedulers;
+
+ // return a JSON array, write to the output stream as soon as the next JSON object becomes available
+ @GET
+ @Produces("application/json")
+ @Path("textJsonImplicitListAsyncStream")
+ public void getJsonImplicitListStreamingAsync(@Suspended AsyncResponse ar) {
+ Flowable.just("Hello", "Ciao")
+ .map(s -> new HelloWorldBean(s))
+ .subscribeOn(Schedulers.computation())
+ .subscribe(new JsonStreamingAsyncSubscriber<HelloWorldBean>(ar));
+ }</pre>
+</div></div><p> </p><h1 id="JAX-RSRxJava-RxJava1rx.Observablesupport">RxJava1 rx.Observable support</h1><h2 id="JAX-RSRxJava-Introduction.1">Introduction</h2><p>RxJava 1 rx.Observable is supported on the client and the server side starting from CXF 3.2.0.</p><p>org.apache.cxf/cxf-rt-rs-extension-rx/3.2.0 and io.reactivex/rxjava/1.3.0 dependencies are required.</p><h2 id="JAX-RSRxJava-Client.1">Client</h2><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Confluence" style="font-size:12px;">import org.apache.cxf.jaxrs.rx.client.ObservableRxInvoker;
import org.apache.cxf.jaxrs.rx.client.ObservableRxInvokerProvider;
+import rx.Observable;
 
@Test
public void testObservableWithWebClient() throws Exception {
@@ -165,40 +199,7 @@ import org.apache.cxf.jaxrs.rx.client.Ob
private void assertDuplicateResponse(String s) {
assertEquals("Hello, world!Hello, world!", s);
}</pre>
-</div></div><p> </p><h2 id="JAX-RSRxJava-Server">Server</h2><h3 id="JAX-RSRxJava-Asamethodreturnvalue">As a method return value</h3><p>One simply returns an Observable from the method and the runtime will make sure the response is finalized once the Observable flow is complete.</p><p>The only requirement is that one has to register a custom JAX-RS invoker, org.apache.cxf.jaxrs.rx.server.ObservableInvoker. It does all the default JAXRSInvoker does and only checks if Observable is returned - if yes then it links it internally with the JAX-RS AsyncResponse.</p><h3 id="JAX-RSRxJava-CombiningwithAsyncResponse">Combining with AsyncResponse</h3><p> </p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">import org.apache.cxf.jaxrs.rx.server.ListAsyncSubscriber;
-import org.apache.cxf.jaxrs.rx.server.JsonStreamingAsyncSubscriber;
-
-@GET
- @Produces("application/json")
- @Path("textJsonImplicitListAsync")
- public void getJsonImplicitListAsync(@Suspended AsyncResponse ar) {
- final HelloWorldBean bean1 = new HelloWorldBean();
- final HelloWorldBean bean2 = new HelloWorldBean("Ciao");
- new Thread(new Runnable() {
- public void run() {
- try {
- Thread.sleep(2000);
- } catch (InterruptedException ex) {
- // ignore
- }
- Observable.just(bean1, bean2).subscribe(new ListAsyncSubscriber<HelloWorldBean>(ar));
- }
- }).start();
-
- }
-
- // return a JSON array, write to the output stream as soon as the next JSON object becomes available
- @GET
- @Produces("application/json")
- @Path("textJsonImplicitListAsyncStream")
- public void getJsonImplicitListStreamingAsync(@Suspended AsyncResponse ar) {
- Observable.just("Hello", "Ciao")
- .map(s -> new HelloWorldBean(s))
- .subscribeOn(Schedulers.computation())
- .subscribe(new JsonStreamingAsyncSubscriber<HelloWorldBean>(ar));
- }</pre>
-</div></div></div>
+</div></div><p> </p><h2 id="JAX-RSRxJava-Server.1">Server</h2><h3 id="JAX-RSRxJava-Asamethodreturnvalue.1">As a method return value</h3><p>One simply returns an Observable from the method and the runtime will make sure the response is finalized once the Observable flow is complete.</p><p>The only requirement is that one has to register a custom JAX-RS invoker, org.apache.cxf.jaxrs.rx.server.ObservableInvoker. It does all the default JAXRSInvoker does and only checks if Observable is returned - if yes then it links it internally with the JAX-RS AsyncResponse.</p><p> </p></div>
</div>
<!-- Content -->
</td>
Modified: websites/production/cxf/content/docs/jaxrs-services-description.html
==============================================================================
--- websites/production/cxf/content/docs/jaxrs-services-description.html (original)
+++ websites/production/cxf/content/docs/jaxrs-services-description.html Mon Sep 11 19:56:29 2017
@@ -32,8 +32,8 @@
<link type="text/css" rel="stylesheet" href="/resources/highlighter/styles/shThemeCXF.css">
<script src='/resources/highlighter/scripts/shCore.js'></script>
-<script src='/resources/highlighter/scripts/shBrushJava.js'></script>
<script src='/resources/highlighter/scripts/shBrushXml.js'></script>
+<script src='/resources/highlighter/scripts/shBrushJava.js'></script>
<script>
SyntaxHighlighter.defaults['toolbar'] = false;
SyntaxHighlighter.all();
@@ -117,12 +117,15 @@ Apache CXF -- JAXRS Services Description
<td height="100%">
<!-- Content -->
<div class="wiki-content">
-<div id="ConfluenceContent"><p><span class="inline-first-p" style="font-size:2em;font-weight:bold">JAX-RS Services Description</span> </p><p> </p><p> </p><p> </p><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1487342825306 {padding: 0px;}
-div.rbtoc1487342825306 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1487342825306 li {margin-left: 0px;padding-left: 0px;}
+<div id="ConfluenceContent"><p><span style="font-size:2em;font-weight:bold">JAX-RS Services Description</span>
+
+
+ </p><p> </p><p> </p><p> </p><p><style type="text/css">/*<![CDATA[*/
+div.rbtoc1505159703225 {padding: 0px;}
+div.rbtoc1505159703225 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1505159703225 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1487342825306">
+/*]]>*/</style></p><div class="toc-macro rbtoc1505159703225">
<ul class="toc-indentation"><li><a shape="rect" href="#JAXRSServicesDescription-Swagger">Swagger</a>
<ul class="toc-indentation"><li><a shape="rect" href="#JAXRSServicesDescription-Swagger-FirstDevelopment">Swagger-First Development</a></li><li><a shape="rect" href="#JAXRSServicesDescription-SwaggerAutoGeneration">Swagger Auto Generation</a></li></ul>
</li><li><a shape="rect" href="#JAXRSServicesDescription-WADL">WADL</a>
@@ -141,7 +144,7 @@ div.rbtoc1487342825306 li {margin-left:
</li><li><a shape="rect" href="#JAXRSServicesDescription-java2wadlMavenplugin">java2wadl Maven plugin</a></li><li><a shape="rect" href="#JAXRSServicesDescription-WADLTransformations">WADL Transformations</a></li><li><a shape="rect" href="#JAXRSServicesDescription-ServicelistingsandWADLqueries">Service listings and WADL queries</a></li><li><a shape="rect" href="#JAXRSServicesDescription-WADLinJSONformat">WADL in JSON format</a></li></ul>
</li><li><a shape="rect" href="#JAXRSServicesDescription-HidinglinkstoJAXRSendpointsfromtheservicespage">Hiding links to JAXRS endpoints from the services page</a></li></ul>
</div><h1 id="JAXRSServicesDescription-Swagger">Swagger</h1><h2 id="JAXRSServicesDescription-Swagger-FirstDevelopment">Swagger-First Development</h2><h2 id="JAXRSServicesDescription-SwaggerAutoGeneration">Swagger Auto Generation</h2><p>Please see the <a shape="rect" href="http://cxf.apache.org/docs/swagger2feature.html">Swagger2Feature page</a> for more information</p><h1 id="JAXRSServicesDescription-WADL">WADL</h1><p> </p><p>CXF JAX-RS supports (Web Application Description Language|http://www.w3.org/Submission/wadl] (WADL). <br clear="none"> Users can use WADL documents to generate the initial code and have WADL auto-generated on demand.</p><h2 id="JAXRSServicesDescription-Overview">Overview</h2><p>WADL is a resource-centric description language which has been designed to facilitate the modeling, description and testing of<br clear="none"> RESTful Web applications. Please check the official <a shape="rect" class="external-link" href="http://www.w3.org/Submission/wadl/" rel="no
follow">page</a> for more information, this section provides a brief overview of main WADL constructs.</p><h3 id="JAXRSServicesDescription-Basicexample">Basic example</h3><p>A top level WADL document element is called "application". Usually it may contain a "grammars" section and "resources" element with one or more top-level "resource" elements, with each one representing a specific root resource, for example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><application xmlns="http://wadl.dev.java.net/2009/02" xmlns:ns="http://superbooks">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><application xmlns="http://wadl.dev.java.net/2009/02" xmlns:ns="http://superbooks">
<grammars>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://superbooks" attributeFormDefault="unqualified" elementFormDefault="unqualified"
@@ -178,7 +181,7 @@ div.rbtoc1487342825306 li {margin-left:
</application>
</pre>
</div></div><p>This document describes an application that has "http://localhost:8080/" base URI. It can handle GET requests such as<br clear="none"> "http://localhost:8080/bookstore/1", "http://localhost:8080/bookstore/123", etc. Additionally it can handle similar GET requests at<br clear="none"> "http://localhost:8080/books/bookstore/1", "http://localhost:8080/books/bookstore/123", etc, note an extra "books" path segment.</p><p>"application/xml" media type is supported and response representation elements link to "{<a shape="rect" class="external-link" href="http://superbooks" rel="nofollow">http://superbooks</a>}thebook" element declared in a schema inlined in the grammars section.</p><p>Note that "resources" element has two child "resource" elements, one with "/bookstore/{id}" path, another one with "/books" path.</p><p>These 2 resources can be represented as JAX-RS root resources. For example, these resources can be mapped to concrete Java classes such as BookStoreRootResource
with @Path("/bookstore/{id}") and BooksResource with @Path("/books"). BookStoreRootResource root resource will have a single @GET resource method with no @Path, presumably returning Book (JAXB) bean. The second BooksResource root resource will have a single subresource locator with @Path("/bookstore/{id}") which will return a subresource with a single @GET resource method.</p><p>This is just one possible interpretation of how the above WADL description can be mapped to JAX-RS resources and methods.</p><p>Also note that the resource with the "/books" path has another child resource with the "/bookstore/{id}" path, but it could've had a "/books/bookstore/{id}" path instead and no child resource.</p><h3 id="JAXRSServicesDescription-WADLwithreferences">WADL with references</h3><p>Basic WADL example in the previous section shows a "grammars" section with the inlined schema, as well as a "resource" description with the "/bookstore/{id}" path listed twice, as an immediate child of the "res
ources" and as a child of the "resource" element with the "/books" path.</p><p>Note that inlined schemas can be included instead by referencing external schemas. Likewise, most of WADL element declarations such as "resource", "method", "representation", etc can be shared by using the same document or external references. Here is how the basic example can be simplified with the help of references:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><application xmlns="http://wadl.dev.java.net/2009/02" xmlns:ns="http://superbooks">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><application xmlns="http://wadl.dev.java.net/2009/02" xmlns:ns="http://superbooks">
<grammars>
<include href="schemas/book.xsd"/>
</grammars>
@@ -206,7 +209,7 @@ div.rbtoc1487342825306 li {margin-left:
</application>
</pre>
</div></div><p>Note that a book.xsd schema resource located in the 'schemas' path relative to the location of this WADL document is referenced using wadl:include element. Abstract resource type "bookResource" is declared as an immediate child of wadl:application and is linked to concrete resource elements using a "#bookResource" reference.</p><h3 id="JAXRSServicesDescription-SharingdeclarationsbetweenmultipleWADLs">Sharing declarations between multiple WADLs</h3><p>WADL references allow for having WADL documents with abstract declarations only and concrete WADLs referencing them, thus making it possible to reuse resource declarations in different web application descriptions.</p><p>For example, the following baseApplication.wadl documents describes an abstract "bookResource" resource:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><application xmlns="http://wadl.dev.java.net/2009/02" xmlns:ns="http://superbooks">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><application xmlns="http://wadl.dev.java.net/2009/02" xmlns:ns="http://superbooks">
<grammars>
<include href="schemas/book.xsd"/>
</grammars>
@@ -222,7 +225,7 @@ div.rbtoc1487342825306 li {margin-left:
</application>
</pre>
</div></div><p>and this WADL document links to the abstract resource by using an external WADL reference with a "baseResource" fragment.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><application xmlns="http://wadl.dev.java.net/2009/02" xmlns:ns="http://superbooks">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><application xmlns="http://wadl.dev.java.net/2009/02" xmlns:ns="http://superbooks">
<resources base="http://localhost:8080/">
<resource path="/bookstore/{id}" type="baseApplication.wadl#bookResource"/>
@@ -233,7 +236,7 @@ div.rbtoc1487342825306 li {margin-left:
</application>
</pre>
</div></div><p><strong>New</strong>: Starting from CXF 2.5.0 and 2.4.4 all WADL elements may link to top-level local declarations, see this <a shape="rect" class="external-link" href="http://www.w3.org/Submission/wadl/#x3-36000A.2" rel="nofollow">example</a>.</p><h2 id="JAXRSServicesDescription-WADL-firstDevelopment">WADL-first Development</h2><p>CXF 2.4.1 introduces a wadl2java code generator and cxf-wadl2java-plugin Maven plugin which can be used to generate server and client JAX-RS code and speed up the transition between modeling and implementation stages.</p><p><strong>Note</strong> If you are looking for a wadl2java code generator from a Java.net project started by Marc Hadley then please follow this <a shape="rect" class="external-link" href="http://wadl.java.net/wadl2java.html" rel="nofollow">link</a>.</p><p>Code generator expects WADL resource and method elements to have "id" attributes set which can provide hints on how to name generated classes and methods. For example:</
p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><application xmlns="http://wadl.dev.java.net/2009/02" xmlns:ns="http://superbooks">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><application xmlns="http://wadl.dev.java.net/2009/02" xmlns:ns="http://superbooks">
<grammars>
<include href="schemas/book.xsd"/>
</grammars>
@@ -258,8 +261,8 @@ div.rbtoc1487342825306 li {margin-left:
-generateResponseIfHeadersSet -generateResponseForMethods<methodNames>* -async<methodNames>* -xjc<xjc-arguments>*
-validate -h -v -verbose -quiet <wadl>
</pre>
-</div></div><p>Note 'tMap', 'repMap', 'noTypes' and 'inheritResourceParams' options are supported starting from CXF 2.6.3, 'noVoidForEmptyResponses' - from 2.6.4, '-async' - from 2.7.1, '-xjc' - from 2.7.4,</p><p>'generateResponseForMethods' and 'generateResponseIfHeadersSet' - from 2.7.12/3.0.0, 'validate' - from 2.7.13/3.2.0/3.1.0, 'javaDocs' - from 3.1.4</p><p>The options are reviewed in the following table.</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Interpretation</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-?</code>,<code>-h</code>,<code>-help</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Displays the online help for this utility and exits.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-p PackageName</code></p></td><td colspan="1" rowspan="1" class="conflu
enceTd"><p>Specifies the package name of root resource classes</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-sp [ schema-namespace= ] PackageName</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies one or more package names corresponding to individual schema namespaces</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-resource RootResourceName</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies a full name of root resource class if WADL contains a single resource</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-interface</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Default option unless -impl option is used - Java interfaces with JAX-RS annotations are generated</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-impl</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Generates starting impl
ementation code. Can also be used with -interface option</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-noTypes</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Requests that no schema generation is needed. Can also be used with -tMap option</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-tMap schema-type=java-type</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Provides mapping between schema elements and java types</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-repMap media-type=java-type</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Provides mapping between media types and java types</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-b binding-name</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies JAXB binding files. Use multiple -b flags to specify multiple entries.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>-catalog catalog-file-name</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies catalog file to map referenced wadl/schemas</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-d output-directory</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the directory into which the generated code files are written.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-compile</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Compiles generated Java files.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-classdir compile-class-dir</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the directory into which the compiled class files are written.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-noVoidForEmptyResponses</code></p></td><td colspan="1" row
span="1" class="confluenceTd"><p>Generate JAX-RS Response instead of 'void' for methods with no response representations.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-inheritResourceParams</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Get current resource-level path or matrix parameters added to generated methods for all descendant resources.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-generateEnums</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Generates Java enums for parameters with options.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-supportMultipleXmlReps</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Generates separate method for every XML representation in a single WADL request element.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">-javaDocs</td><td colspan="1" rowspan="1" class="confluenceTd">Converts
WADL doc elements into JavaDocs</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">-generateResponseIfHeadersSet</td><td colspan="1" rowspan="1" class="confluenceTd">Generates JAX-RS Response method response type if  WADL response element for a given method has 'header' parameters</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">-generateResponseForMethods methodNames</td><td colspan="1" rowspan="1" class="confluenceTd">Generates JAX-RS Response method response type, methodNames is a comma-separated list of WADL method name or id attributes</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-async methodNames</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Adds JAX-RS 2.0 AsyncResponse parameter to generated methods, methodNames is a comma-separated list of WADL method name or id attributes</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-xjc<xjc args></code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Specifies a comma separated list of arguments that are passed directly to the XJC processor, example -xjc-Xts.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">-validate</td><td colspan="1" rowspan="1" class="confluenceTd">Validate a WADL document against the WADL schema</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><em>wadlurl</em></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The path and name of the WADL file to use in generating the code.</p></td></tr></tbody></table></div><p>You must specify the absolute or relative path to the WADL document as the last argument.<br clear="none"> OASIS catalog files can be used to help the tool resolve referenced WADL and schema documents.</p><p>Note 'tMap' option can be used to map between schema element references and java types and can be used to customize the default schema to Java type mapping. For example, in order to override a default parameter 'xs:dat
e' to java.util.Date mapping one can do '-tMap {<a shape="rect" class="external-link" href="http://www.w3.org/2001/XMLSchema" rel="nofollow">http://www.w3.org/2001/XMLSchema</a>}date=javax.xml.datatype.XMLGregorianCalendar' - this can affect the "<wadl:param type='xs:date'>" declarations.<br clear="none"> Alternatively, in combination with a '-noTypes' switch, this option can be used to request that a custom Java type reference should be generated. For example, if one prefers to use 'javax.xml.transform.Source' for handling a given XML payload, one can do <br clear="none"> '-tMap {<a shape="rect" class="external-link" href="http://book" rel="nofollow">http://book</a>}Book=javax.xml.transform.Source', this will affect "<wadl:representation element='ns:Book'>" declarations where 'ns' prefix is bound to the 'http://book' namespace. Similarly, a schema reference to Atom Feed element can be mapped to say Abdera Feed class.</p><p>The 'repMap' option is similar and provides a m
apping between the representations of a given media type and Java type. For example, if one has to process different XML representations in one method, a mapping like '-repMap application/xml=javax.xml.transform.Source' will work, affecting declarations like "<wadl:representation mediaTpe='application/xml'". Similarly CXF org.apache.cxf.jaxrs.ext.multipart.MultipartBody class can be linked to 'multipart/form-data' representations, etc.</p><p>The 'generateResponseForMethods' and 'async' options accept a comma separated list of method names, providing a single '*' (no quotes) as a method name will get these options affecting all of the generated methods.</p><p>In some cases, example when describing JSON arrays, you may want to have an explicit collection of types defined in schema generated. In this case use -tMap or -repMap option with a value such as "List..MyType".</p><p> </p><h4 id="JAXRSServicesDescription-JAXBcustomizations">JAXB customizations</h4><p>At the moment it is
possible to apply external JAXB customizations to WADL grammars however it is not possible yet to restrict a given customization to a specific WADL document or explicitly inlined schema. Linking binding to external schemas works, for example, the following bindings file can be used:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><jaxb:bindings version="2.0"
+</div></div><p>Note 'tMap', 'repMap', 'noTypes' and 'inheritResourceParams' options are supported starting from CXF 2.6.3, 'noVoidForEmptyResponses' - from 2.6.4, '-async' - from 2.7.1, '-xjc' - from 2.7.4,</p><p>'generateResponseForMethods' and 'generateResponseIfHeadersSet' - from 2.7.12/3.0.0, 'validate' - from 2.7.13/3.2.0/3.1.0, 'javaDocs' - from 3.1.4, 'authorization' - from 3.1.13</p><p>The options are reviewed in the following table.</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Interpretation</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-?</code>,<code>-h</code>,<code>-help</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Displays the online help for this utility and exits.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-p PackageName</code></p></td><td colspa
n="1" rowspan="1" class="confluenceTd"><p>Specifies the package name of root resource classes</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-sp [ schema-namespace= ] PackageName</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies one or more package names corresponding to individual schema namespaces</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-resource RootResourceName</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies a full name of root resource class if WADL contains a single resource</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-interface</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Default option unless -impl option is used - Java interfaces with JAX-RS annotations are generated</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-impl</code></p></td><td colspan="1" rowspan="1" class="confluenc
eTd"><p>Generates starting implementation code. Can also be used with -interface option</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-noTypes</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Requests that no schema generation is needed. Can also be used with -tMap option</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-tMap schema-type=java-type</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Provides mapping between schema elements and java types</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-repMap media-type=java-type</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Provides mapping between media types and java types</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-b binding-name</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies JAXB binding files. Use multiple -b flags to specify multipl
e entries.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-catalog catalog-file-name</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies catalog file to map referenced wadl/schemas</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-d output-directory</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the directory into which the generated code files are written.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-compile</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Compiles generated Java files.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-classdir compile-class-dir</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the directory into which the compiled class files are written.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-noVoidForEmptyResponses</co
de></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Generate JAX-RS Response instead of 'void' for methods with no response representations.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-inheritResourceParams</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Get current resource-level path or matrix parameters added to generated methods for all descendant resources.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-generateEnums</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Generates Java enums for parameters with options.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-supportMultipleXmlReps</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Generates separate method for every XML representation in a single WADL request element.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">-javaDocs</td><td colspan="1" rowspan="1"
class="confluenceTd">Converts WADL doc elements into JavaDocs</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">-generateResponseIfHeadersSet</td><td colspan="1" rowspan="1" class="confluenceTd">Generates JAX-RS Response method response type if  WADL response element for a given method has 'header' parameters</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">-generateResponseForMethods methodNames</td><td colspan="1" rowspan="1" class="confluenceTd">Generates JAX-RS Response method response type, methodNames is a comma-separated list of WADL method name or id attributes</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-async methodNames</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Adds JAX-RS 2.0 AsyncResponse parameter to generated methods, methodNames is a comma-separated list of WADL method name or id attributes</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">-authorization</td><td colspan
="1" rowspan="1" class="confluenceTd"><p>Specifies a colon separated user name and password for retrieving the remote WADL content from the servers requiring Basic authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-xjc<xjc args></code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies a comma separated list of arguments that are passed directly to the XJC processor, example -xjc-Xts.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">-validate</td><td colspan="1" rowspan="1" class="confluenceTd">Validate a WADL document against the WADL schema</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><em>wadlurl</em></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The path and name of the WADL file to use in generating the code.</p></td></tr></tbody></table></div><p>You must specify the absolute or relative path to the WADL document as the last argument.<br clear="none"> OASIS catalog
files can be used to help the tool resolve referenced WADL and schema documents.</p><p>Note 'tMap' option can be used to map between schema element references and java types and can be used to customize the default schema to Java type mapping. For example, in order to override a default parameter 'xs:date' to java.util.Date mapping one can do '-tMap {<a shape="rect" class="external-link" href="http://www.w3.org/2001/XMLSchema" rel="nofollow">http://www.w3.org/2001/XMLSchema</a>}date=javax.xml.datatype.XMLGregorianCalendar' - this can affect the "<wadl:param type='xs:date'>" declarations.<br clear="none"> Alternatively, in combination with a '-noTypes' switch, this option can be used to request that a custom Java type reference should be generated. For example, if one prefers to use 'javax.xml.transform.Source' for handling a given XML payload, one can do <br clear="none"> '-tMap {<a shape="rect" class="external-link" href="http://book" rel="nofollow">http://book</a>}Book=java
x.xml.transform.Source', this will affect "<wadl:representation element='ns:Book'>" declarations where 'ns' prefix is bound to the 'http://book' namespace. Similarly, a schema reference to Atom Feed element can be mapped to say Abdera Feed class.</p><p>The 'repMap' option is similar and provides a mapping between the representations of a given media type and Java type. For example, if one has to process different XML representations in one method, a mapping like '-repMap application/xml=javax.xml.transform.Source' will work, affecting declarations like "<wadl:representation mediaTpe='application/xml'". Similarly CXF org.apache.cxf.jaxrs.ext.multipart.MultipartBody class can be linked to 'multipart/form-data' representations, etc.</p><p>The 'generateResponseForMethods' and 'async' options accept a comma separated list of method names, providing a single '*' (no quotes) as a method name will get these options affecting all of the generated methods.</p><p>In some cases, exampl
e when describing JSON arrays, you may want to have an explicit collection of types defined in schema generated. In this case use -tMap or -repMap option with a value such as "List..MyType".</p><p> </p><h4 id="JAXRSServicesDescription-JAXBcustomizations">JAXB customizations</h4><p>At the moment it is possible to apply external JAXB customizations to WADL grammars however it is not possible yet to restrict a given customization to a specific WADL document or explicitly inlined schema. Linking binding to external schemas works, for example, the following bindings file can be used:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><jaxb:bindings version="2.0"
xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
schemaLocation="schemas/book.xsd"
@@ -268,12 +271,12 @@ div.rbtoc1487342825306 li {margin-left:
</jaxb:bindings>
</pre>
</div></div><h3 id="JAXRSServicesDescription-wadl2javaMavenplugin">wadl2java Maven plugin</h3><p>If you need the code generated during Maven build then the following plugin can be used:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><groupId>org.apache.cxf</groupId>
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><groupId>org.apache.cxf</groupId>
<artifactId>cxf-wadl2java-plugin</artifactId>
<version>2.4.1</version>
</pre>
</div></div><p>Add this plugin to the build section of your project's pom and specify a 'wadl2java' goal, for example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><build>
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><build>
<plugins>
<plugin>
<groupId>org.apache.cxf</groupId>
@@ -308,7 +311,7 @@ div.rbtoc1487342825306 li {margin-left:
</build>
</pre>
</div></div><p>Note that the minimum and maximum memory limits may need to be increased when using the plugin to process large WADL documents, for example, add "-Xms512M -Xmx1024M" to the list of Maven options.</p><p>CXF will generate artifacts in the <sourceRoot> directory. Configuration arguments which are included inside the <wadlOption> element are used to pass arguments to the tooling and correspond to the options outlined in the wadltojava section, they can be specified explicitly, as above, or using an "extraargs" wrapper, for example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><wadlOptions>
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><wadlOptions>
<wadlOption>
<wadl>$\{basedir}/src/main/wadl/bookStore.wadl</wsdl>
<extraargs>
@@ -319,26 +322,26 @@ div.rbtoc1487342825306 li {margin-left:
</wadlOptions>
</pre>
</div></div><h3 id="JAXRSServicesDescription-Integration">Integration</h3><p>Two options are available to developers who wish to integrate CXF JAX-RS WADLToJava code generator.<br clear="none"> First option is to pass the collected options directly to a wadltojava process.</p><p>Another approach is to use org.apache.cxf.tools.wadlto.jaxrs.JAXRSContainer class shipped with the cxf-tools-wadlto-jaxrs module:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><groupId>org.apache.cxf</groupId>
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><groupId>org.apache.cxf</groupId>
<artifactId>cxf-tools-wadlto-jaxrs</artifactId>
<version>2.4.1</version>
</pre>
</div></div><p>Please see CXF source for more details and org.apache.cxf.tools.wadlto.jaxrs.JAXRSContainerTest in particular.</p><h3 id="JAXRSServicesDescription-ExternalWADLdocumentsandJAXRSendpoints.">External WADL documents and JAXRS endpoints.</h3><p>External WADL documents can be linked to from jaxrs:server endpoints using newly introduced "docLocation" attribute, for example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><jaxrs:server address="/rest" docLocation="wadl/bookStore.wadl">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><jaxrs:server address="/rest" docLocation="wadl/bookStore.wadl">
<jaxrs:serviceBeans>
<bean class="org.bar.generated.BookStore"/>
</jaxrs:serviceBeans>
</jaxrs:server>
</pre>
</div></div><p>If external WADL documents include external schemas and jaxrs endpoints need to have the schema validation enabled, then those schemas can be referenced in the jaxrs:schemaLocations section as well.</p><h2 id="JAXRSServicesDescription-WADLAutoGenerationatRuntime">WADL Auto Generation at Runtime</h2><p>Note that in CXF 3.0.0 WADL Generator code has been moved to</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><dependency>
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-rs-service-description</artifactId>
<version>3.0.0-milestone1</version>
</dependency>
</pre>
</div></div><p>CXF JAX-RS supports the auto-generation of WADL for JAX-RS endpoints. <br clear="none"> Note that JAX-RS subresources are late-resolved by default, so using annotated interfaces for subresources and a staticSubresourceResolution=true property will let the whole resource tree/graph be described in a generated instance. Schemas will be generated for JAXB-annotated types. See below for the information on how to get auto-generated WADL instances reference existing schemas.</p><p><strong>CXF 2.4.0</strong>: org.apache.cxf.jaxrs.ext.Description and org.apache.cxf.jaxrs.ext.xml.XMLName have been moved to org.apache.cxf.jaxrs.model.wadl package given that their purpose is to improve the WADL generation. Also, org.apache.cxf.jaxrs.model.wadl.WadlElement has been renamed to 'ElementClass'.</p><h3 id="JAXRSServicesDescription-DocumentingresourceclassesandmethodsingeneratedWADL">Documenting resource classes and methods in generated WADL</h3><p>WADL documents can include <a shape=
"rect" class="external-link" href="http://www.w3.org/Submission/wadl/#x3-80002.3" rel="nofollow">doc</a> fragments.</p><p>Users may want to use <a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/model/wadl/Description.java" rel="nofollow">Description</a> annotations which can be attached to resource classes and methods.</p><p>Note that starting from CXF 2.4.0, Description annotations can be applied to input parameters. Additionally, a method-level <a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/model/wadl/Descriptions.java" rel="nofollow">Descriptions</a> annotation can have a collection of categorized Description annotations, with each Description targeting a specific WADL element by setting its 'target' property to one of the <a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/m
aster/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/model/wadl/DocTarget.java" rel="nofollow">DocTarget</a> values. For example, one can use a Descriptions annotation to document the response representation of a particular resource method, as well as add documentation fragments to WADL wadl:method/wadl:request and wadl:method/wadl:response elements:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">@POST
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">@POST
@Path("books/{bookid}")
@Descriptions({
@Description(value = "Adds a new book", target = DocTarget.METHOD),
@@ -350,7 +353,7 @@ div.rbtoc1487342825306 li {margin-left:
public Book addBook(@Description("book id") @PathParam("id") Long id, @Description("New Book") Book book) {...}
</pre>
</div></div><p>Every unique @Path value adds a new 'resource' element to the generated WADL, thus the last Description annotation in the @Descriptions array ensures the doc extension is also added to the 'resource' element. Note that multiple resource methods having different HTTP methods but sharing the same @Path value will have the same parent 'resource' element representing this shared path fragment, in this case a Description with the DocTarget.RESOURCE target will be ignored unless it is added to the first resource method with this shared @Path:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">@POST
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">@POST
@Path("books/{bookid}")
@Description(value = "Resource", target = DocTarget.RESOURCE),
public Book addBook(@Description("book id") @PathParam("id") Long id, @Description("New Book") Book book) {...}
@@ -360,34 +363,34 @@ public Book addBook(@Description("book i
public Book addBook(@Description("book id") @PathParam("id") Long id) {...}
</pre>
</div></div><h4 id="JAXRSServicesDescription-SupportforJavadoc">Support for Javadoc</h4><p>In CXF 3.0.0 one can get the Javadoc documentation copied to WADL being auto-generated at runtime.</p><p>org.apache.cxf.jaxrs.model.wadl.JavaDocProvider implements org.apache.cxf.jaxrs.model.wadl.DocumentationProvider and can be set as WADLGenerator "documentationProvider" property.</p><p>JavaDocProvider can be customized with URL or relative String path pointing to the generated Javadoc jar, so this jar can be shipped in the application war or located elsewhere.</p><p>JavaDocProvider parses the generated Javadoc HTML pages and scrapes the documentation. See Java to Wadl section on the alternative approach for supporting Javadoc.</p><h3 id="JAXRSServicesDescription-CustomizingWADLGeneration">Customizing WADL Generation</h3><p>One can register a custom WadlGenerator as a jaxrs:provider. The custom generator can extend the default <br clear="none"> org.apache.cxf.jaxrs.model.wadl.WadlGenerator o
r register a default one with one of the following properties set.</p><ul class="alternate"><li>wadlNamespace: default is "http://wadl.dev.java.net/2009/02", the earlier one is "http://research.sun.com/wadl/2006/10".</li><li>singleResourceMultipleMethods: default is 'true', for example, if a resource class has multiple methods supported at the same path such as "/" (GET, POST, etc) then WADL will list them all as the child nodes of a single resource element.</li><li>useSingleSlashResource: default is false, for example, if you have a root resource class with a path "root" and a resource method with a path "" or "/" then a WADL resource representing the root will not have a child resource representing this resource method (it would do if a resource method had a more specific path such as "bar").</li></ul><p>Starting from CXF 2.4.1 and 2.3.5 the following properties are also supported:</p><ul class="alternate"><li>applicationTitle: can be used to create an application title.</li><li>n
amespacePrefix: defaut is 'prefix', it can be set to other value such as 'ns'.</li><li>ignoreForwardSlash: can be used to enforce that resource path values do not start from '/'</li><li>addResourceAndMethodIds: WadlGenerator will add "id" attributes to wadl:resource and wadl:method elements</li></ul><p>An <a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/model/xml/ElementClass.java" rel="nofollow">ElementClass</a> annotation can help with representing JAX-RS Response elements in the generated WADL.</p><h4 id="JAXRSServicesDescription-RepresentingexplicitJAXBcollections">Representing explicit JAXB collections</h4><p>Starting from CXF 2.5.5 and 2.6.2 it is possible to get explicit collections represented in generated WADL grammar sections and have WADL representations linking to these schema elements. Note it is only possible for JAXB collections, for example:</p><div class="code panel pdl" style=
"border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">@GET
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">@GET
@Path("books")
@org.apache.cxf.jaxrs.model.xml.XMLName("{http://books}books")
public List<Book> getBooks() {...}
</pre>
</div></div><p>Given the above example, WADLGenerator will attempt to add a 'books' element to the generated schema with the targetNamespace set to "http://books". This 'books' element will have a sequence of elements linking to a type representing the "Book" class.</p><h4 id="JAXRSServicesDescription-RepresentingexternalschemasandnonJAXBtypes">Representing external schemas and non JAXB types</h4><p>By default, the WADL grammar section will be properly generated if resource methods accept or return JAXB types.</p><p>Even when you do use JAXB, the JAXB types may have been generated from the external schema so having WadlGenerator attempting to recreate the original schema may not work well. To have a generated WADL referencing the original schema(s) please set a 'schemaLocations' list property (programmatically or from Spring) :</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">WadlGenerator wg = new WadlGenerator();
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">WadlGenerator wg = new WadlGenerator();
wg.setSchemaLocations(Collections.singletonList("classpath:/book.xsd"));
</pre>
</div></div><p>In this case the grammar section will have the 'book.xsd' schema inlined. If this schema imports other schemas then the imports with relative URIs will be replaced by the absolute URIs based on the current endpoint's base address. For example, if the endpoint address is "http://somehost/bar" and the 'book.xsd' imports "foo/book1.xsd" then the published WADL will contain an "http://somehost/bar/foo/book1.xsd". At the moment a custom RequestHandler filter will have to be registered to serve resources such as "http://somehost/bar/foo/book1.xsd" which can 'calculate' which resource is required get the absolute request URI and comparing it with the base URI, possibly with the help of the injected JAXRS UriInfo context. Alternatively, resources such as book1.xsd may be served by CXFServlet itself (see the Redirection with CXFServlet)</p><p>TODO : add ignoreImports flag so that users can list root and imported schemas in "schemaLocations" and have them all inlined.</p><p>Not
e that the root schema such as "book.xsd" is inlined - you can have it referenced only by setting an 'externalLinks' list property. This will work very well when the "book.xsd" is indeed available at the external URI, but this property can also be used to avoid the local schemas being inlined. Moreover, the use of JAXB will not be required. The result will look like this:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><wadl:grammars>
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><wadl:grammars>
<wadl:include href="http://books.xsd"/>
</wadl:grammars>
</pre>
</div></div><p>Note that "schemaLocations" and "externalLinks" properties differ in that the schemas referenced by the former one are inlined.</p><p>You can also customize the way schema elements are referenced. When WadlGenerator creates WADL representation elements (representing resource method input or output types) it will be able to link to schema elements provided a given type is actually a JAXB one, so the result may look like this :</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><!--
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><!--
thebook2 element is declared in a schema inlined in or referenced from the grammar section
prefix1 is bound to that schema's target namespace and is declared at the wadl:application element
-->
<representation mediaType="application/xml" element="prefix1:thebook2"/>
</pre>
</div></div><p>If no JAXB is used then you can attach an <a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/model/xml/XMLName.java" rel="nofollow">XMLName</a> annotation to method input or output types. Alternatively, you can register an instance of <a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/model/wadl/ElementQNameResolver.java" rel="nofollow">ElementQNameResolver</a> with the WadlGenerator which will be used for creating wadl:representation/@element values.</p><h4 id="JAXRSServicesDescription-Changingthebaseaddress">Changing the base address</h4><p>Starting from CXF 2.6.2 it is possible to affect the base address specified in the auto-generated WADL (in wadl:resources/@base attribute).<br clear="none"> WADLGenerator can be indirectly configured by setting a jaxrs:server/@publishedEndpointUrl attribute
, similarly to the way CXF WSDL generator can be configured by setting a jaxws:endpoint/@publishedEndpointUrl attribute.</p><p> </p><h2 id="JAXRSServicesDescription-java2wadlMavenplugin">java2wadl Maven plugin</h2><p>CXF 3.0.0 and 2.7.11 introduce java2wadl plugin for generating WADL at the build time:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><groupId>org.apache.cxf</groupId>
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><groupId>org.apache.cxf</groupId>
<artifactId>cxf-java2wadl-plugin</artifactId>
<version>3.0.0</version>
</pre>
</div></div><p>Add this plugin to the build section of your project's pom, for example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><build>
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><build>
<plugins>
<plugin>
@@ -428,13 +431,13 @@ wg.setSchemaLocations(Collections.single
</build>
</pre>
</div></div><p>Note that Javadoc can be properly supported by enabling the "parsejavadoc" execution and a docProvider property.</p><h2 id="JAXRSServicesDescription-WADLTransformations">WADL Transformations</h2><p>Starting from CXF 3.0.4 it is possible to configure WADLGenerator with a 'stylesheetReference' property pointing to a local XSLT template. </p><p>If an 'applyStylesheetLocally' property is disabled (default) then a generated WADL XML representation will include an XML XSLT processing instruction pointing to a template with the browser downloading it in the next step and doing the transformation itself. Otherwise WADLGenerator will attempt to do a local transformation before returning a response to the browser.</p><p>This feature can help with further enhancing the generated WADL XML with some simple transformations (example, adding some information to WADL XML that is not possible to get from the annotated JAX-RS resources) or convert it to HTML.</p><h2 id="JAXRSServic
esDescription-ServicelistingsandWADLqueries">Service listings and WADL queries</h2><p>Links to WADL instances for RESTful endpoints are available from {base endpointaddress}/services, in addition to SOAP endpoints if any.</p><p>For example, given</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">Base address : 'http://localhost:8080'
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">Base address : 'http://localhost:8080'
WAR name : 'store'
CXFServlet : '/books/*'
jaxrs:server/@address = '/orders'
</pre>
</div></div><p>and visiting</p><p>> <a shape="rect" class="external-link" href="http://localhost:8080/store/books" rel="nofollow">http://localhost:8080/store/books</a> <br clear="none"> > <a shape="rect" class="external-link" href="http://localhost:8080/store/books/services" rel="nofollow">http://localhost:8080/store/books/services</a></p><p>will let you see all the WADL links.</p><p>Note that you can override the location at which listings are provided (in case you would like '/services' be available to your resources) using 'service-list-path' CXFServlet parameter, example:</p><p>> 'service-list-path' = '/listings'</p><p>Going to the service listings page is not the only way to see WADL instances, one can also get it using a ?_wadl query.</p><p>> <a shape="rect" class="external-link" href="http://localhost:8080/store/books/orders?_wadl" rel="nofollow">http://localhost:8080/store/books/orders?_wadl</a></p><p>will give you the description of all the root resource classes
registered<br clear="none"> with a given jaxrs:server endpoint.</p><p>For example, if the following 2 root resource classes has been registered with this endpoint:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">@Path("/fiction")
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">@Path("/fiction")
public class FictionBookOrders {
}
@Path("/sport")
Modified: websites/production/cxf/content/docs/springboot.html
==============================================================================
--- websites/production/cxf/content/docs/springboot.html (original)
+++ websites/production/cxf/content/docs/springboot.html Mon Sep 11 19:56:29 2017
@@ -32,8 +32,8 @@
<link type="text/css" rel="stylesheet" href="/resources/highlighter/styles/shThemeCXF.css">
<script src='/resources/highlighter/scripts/shCore.js'></script>
-<script src='/resources/highlighter/scripts/shBrushJava.js'></script>
<script src='/resources/highlighter/scripts/shBrushXml.js'></script>
+<script src='/resources/highlighter/scripts/shBrushJava.js'></script>
<script src='/resources/highlighter/scripts/shBrushPlain.js'></script>
<script>
SyntaxHighlighter.defaults['toolbar'] = false;
@@ -119,11 +119,11 @@ Apache CXF -- SpringBoot
<!-- Content -->
<div class="wiki-content">
<div id="ConfluenceContent"><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1490118477866 {padding: 0px;}
-div.rbtoc1490118477866 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1490118477866 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1505159705599 {padding: 0px;}
+div.rbtoc1505159705599 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1505159705599 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1490118477866">
+/*]]>*/</style></p><div class="toc-macro rbtoc1505159705599">
<ul class="toc-indentation"><li><a shape="rect" href="#SpringBoot-SpringBootCXFJAX-WSStarter">Spring Boot CXF JAX-WS Starter</a>
<ul class="toc-indentation"><li><a shape="rect" href="#SpringBoot-Features">Features</a></li><li><a shape="rect" href="#SpringBoot-Setup">Setup</a></li><li><a shape="rect" href="#SpringBoot-AdditionalConfiguration">Additional Configuration</a></li><li><a shape="rect" href="#SpringBoot-APIDocumentation">API Documentation</a></li><li><a shape="rect" href="#SpringBoot-ServiceRegistryPublication">Service Registry Publication</a></li><li><a shape="rect" href="#SpringBoot-Examples">Examples</a></li></ul>
</li><li><a shape="rect" href="#SpringBoot-SpringBootCXFJAX-RSStarter">Spring Boot CXF JAX-RS Starter</a>
@@ -134,13 +134,13 @@ div.rbtoc1490118477866 li {margin-left:
</li></ul>
</li></ul>
</div><h1 id="SpringBoot-SpringBootCXFJAX-WSStarter">Spring Boot CXF JAX-WS Starter</h1><h2 id="SpringBoot-Features">Features</h2><p>Registers CXFServlet with a  "/services/*" URL pattern for serving CXF JAX-WS endpoints.</p><h2 id="SpringBoot-Setup">Setup</h2><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>JAX-WS Starter</b></div><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><dependency>
+<pre class="brush: xml; gutter: false; theme: Confluence" style="font-size:12px;"><dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-spring-boot-starter-jaxws</artifactId>
- <version>3.1.7</version>
+ <version>3.1.12</version>
</dependency></pre>
</div></div><h2 id="SpringBoot-AdditionalConfiguration">Additional Configuration</h2><p>Use "<strong>cxf.path</strong>" property to customize a CXFServlet URL pattern</p><p>Use "<strong>cxf.servlet.init</strong>" map property to customize CXFServlet properties such as "services-list-path" (available by default at  "/services"), etc.</p><p>If needed, one can use Spring ImportResource annotation to import the existing JAX-WS contexts available on the classpath.</p><h2 id="SpringBoot-APIDocumentation">API Documentation</h2><p>JAX-WS endpoints support WSDL.</p><h2 id="SpringBoot-ServiceRegistryPublication">Service Registry Publication</h2><p>Publication of JAX-WS endpoints into well-known service registries such as Netflix Eureka Registry can be achieved similarly to the way JAX-RS endpoints are registered and is shown in a <a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/spring_boot_scan/application"
rel="nofollow">JAX-RS Spring Boot Scan</a> demo.</p><h2 id="SpringBoot-Examples">Examples</h2><p>Consider the following Configuration instance:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>JAX-WS Configuration</b></div><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">package sample.ws;
+<pre class="brush: java; gutter: false; theme: Confluence" style="font-size:12px;">package sample.ws;
import javax.xml.ws.Endpoint;
import org.apache.cxf.Bus;
@@ -164,13 +164,13 @@ public class WebServiceConfig {
}
}</pre>
</div></div><p> </p><p>Having a CXF JAX-WS starter alongside this Configuration is sufficient for enabling a CXF JAX-WS endpoint which will respond to SOAP request URI such as</p><p>"http://localhost:8080/services/Hello".</p><p>Please also see a <a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jaxws_spring_boot" rel="nofollow">JAX-WS Spring Boot</a> demo.</p><h1 id="SpringBoot-SpringBootCXFJAX-RSStarter">Spring Boot CXF JAX-RS Starter</h1><h2 id="SpringBoot-Features.1">Features</h2><p>Registers CXF Servlet with a  "/services/*" URL pattern for serving CXF JAX-RS endpoints.</p><p>Optionally auto-discovers JAX-RS root resources and providers and creates a JAX-RS endpoint.</p><p>Note the use of CXF JAX-RS Clients in SpringBoot Application is covered in <a shape="rect" href="jaxrsclientspringboot.html">this section</a>.</p><h2 id="SpringBoot-Setup.1">Setup</h2><div class="code panel pdl" style="bor
der-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>JAX-RS Starter</b></div><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><dependency>
+<pre class="brush: xml; gutter: false; theme: Confluence" style="font-size:12px;"><dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-spring-boot-starter-jaxrs</artifactId>
- <version>3.1.7</version>
+ <version>3.1.12</version>
</dependency></pre>
</div></div><h2 id="SpringBoot-AdditionalConfiguration.1">Additional Configuration</h2><p>Use "<strong>cxf.path</strong>" property to customize a CXFServlet URL pattern.</p><p>Use "<strong>cxf.servlet.init</strong>" map property to customize CXFServlet properties such as "services-list-path" (available by default at  "/services"), etc.</p><p>Use "<strong>cxf.jaxrs.server.path</strong>" property to customize a JAX-RS server endpoint address (default is "/").</p><p>JAX-RS root resources and providers annotated with JAX-RS @Path and @Provider and native CXF Providers annotated with CXF <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/cxf-3.1.6/core/src/main/java/org/apache/cxf/annotations/Provider.java" rel="nofollow">@Provider</a> can be auto-discovered.</p><p>Use "<strong>cxf.jaxrs.component-scan</strong>" property to create a JAX-RS endpoint from the auto-discovered JAX-RS root resources and providers which are marked as Spring Components (ann
otated with Spring @Component or created and returned from @Bean methods).</p><p>Use "<strong>cxf.jaxrs.component-scan</strong>-<strong>packages</strong>" property to restrict which of the auto-discovered Spring components are accepted as JAX-RS resource or provider classes. It sets a comma-separated list of the packages that a given bean instance's class must be in. Note, this property, if set, is only effective if a given bean is a singleton. It can be used alongside or as an alternative to the "<strong>cxf.jaxrs.component-scan</strong>-<strong>beans</strong>" property. This property is available starting from CXF 3.1.11.</p><p>Use "<strong>cxf.jaxrs.component-scan</strong>-<strong>beans</strong>" property to restrict which of the auto-discovered Spring components are accepted as JAX-RS resource or provider classes. It sets a comma-separated list of the accepted bean names - the auto-discovered component will only be accepted if its bean name is in this list. It can be used alongs
ide or as an alternative to the "<strong>cxf.jaxrs.component-scan</strong>-<strong>packages</strong>" property. This property is available starting from CXF 3.1.11.</p><p>Use "<strong>cxf.jaxrs.classes-scan</strong>" property to create a JAX-RS endpoint from the auto-discovered JAX-RS root resources and provider classes. Such classes do not have to be annotated with Spring @Component. This property needs to be accompanied by a "<strong>cxf.jaxrs.classes-scan-packages</strong>" property which sets a comma-separated list of the packages to scan.</p><p>Note that while "<strong>cxf.jaxrs.component-scan</strong>" and "<strong>cxf.jaxrs.classes-scan</strong>" are mutually exclusive, "<strong>cxf.jaxrs.component-scan</strong>" can be used alongside the "<strong>cxf.jaxrs.classes-scan-packages</strong>" property to enable the auto-discovery of the JAX-RS resources and providers which may or may not be marked as Spring Components.</p><p>If needed, instead of having the resources auto-di
scovered,  one can use Spring ImportResource annotation to import the existing JAX-RS contexts available on the classpath.</p><h2 id="SpringBoot-APIDocumentation.1">API Documentation</h2><h3 id="SpringBoot-Swagger">Swagger</h3><p>See CXF <a shape="rect" href="swagger2feature.html#SwaggerFeature/Swagger2Feature-EnablinginSpringBoot" rel="nofollow">Swagger2Feature documentation</a> on how to enable Swagger2Feature in SpringBoot and how to auto-activate Swagger UI.</p><h3 id="SpringBoot-WADL">WADL</h3><p>CXF automatically loads a WADL provider if a <strong>cxf-rt-rs-service-description</strong> module is available on the runtime classpath.</p><h2 id="SpringBoot-ServiceRegistryPublication.1">Service Registry Publication</h2><p>Publication of JAX-RS endpoints into well-known service registries such as Netflix Eureka Registry is shown in a <a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/spring_boot_sca
n/application" rel="nofollow">JAX-RS Spring Boot Scan</a> demo.</p><h2 id="SpringBoot-Examples.1">Examples</h2><h3 id="SpringBoot-ManualConfiguration">Manual Configuration</h3><p>Consider the following Configuration instance:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>JAX-RS Configuration</b></div><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">package sample.rs.service;
+<pre class="brush: java; gutter: false; theme: Confluence" style="font-size:12px;">package sample.rs.service;
import java.util.Arrays;
import org.apache.cxf.Bus;
@@ -206,12 +206,12 @@ public class SampleRestApplication {
}
}</pre>
</div></div><p> </p><p>Having a CXF JAX-RS starter alongside this Configuration is sufficient for enabling a CXF JAX-RS endpoint which will respond to HTTP request URI such as</p><p>"<a shape="rect" class="external-link" href="http://localhost:8080/services/Hello" rel="nofollow">http://localhost:8080/services/sayHello/ApacheCxfUser</a>". The above code also makes Swagger docs available at "<a shape="rect" class="external-link" href="http://localhost:8080/services/Hello" rel="nofollow">http://localhost:8080/services/swagger.json</a>".</p><p>Please also see a <a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/spring_boot" rel="nofollow">JAX-RS Spring Boot</a> demo.</p><p> </p><h3 id="SpringBoot-AutoConfiguration">Auto Configuration</h3><p>Spring Boot Application example shown in the Manual Configuration section can be simplified if the auto-discovery is enabled.</p><p>For example, given the
following application.yml properties:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Application Properties</b></div><div class="codeContent panelContent pdl">
-<pre class="brush: text; gutter: false; theme: Default" style="font-size:12px;"> cxf:
+<pre class="brush: text; gutter: false; theme: Confluence" style="font-size:12px;"> cxf:
jaxrs:
component-scan: true
classes-scan-packages: org.apache.cxf.jaxrs.swagger</pre>
</div></div><p> </p><p>the application becomes simply:</p><p> </p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>JAX-RS Auto Configuration</b></div><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">package sample.rs.service;
+<pre class="brush: java; gutter: false; theme: Confluence" style="font-size:12px;">package sample.rs.service;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;