You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by bu...@apache.org on 2016/07/30 13:47:34 UTC
svn commit: r994108 - in /websites/production/cxf/content:
cache/docs.pageCache docs/jaxrsclientspringboot.html docs/springboot.html
Author: buildbot
Date: Sat Jul 30 13:47:34 2016
New Revision: 994108
Log:
Production update by buildbot for cxf
Modified:
websites/production/cxf/content/cache/docs.pageCache
websites/production/cxf/content/docs/jaxrsclientspringboot.html
websites/production/cxf/content/docs/springboot.html
Modified: websites/production/cxf/content/cache/docs.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/cxf/content/docs/jaxrsclientspringboot.html
==============================================================================
--- websites/production/cxf/content/docs/jaxrsclientspringboot.html (original)
+++ websites/production/cxf/content/docs/jaxrsclientspringboot.html Sat Jul 30 13:47:34 2016
@@ -118,12 +118,12 @@ Apache CXF -- JAXRSClientSpringBoot
<!-- Content -->
<div class="wiki-content">
<div id="ConfluenceContent"><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1468568831020 {padding: 0px;}
-div.rbtoc1468568831020 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1468568831020 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1469886420797 {padding: 0px;}
+div.rbtoc1469886420797 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1469886420797 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1468568831020">
-<ul class="toc-indentation"><li><a shape="rect" href="#JAXRSClientSpringBoot-Introduction">Introduction</a></li><li><a shape="rect" href="#JAXRSClientSpringBoot-Setup">Setup</a></li><li><a shape="rect" href="#JAXRSClientSpringBoot-EnablingWebClients">Enabling WebClients</a></li><li><a shape="rect" href="#JAXRSClientSpringBoot-EnablingProxyClients">Enabling ProxyClients</a></li><li><a shape="rect" href="#JAXRSClientSpringBoot-Configuration">Configuration</a></li></ul>
+/*]]>*/</style></p><div class="toc-macro rbtoc1469886420797">
+<ul class="toc-indentation"><li><a shape="rect" href="#JAXRSClientSpringBoot-Introduction">Introduction</a></li><li><a shape="rect" href="#JAXRSClientSpringBoot-Setup">Setup</a></li><li><a shape="rect" href="#JAXRSClientSpringBoot-EnablingWebClients">Enabling WebClients</a></li><li><a shape="rect" href="#JAXRSClientSpringBoot-EnablingProxyClients">Enabling ProxyClients</a></li><li><a shape="rect" href="#JAXRSClientSpringBoot-DiscoveryofServiceEndpoints">Discovery of Service Endpoints</a></li><li><a shape="rect" href="#JAXRSClientSpringBoot-Configuration">Configuration</a></li></ul>
</div><h1 id="JAXRSClientSpringBoot-Introduction">Introduction</h1><p>This page describes how <a shape="rect" href="jax-rs-client-api.html">CXF JAX-RS Client</a> code can be used inside SpringBoot applications.</p><p>Please see a <a shape="rect" href="http://cxf.apache.org/docs/springboot.html#SpringBoot-SpringBootCXFJAX-RSStarter">CXF JAX-RS starter</a> section on how to enable JAX-RS endpoints.</p><h1 id="JAXRSClientSpringBoot-Setup">Setup</h1><p>If your SpringBoot Application depends on a <a shape="rect" href="http://cxf.apache.org/docs/springboot.html#SpringBoot-SpringBootCXFJAX-RSStarter">CXF JAX-RS starter</a> then no more dependencies are required.</p><p>If you'd like to run JAX-RS clients in a pure client-side SpringBoot Application then the following Maven pom should suffice in many cases:</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;"><?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
@@ -269,7 +269,7 @@ public class SpringBootClientApplication
}
}
}</pre>
-</div></div><p> </p><h1 id="JAXRSClientSpringBoot-Configuration">Configuration</h1><p>The configuration properties apply to both WebClient and Proxy configurations.</p><p><strong>cxf.jaxrs.client.address</strong> is a required property which identifies a target address.</p><p><strong>cxf.jaxrs.client.thread-safe</strong> property can be set to true to make the clients thread-safe.</p><p><strong>cxf.jaxrs.client.headers.accept</strong> property can be used to set HTTP Accept header.</p><p><strong>cxf.jaxrs.client.headers.content-type</strong> property can be used to set HTTP Content-Type header.</p><p><strong>cxf.jaxrs.client.classes-scan-packages</strong> property can be used to auto-discover JAX-RS service class interfaces (for proxies) and providers for proxies and web clients.</p></div>
+</div></div><h1 id="JAXRSClientSpringBoot-DiscoveryofServiceEndpoints">Discovery of Service Endpoints</h1><p>Discovery of JAX-RS endpoint addresses published to a 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_scan/application" rel="nofollow">JAX-RS Spring Boot Scan</a> demo.</p><p>This is achieved with the help of CXF Failover and/or LoadBalancing features.</p><h1 id="JAXRSClientSpringBoot-Configuration">Configuration</h1><p>The configuration properties apply to both WebClient and Proxy configurations.</p><p><strong>cxf.jaxrs.client.address</strong> is a required property which identifies a target address.</p><p><strong>cxf.jaxrs.client.thread-safe</strong> property can be set to true to make the clients thread-safe.</p><p><strong>cxf.jaxrs.client.headers.accept</strong> property can be used to set HTTP Accept he
ader.</p><p><strong>cxf.jaxrs.client.headers.content-type</strong> property can be used to set HTTP Content-Type header.</p><p><strong>cxf.jaxrs.client.classes-scan-packages</strong> property can be used to auto-discover JAX-RS service class interfaces (for proxies) and providers for proxies and web clients.</p></div>
</div>
<!-- Content -->
</td>
Modified: websites/production/cxf/content/docs/springboot.html
==============================================================================
--- websites/production/cxf/content/docs/springboot.html (original)
+++ websites/production/cxf/content/docs/springboot.html Sat Jul 30 13:47:34 2016
@@ -119,15 +119,17 @@ Apache CXF -- SpringBoot
<!-- Content -->
<div class="wiki-content">
<div id="ConfluenceContent"><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1469882826614 {padding: 0px;}
-div.rbtoc1469882826614 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1469882826614 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1469886419802 {padding: 0px;}
+div.rbtoc1469886419802 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1469886419802 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1469882826614">
+/*]]>*/</style></p><div class="toc-macro rbtoc1469886419802">
<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>
-<ul class="toc-indentation"><li><a shape="rect" href="#SpringBoot-Features.1">Features</a></li><li><a shape="rect" href="#SpringBoot-Setup.1">Setup</a></li><li><a shape="rect" href="#SpringBoot-AdditionalConfiguration.1">Additional Configuration</a></li><li><a shape="rect" href="#SpringBoot-APIDocumentation.1">API Documentation</a></li><li><a shape="rect" href="#SpringBoot-Swagger">Swagger</a></li><li><a shape="rect" href="#SpringBoot-WADL">WADL</a></li><li><a shape="rect" href="#SpringBoot-ServiceRegistryPublication.1">Service Registry Publication</a></li><li><a shape="rect" href="#SpringBoot-Examples.1">Examples</a>
+<ul class="toc-indentation"><li><a shape="rect" href="#SpringBoot-Features.1">Features</a></li><li><a shape="rect" href="#SpringBoot-Setup.1">Setup</a></li><li><a shape="rect" href="#SpringBoot-AdditionalConfiguration.1">Additional Configuration</a></li><li><a shape="rect" href="#SpringBoot-APIDocumentation.1">API Documentation</a>
+<ul class="toc-indentation"><li><a shape="rect" href="#SpringBoot-Swagger">Swagger</a></li><li><a shape="rect" href="#SpringBoot-WADL">WADL</a></li></ul>
+</li><li><a shape="rect" href="#SpringBoot-ServiceRegistryPublication.1">Service Registry Publication</a></li><li><a shape="rect" href="#SpringBoot-Examples.1">Examples</a>
<ul class="toc-indentation"><li><a shape="rect" href="#SpringBoot-ManualConfiguration">Manual Configuration</a></li><li><a shape="rect" href="#SpringBoot-AutoConfiguration">Auto Configuration</a></li></ul>
</li></ul>
</li></ul>
@@ -167,7 +169,7 @@ public class WebServiceConfig {
<artifactId>cxf-spring-boot-starter-jaxrs</artifactId>
<version>3.1.7</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>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 (annotated with Spring @Component or created and returned from @Bean methods).</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 @Compo
nent. 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><h2 id="SpringBoot-APIDocumentation.1">API Documentation</h2><h2 id="SpringBoot-Swagger">Swagger</h2><p>See CXF <a shape="rect" href="swaggerfeature-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><h2 id="SpringBoot-WADL">WADL</h2><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_scan/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">
+</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>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 (annotated with Spring @Component or created and returned from @Bean methods).</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 @Compo
nent. 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><h2 id="SpringBoot-APIDocumentation.1">API Documentation</h2><h3 id="SpringBoot-Swagger">Swagger</h3><p>See CXF <a shape="rect" href="swaggerfeature-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_scan/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;
import java.util.Arrays;