Author: buildbot
Date: Mon Oct 27 23:42:52 2025
New Revision: 1091418
Log:
Production update by buildbot for cxf
Modified:
websites/production/cxf/content/cache/docs.pageCache
websites/production/cxf/content/docs/jax-rs-client-api.html
Modified: websites/production/cxf/content/cache/docs.pageCache
==============================================================================
Binary file (source and/or target). No diff available.
Modified: websites/production/cxf/content/docs/jax-rs-client-api.html
==============================================================================
--- websites/production/cxf/content/docs/jax-rs-client-api.html Mon Oct 27
18:18:17 2025 (r1091417)
+++ websites/production/cxf/content/docs/jax-rs-client-api.html Mon Oct 27
23:42:52 2025 (r1091418)
@@ -112,11 +112,11 @@ Apache CXF -- JAX-RS Client API
<br clear="none"></p><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1701142970992 {padding: 0px;}
-div.rbtoc1701142970992 ul {margin-left: 0px;}
-div.rbtoc1701142970992 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1761608568337 {padding: 0px;}
+div.rbtoc1761608568337 ul {margin-left: 0px;}
+div.rbtoc1761608568337 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1701142970992">
+/*]]>*/</style></p><div class="toc-macro rbtoc1761608568337">
<ul class="toc-indentation"><li><a shape="rect"
href="#JAXRSClientAPI-MavenDependency">Maven Dependency</a></li><li><a
shape="rect" href="#JAXRSClientAPI-JAX-RS2.0ClientAPI">JAX-RS 2.0 Client API</a>
<ul class="toc-indentation"><li><a shape="rect"
href="#JAXRSClientAPI-JAX-RS2.0andCXFspecificAPI">JAX-RS 2.0 and CXF specific
API</a></li></ul>
</li><li><a shape="rect" href="#JAXRSClientAPI-Proxy-basedAPI">Proxy-based
API</a>
@@ -149,7 +149,40 @@ Response response = builder.get();
Book book = builder.get(Book.class);
</pre>
-</div></div><p>The above sequence can be easily collapsed into a single code
sequence if preferred.<br clear="none">Note that SyncInvoker (and AsyncInvoker)
expects <a shape="rect" class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/javax/ws/rs/client/Entity.html";
rel="nofollow">Entity</a> to represent the request
body.</p><p>Invocation.Builder has a shortcut to <a shape="rect"
class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/javax/ws/rs/client/Invocation.html";
rel="nofollow">Invocation</a> via its build(...) methods to further customize
the invocation.</p><p>Invocation.Builder.async() links to
AsyncInvoker.</p><p>Client and WebTarget are all can be individually
configured, the implement <a shape="rect" class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/javax/ws/rs/core/Configurable.html";
rel="nofollow">Configurable</a> interface which can accept the providers and
properties and return <a shap
e="rect" class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/javax/ws/rs/core/Configuration.html";
rel="nofollow">Configuration</a>. Configuring the Client directly or
indirectly via ClientBuilder.withConfig method affects all the WebClients
spawned by a given Client.</p><h2
id="JAXRSClientAPI-JAX-RS2.0andCXFspecificAPI">JAX-RS 2.0 and CXF specific
API</h2><p>CXF proxy and WebClient client code has been retrofitted to support
JAX-RS 2.0 client filters, reader and writer interceptors, new exception
classes and Response API.</p><p>WebClient offers shortcuts to JAX-RS 2.0 <a
shape="rect" class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/javax/ws/rs/client/AsyncInvoker.html";
rel="nofollow">AsyncInvoker</a> and <a shape="rect" class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/javax/ws/rs/client/SyncInvoker.html";
rel="nofollow">SyncInvoker</a> interfaces.</p><p>WebClient.getConfig(Object
client) supp
orts JAX-RS 2.0 <a shape="rect" class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/javax/ws/rs/client/WebTarget.html";
rel="nofollow">WebTarget</a> and <a shape="rect" class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/javax/ws/rs/client/Invocation.Builder.html";
rel="nofollow">Invocation.Builder</a> for 2.0 clients to be able to get to the
lower-level CXF configuration and set up the properties such as
'receiveTimeout', etc.</p><h1 id="JAXRSClientAPI-Proxy-basedAPI">Proxy-based
API</h1><p>With the proxy-based API, one can reuse on the client side the
interfaces or even the resource classes which have already been designed for
processing the HTTP requests on the server side (note that a <a shape="rect"
class="external-link" href="http://cglib.sourceforge.net/";
rel="nofollow">cglib</a>-nodeps dependency will need to be available on the
classpath for proxies created from concrete classes). When reused on the client
side, they s
imply act as remote proxies.</p><p><a shape="rect" class="external-link"
href="http://svn.apache.org/repos/asf/cxf/trunk/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/client/JAXRSClientFactory.java";>JAXRSClientFactory</a>
is a utility class which wraps <a shape="rect" class="external-link"
href="http://svn.apache.org/repos/asf/cxf/trunk/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/client/JAXRSClientFactoryBean.java";>JAXRSClientFactoryBean</a>.
JAXRSClientFactory offers a number of utility methods but
JAXRSClientFactoryBean can also be used directly if desired.</p><p>For example,
given these class definitions:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>The above sequence can be easily collapsed into a single code
sequence if preferred.<br clear="none">Note that SyncInvoker (and AsyncInvoker)
expects <a shape="rect" class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/javax/ws/rs/client/Entity.html";
rel="nofollow">Entity</a> to represent the request
body.</p><p>Invocation.Builder has a shortcut to <a shape="rect"
class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/javax/ws/rs/client/Invocation.html";
rel="nofollow">Invocation</a> via its build(...) methods to further customize
the invocation.</p><p>Invocation.Builder.async() links to
AsyncInvoker.</p><p>Client and WebTarget are all can be individually
configured, the implement <a shape="rect" class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/javax/ws/rs/core/Configurable.html";
rel="nofollow">Configurable</a> interface which can accept the providers and
properties and return <a shap
e="rect" class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/javax/ws/rs/core/Configuration.html";
rel="nofollow">Configuration</a>. Configuring the Client directly or
indirectly via ClientBuilder.withConfig method affects all the WebClients
spawned by a given Client.</p><h2
id="JAXRSClientAPI-JAX-RS2.0andCXFspecificAPI">JAX-RS 2.0 and CXF specific
API</h2><p>CXF proxy and WebClient client code has been retrofitted to support
JAX-RS 2.0 client filters, reader and writer interceptors, new exception
classes and Response API.</p><p>WebClient offers shortcuts to JAX-RS 2.0 <a
shape="rect" class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/javax/ws/rs/client/AsyncInvoker.html";
rel="nofollow">AsyncInvoker</a> and <a shape="rect" class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/javax/ws/rs/client/SyncInvoker.html";
rel="nofollow">SyncInvoker</a> interfaces.</p><p>WebClient.getConfig(Object
client) supp
orts JAX-RS 2.0 <a shape="rect" class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/javax/ws/rs/client/WebTarget.html";
rel="nofollow">WebTarget</a> and <a shape="rect" class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/javax/ws/rs/client/Invocation.Builder.html";
rel="nofollow">Invocation.Builder</a> for 2.0 clients to be able to get to the
lower-level CXF configuration and set up the properties such as
'receiveTimeout', etc.</p><h1 id="JAXRSClientAPI-Proxy-basedAPI">Proxy-based
API</h1><p>With the proxy-based API, one can reuse on the client side the
interfaces or even the resource classes which have already been designed for
processing the HTTP requests on the server side (note that a <a shape="rect"
class="external-link" href="http://cglib.sourceforge.net/";
rel="nofollow">cglib</a>-nodeps dependency will need to be available on the
classpath for proxies created from concrete classes, or spring-core for 4.1.0+
releases, see
please <style>
+ .jira-issue {
+ padding: 0 0 0 2px;
+ line-height: 20px;
+ }
+
+ .jira-issue img {
+ padding-right: 5px;
+ }
+
+ .jira-issue .aui-lozenge {
+ line-height: 18px;
+ vertical-align: top;
+ }
+
+ .jira-issue .icon {
+ background-position: left center;
+ background-repeat: no-repeat;
+ display: inline-block;
+ font-size: 0;
+ max-height: 16px;
+ text-align: left;
+ text-indent: -9999em;
+ vertical-align: text-bottom;
+ }
+</style>
+
+<span class="jira-issue" data-jira-key="CXF-8993"
data-client-id="SINGLE_5aa69414-a9e9-3523-82ec-879b028fb15b_24190809_8aa980874e36a1eb014e36a2cf2911a3">
+ <a shape="rect" class="jira-issue-key"
href="https://issues.apache.org/jira/browse/CXF-8993";><span class="aui-icon
aui-icon-wait issue-placeholder"></span>CXF-8993</a>
+ -
+ <span class="summary">Getting issue details...</span>
+ <span class="aui-lozenge
aui-lozenge-subtle aui-lozenge-default issue-placeholder">STATUS</span>
+ </span>
+). When reused on the client side, they simply act as remote proxies.</p><p><a
shape="rect" class="external-link"
href="http://svn.apache.org/repos/asf/cxf/trunk/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/client/JAXRSClientFactory.java";>JAXRSClientFactory</a>
is a utility class which wraps <a shape="rect" class="external-link"
href="http://svn.apache.org/repos/asf/cxf/trunk/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/client/JAXRSClientFactoryBean.java";>JAXRSClientFactoryBean</a>.
JAXRSClientFactory offers a number of utility methods but
JAXRSClientFactoryBean can also be used directly if desired.</p><p>For example,
given these class definitions:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="brush: java; gutter: false; theme: Default">@Path("/bookstore")
public interface BookStore {
@GET
@@ -413,7 +446,7 @@ webClient.header("Authorization", author
WebClient client = WebClient.create("http://books";, "username", "password",
"classpath:/config/https.xml");
</pre>
-</div></div><p>When injecting clients from Spring, one can add 'username' and
'password' values as attributes to jaxrs:client elements or add them to
WebClient factory create methods.</p><h1
id="JAXRSClientAPI-ClientsinSpringBoot">Clients in Spring Boot</h1><p>Please
see <a shape="rect"
href="jaxrsclientspringboot.html">JAXRSClientSpringBoot</a> documentation on
how CXF <span class="confluence-link">JAX-RS Clients</span> can be used in a
SpringBoot Application.</p><h1 id="JAXRSClientAPI-ClientsandHTTP(s)">Clients
and HTTP(s) </h1><p>The default <strong>HttpClientHTTPConduit</strong> conduit
by default supports the following HTTPS protocols: <strong>TLSv1, TLSv1.1,
TLSv1.2, TLSv1.3. </strong>Since Apache CXF 4.0.4 / 3.6.3 release, the default
<strong>HttpClientHTTPConduit</strong> respects
<strong>https.protocols</strong> system property (see please <a shape="rect"
class="external-link"
href="https://blogs.oracle.com/java/post/diagnosing-tls-ssl-and-https";
rel="nofollow">https:/
/blogs.oracle.com/java/post/diagnosing-tls-ssl-and-https</a>) and if set,
would use the provided protocols. This behavior could be turned off by setting
<strong>https.protocols.ignored</strong> system property to <strong>"true"
</strong>(the default value is <strong>"false"</strong>).</p><p><br
clear="none"></p></div>
+</div></div><p>When injecting clients from Spring, one can add 'username' and
'password' values as attributes to jaxrs:client elements or add them to
WebClient factory create methods.</p><h1
id="JAXRSClientAPI-ClientsinSpringBoot">Clients in Spring Boot</h1><p>Please
see <a shape="rect"
href="jaxrsclientspringboot.html">JAXRSClientSpringBoot</a> documentation on
how CXF <span class="confluence-link">JAX-RS Clients</span> can be used in a
SpringBoot Application.</p><h1 id="JAXRSClientAPI-ClientsandHTTP(s)">Clients
and HTTP(s)</h1><p>The default <strong>HttpClientHTTPConduit</strong> conduit
by default supports the following HTTPS protocols: <strong>TLSv1, TLSv1.1,
TLSv1.2, TLSv1.3. </strong>Since Apache CXF 4.0.4 / 3.6.3 release, the default
<strong>HttpClientHTTPConduit</strong> respects
<strong>https.protocols</strong> system property (see please <a shape="rect"
class="external-link"
href="https://blogs.oracle.com/java/post/diagnosing-tls-ssl-and-https";
rel="nofollow">https://
blogs.oracle.com/java/post/diagnosing-tls-ssl-and-https</a>) and if set, would
use the provided protocols. This behavior could be turned off by setting
<strong>https.protocols.ignored</strong> system property to <strong>"true"
</strong>(the default value is <strong>"false"</strong>).</p><p><br
clear="none"></p></div>
</div>
<!-- Content -->
</td>
