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/12 19:09:50 UTC
svn commit: r1018074 [25/31] - in /websites/production/cxf/content: ./
2008/04/28/ 2008/06/20/ 2008/10/23/ 2009/02/10/ 2009/08/04/ cache/ docs/
Modified: websites/production/cxf/content/docs/using-cxf-and-cdi-1112-jsr-346-in-osgi-environment.html
==============================================================================
--- websites/production/cxf/content/docs/using-cxf-and-cdi-1112-jsr-346-in-osgi-environment.html (original)
+++ websites/production/cxf/content/docs/using-cxf-and-cdi-1112-jsr-346-in-osgi-environment.html Tue Sep 12 19:09:41 2017
@@ -124,7 +124,7 @@ Apache CXF -- Using CXF and CDI 1.1/1.2
<pre>feature:repo-add cxf 3.1.0
feature:install cxf/3.1.0 cxf-jaxrs-cdi/3.1.0</pre>
</div></div><h1 id="UsingCXFandCDI1.1/1.2(JSR-346)inOSGienvironment-BundleMetadata">Bundle Metadata</h1><p>In order for the bundle to be recognized as web CDI one and use Apache CXF CDI capabilities, it should provide special bundle manifest instructions (f.e. by  using <strong>maven-bundle-plugin</strong> plugin).</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;"></instructions>
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"></instructions>
...
<Import-Package>
javax.servlet;version="[2.6,4)",
@@ -141,7 +141,7 @@ feature:install cxf/3.1.0 cxf-jaxrs-cdi/
<_wab>src/main/webapp</_wab>
</instructions></pre>
</div></div><p>The <strong>Require-Capability</strong> instruction is very important in order for CDI initialization, discovery and injections to work with Apache CXF. The <strong>Web-ContextPath</strong> is the context path for this web application to be deployed at. And <strong>_wab</strong> is the instruction  to point out the <strong>web.xml</strong> file location. Please notice, the application will not be deployed under usual<strong> /cxf</strong> endpoint (common endpoint for regular Apache CXF services). The reason for that is that Pax Web is used for deployment of web CDI applications.</p><h1 id="UsingCXFandCDI1.1/1.2(JSR-346)inOSGienvironment-WebApplicationConfiguration">Web Application Configuration</h1><p>At the moment, Apache CXF OSGi application should explicitly provide <strong>web.xml</strong> descriptor with at least <strong>CXFCdiServlet </strong>defined. For example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelConten
t pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<servlet>
Modified: websites/production/cxf/content/docs/using-cxf-and-failover-in-osgi-environment.html
==============================================================================
--- websites/production/cxf/content/docs/using-cxf-and-failover-in-osgi-environment.html (original)
+++ websites/production/cxf/content/docs/using-cxf-and-failover-in-osgi-environment.html Tue Sep 12 19:09:41 2017
@@ -131,7 +131,7 @@ install -s mvn:org.qi4j.core/org.qi4j.co
install -s mvn:org.qi4j.library/org.qi4j.library.jmx/2.1
install -s mvn:org.qi4j.library/org.qi4j.library.circuitbreaker/2.1</pre>
</div></div><h1 id="UsingCXFandFailoverinOSGienvironment-BlueprintConfiguration">Blueprint Configuration</h1><p>Once all prerequisites are installed, the configuration becomes really trivial, for example here is the OSGi blueprint snippet which registers <a shape="rect" href="failoverfeature.html">JAX-WS</a>  failover-aware client. Although it uses <strong>circuit-breaker-failover</strong>, the way to register regular <strong>failover</strong> and <strong>loadDistribution </strong>features is very similar.</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;"><blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:jaxws="http://cxf.apache.org/blueprint/jaxws"
xmlns:clustering="http://cxf.apache.org/clustering"
Modified: websites/production/cxf/content/docs/using-cxf-jca-rar-in-application-server.html
==============================================================================
--- websites/production/cxf/content/docs/using-cxf-jca-rar-in-application-server.html (original)
+++ websites/production/cxf/content/docs/using-cxf-jca-rar-in-application-server.html Tue Sep 12 19:09:41 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();
@@ -121,11 +121,11 @@ Apache CXF -- Using CXF-JCA RAR in Appli
<p>cxf-integration-jca module has implemented the JCA1.5 outbound connection. You can see samples in $CXF_HOME/samples/integration/jca.</p>
<style type="text/css">/*<![CDATA[*/
-div.rbtoc1435780118028 {padding: 0px;}
-div.rbtoc1435780118028 ul {list-style: disc;margin-left: 0px;padding-left: 20px;}
-div.rbtoc1435780118028 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1505242909137 {padding: 0px;}
+div.rbtoc1505242909137 ul {list-style: disc;margin-left: 0px;padding-left: 20px;}
+div.rbtoc1505242909137 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style><div class="toc-macro rbtoc1435780118028">
+/*]]>*/</style><div class="toc-macro rbtoc1505242909137">
<ul class="toc-indentation"><li><a shape="rect" href="#UsingCXF-JCARARinApplicationServer-DeployCXF-JCARAR.">Deploy CXF-JCA RAR.</a>
<ul class="toc-indentation"><li><a shape="rect" href="#UsingCXF-JCARARinApplicationServer-BuildCXF-JCARAR">Build CXF-JCA RAR</a></li><li><a shape="rect" href="#UsingCXF-JCARARinApplicationServer-DeployRARtoJBOSS.">Deploy RAR to JBOSS.</a>
<ul class="toc-indentation"><li><a shape="rect" href="#UsingCXF-JCARARinApplicationServer-DeploythestandaloneRAR.">Deploy the standalone RAR.</a></li><li><a shape="rect" href="#UsingCXF-JCARARinApplicationServer-DeploytheRARinEAR.">Deploy the RAR in EAR.</a></li></ul>
@@ -161,7 +161,7 @@ div.rbtoc1435780118028 li {margin-left:
<ul><li>geronimo-activation_1.1_spec-1.0-M1.jar</li><li>geronimo-annotation_1.0_spec-1.1.jar</li><li>geronimo-ws-metadata_2.0_spec-1.1.1.jar</li><li>jaxb-api-2.1.jar</li><li>jaxb-impl-2.1.4.jar</li><li>jaxb-xjc-2.1.4.jar</li><li>jsr181-api-1.0-MR1.jar</li><li>saaj-api-1.3.jar</li><li>saaj-impl-1.3.jar</li><li>stax-api-1.0.1.jar</li><li>stax-utils-20060502.jar</li></ul>
</li><li>Copy the rar to the $JBOSS_HOME/server/default</li><li>Create the cxfj2ee_1_5-ds.xml as below, and copy it to $JBOSS_HOME/server/default
<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;">
<!DOCTYPE connection-factories
PUBLIC "-//JBoss//DTD JBOSS JCA Config 1.5//EN"
"http://www.jboss.org/j2ee/dtd/jboss-ds_1_5.dtd">
@@ -182,7 +182,7 @@ div.rbtoc1435780118028 li {margin-left:
<p><strong>(Note: This has been tested against JBoss4.0.5 and JBoss4.2.1)</strong></p>
<ul><li>Having application.xml
<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;">
<?xml version="1.0" encoding="UTF-8"?>
<application>
<display-name>cxf-jca</display-name>
@@ -196,7 +196,7 @@ div.rbtoc1435780118028 li {margin-left:
<ul><li>Having jboss-app.xml to configure the classloader.
<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;">
<?xml version="1.0" encoding="UTF-8"?>
<jboss-app>
<loader-repository>
@@ -215,7 +215,7 @@ div.rbtoc1435780118028 li {margin-left:
<ul><li>Having cxf-ds for jca outbound in JBoss.
<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;">
<?xml version="1.0" encoding="UTF-8"?>
<connection-factories>
<no-tx-connection-factory>
@@ -246,7 +246,7 @@ div.rbtoc1435780118028 li {margin-left:
<h3 id="UsingCXF-JCARARinApplicationServer-PackageRARinanEAR.">Package RAR in an EAR.</h3>
<ul><li>Add a weblogic-ra.xml in the <strong>META-INF</strong> folder.
<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;">
<weblogic-connector xmlns="http://www.bea.com/ns/weblogic/90">
<outbound-resource-adapter>
<connection-definition-group>
@@ -274,7 +274,7 @@ div.rbtoc1435780118028 li {margin-left:
<h2 id="UsingCXF-JCARARinApplicationServer-GetConnectionfromManagedConnectionFactory.">Get Connection from ManagedConnectionFactory.</h2>
<p>Below is the code snippet to get the Connection.</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;">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">
URL wsdl = getClass().getResource("/wsdl/hello_world.wsdl");
CXFConnectionRequestInfo cri = new CXFConnectionRequestInfo(Greeter.class,
@@ -291,7 +291,7 @@ div.rbtoc1435780118028 li {margin-left:
<p>Also can get the connection without wsdl, but you need to provide the address.</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;">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">
CXFConnectionRequestInfo requestInfo = new CXFConnectionRequestInfo();
requestInfo.setInterface(Greeter.class);
@@ -308,7 +308,7 @@ div.rbtoc1435780118028 li {margin-left:
If you want to deploy the Stateless Session Bean, you need to modify the ejb_servant.properties file.</p>
<h3 id="UsingCXF-JCARARinApplicationServer-Activatetheejb_servant.propertiesfile.">Activate the ejb_servant.properties file.</h3>
<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;">
# Format:
# jndi_name={namespace}ServiceName@url_to_swdl
#
Modified: websites/production/cxf/content/docs/using-cxf-with-maven.html
==============================================================================
--- websites/production/cxf/content/docs/using-cxf-with-maven.html (original)
+++ websites/production/cxf/content/docs/using-cxf-with-maven.html Tue Sep 12 19:09:41 2017
@@ -32,8 +32,9 @@
<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/shBrushBash.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();
@@ -118,7 +119,7 @@ Apache CXF -- Using CXF with maven
<!-- Content -->
<div class="wiki-content">
<div id="ConfluenceContent"><h1 id="UsingCXFwithmaven-MavenPOMInformation">Maven POM Information</h1><p>To use CXF within Maven, you'll need to declare the CXF dependencies in your POM. The CXF groupId is "org.apache.cxf". Here is a small 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;"><properties>
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><properties>
<cxf.version>2.2.3</cxf.version>
</properties>
@@ -142,7 +143,7 @@ Apache CXF -- Using CXF with maven
</dependencies>
</pre>
</div></div><p>For information on using Maven with CXF and Tomcat, this <a shape="rect" class="external-link" href="https://web-gmazza.rhcloud.com/blog/entry/web-service-tutorial" rel="nofollow">blog entry</a> may be helpful.</p><h4 id="UsingCXFwithmaven-AdditionalDependencies">Additional Dependencies</h4><p>Depending on your usage of CXF, you may need to bring in additional dependencies--the mvn install process will usually make clear what you are missing. Here's a non-exhaustive list of additional CXF artifacts that may be needed:</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;"><!-- Use dependency blocks for these CXF artifact Ids just as above -->
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><!-- Use dependency blocks for these CXF artifact Ids just as above -->
cxf-rt-core
cxf-rt-frontend-simple
cxf-rt-frontend-jaxws
@@ -155,7 +156,7 @@ cxf-rt-management
cxf-common-utilities
</pre>
</div></div><h4 id="UsingCXFwithmaven-MavenSnapshotRepository">Maven Snapshot Repository</h4><p>To work with the latest non-release versions of CXF (not recommended for production use), <a shape="rect" class="external-link" href="http://www.nabble.com/CXF-snapshot-location-has-changed.-td22460813.html#a22460813" rel="nofollow">updated nightly</a>, change the CXF version to the -SNAPSHOT version desired and add the Apache snapshot repository to both the repositories and pluginRepositories sections:</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;"><repositories>
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><repositories>
...other repos...
<repository>
<id>apache-snapshots</id>
Modified: websites/production/cxf/content/docs/using-opentracing.html
==============================================================================
--- websites/production/cxf/content/docs/using-opentracing.html (original)
+++ websites/production/cxf/content/docs/using-opentracing.html Tue Sep 12 19:09:41 2017
@@ -116,12 +116,12 @@ Apache CXF -- Using OpenTracing
<td height="100%">
<!-- Content -->
<div class="wiki-content">
-<div id="ConfluenceContent"><h1 id="UsingOpenTracing-/*<![CDATA[*/div.rbtoc1505159711790{padding:0px;}div.rbtoc1505159711790ul{list-style:disc;margin-left:0px;}div.rbtoc1505159711790li{margin-left:0px;padding-left:0px;}/*]]>*/#UsingOpenTracing-Overview#UsingOpenTracing-OverviewDistributedTr"><style type="text/css">/*<![CDATA[*/
-div.rbtoc1505159711790 {padding: 0px;}
-div.rbtoc1505159711790 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1505159711790 li {margin-left: 0px;padding-left: 0px;}
+<div id="ConfluenceContent"><h1 id="UsingOpenTracing-/*<![CDATA[*/div.rbtoc1505242973288{padding:0px;}div.rbtoc1505242973288ul{list-style:disc;margin-left:0px;}div.rbtoc1505242973288li{margin-left:0px;padding-left:0px;}/*]]>*/#UsingOpenTracing-Overview#UsingOpenTracing-OverviewDistributedTr"><style type="text/css">/*<![CDATA[*/
+div.rbtoc1505242973288 {padding: 0px;}
+div.rbtoc1505242973288 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1505242973288 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></h1><div class="toc-macro rbtoc1505159711790">
+/*]]>*/</style></h1><div class="toc-macro rbtoc1505242973288">
<ul class="toc-indentation"><li><a shape="rect" href="#UsingOpenTracing-"></a></li><li><a shape="rect" href="#UsingOpenTracing-Overview">Overview</a></li><li><a shape="rect" href="#UsingOpenTracing-DistributedTracinginApacheCXFusingOpenTracing">Distributed Tracing in Apache CXF using OpenTracing</a></li><li><a shape="rect" href="#UsingOpenTracing-ConfiguringClient">Configuring Client</a></li><li><a shape="rect" href="#UsingOpenTracing-ConfiguringServer">Configuring Server</a></li><li><a shape="rect" href="#UsingOpenTracing-DistributedTracingInAction:UsageScenarios">Distributed Tracing In Action: Usage Scenarios</a>
<ul class="toc-indentation"><li><a shape="rect" href="#UsingOpenTracing-Example#1:ClientandServerwithdefaultdistributedtracingconfigured">Example #1: Client and Server with default distributed tracing configured</a></li><li><a shape="rect" href="#UsingOpenTracing-Example#2:ClientandServerwithnestedtrace">Example #2: Client and Server with nested trace</a></li><li><a shape="rect" href="#UsingOpenTracing-Example#3:ClientandServertracewithtimeline">Example #3: Client and Server trace with timeline</a></li><li><a shape="rect" href="#UsingOpenTracing-Example#4:ClientandServerwithbinaryannotations(key/value)">Example #4: Client and Server with binary annotations (key/value)</a></li><li><a shape="rect" href="#UsingOpenTracing-Example#5:ClientandServerwithparalleltrace(involvingthreadpools)">Example #5: Client and Server with parallel trace (involving thread pools)</a></li><li><a shape="rect" href="#UsingOpenTracing-Example#6:ClientandServerwithasynchronousJAX-RSservice(server-side)">Exampl
e #6: Client and Server with asynchronous JAX-RS service (server-side)</a></li><li><a shape="rect" href="#UsingOpenTracing-Example#7:ClientandServerwithasynchronousinvocation(client-side)">Example #7: Client and Server with asynchronous invocation (client-side)</a></li></ul>
</li><li><a shape="rect" href="#UsingOpenTracing-DistributedTracingwithOpenTracingandJAX-WSsupport">Distributed Tracing with OpenTracing and JAX-WS support</a></li></ul>
Modified: websites/production/cxf/content/docs/using-openzipkin-brave.html
==============================================================================
--- websites/production/cxf/content/docs/using-openzipkin-brave.html (original)
+++ websites/production/cxf/content/docs/using-openzipkin-brave.html Tue Sep 12 19:09:41 2017
@@ -32,6 +32,7 @@
<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/shBrushBash.js'></script>
<script src='/resources/highlighter/scripts/shBrushXml.js'></script>
<script src='/resources/highlighter/scripts/shBrushJava.js'></script>
<script>
@@ -118,11 +119,11 @@ Apache CXF -- Using OpenZipkin Brave
<!-- Content -->
<div class="wiki-content">
<div id="ConfluenceContent"><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1505159707814 {padding: 0px;}
-div.rbtoc1505159707814 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1505159707814 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1505243058638 {padding: 0px;}
+div.rbtoc1505243058638 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1505243058638 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1505159707814">
+/*]]>*/</style></p><div class="toc-macro rbtoc1505243058638">
<ul class="toc-indentation"><li><a shape="rect" href="#UsingOpenZipkinBrave-Overview">Overview</a></li><li><a shape="rect" href="#UsingOpenZipkinBrave-DistributedTracinginApacheCXFusingOpenZipkinBrave">Distributed Tracing in Apache CXF using OpenZipkin Brave</a></li><li><a shape="rect" href="#UsingOpenZipkinBrave-configuringclientConfiguringClient">Configuring Client</a></li><li><a shape="rect" href="#UsingOpenZipkinBrave-configuringserverConfiguringServer">Configuring Server</a></li><li><a shape="rect" href="#UsingOpenZipkinBrave-DistributedTracingInAction:UsageScenarios">Distributed Tracing In Action: Usage Scenarios</a>
<ul class="toc-indentation"><li><a shape="rect" href="#UsingOpenZipkinBrave-Example#1:ClientandServerwithdefaultdistributedtracingconfigured">Example #1: Client and Server with default distributed tracing configured</a></li><li><a shape="rect" href="#UsingOpenZipkinBrave-Example#2:ClientandServerwithnestedtrace">Example #2: Client and Server with nested trace</a></li><li><a shape="rect" href="#UsingOpenZipkinBrave-Example#3:ClientandServertracewithannotations">Example #3: Client and Server trace with annotations</a></li><li><a shape="rect" href="#UsingOpenZipkinBrave-Example#4:ClientandServerwithbinaryannotations(key/value)">Example #4: Client and Server with binary annotations (key/value)</a></li><li><a shape="rect" href="#UsingOpenZipkinBrave-Example#5:ClientandServerwithparalleltrace(involvingthreadpools)">Example #5: Client and Server with parallel trace (involving thread pools)</a></li><li><a shape="rect" href="#UsingOpenZipkinBrave-Example#6:ClientandServerwithasynchronousJAX-
RSservice(server-side)">Example #6: Client and Server with asynchronous JAX-RS service (server-side)</a></li><li><a shape="rect" href="#UsingOpenZipkinBrave-Example#7:ClientandServerwithasynchronousinvocation(client-side)">Example #7: Client and Server with asynchronous invocation (client-side)</a></li></ul>
</li><li><a shape="rect" href="#UsingOpenZipkinBrave-DistributedTracingwithOpenZipkinBraveandJAX-WSsupport">Distributed Tracing with OpenZipkin Brave and JAX-WS support</a></li><li><a shape="rect" href="#UsingOpenZipkinBrave-DistributedTracingwithOpenZipkinBraveandOSGi">Distributed Tracing with OpenZipkin Brave and OSGi</a></li><li><a shape="rect" href="#UsingOpenZipkinBrave-Migratingfrombrave-cxf3">Migrating from brave-cxf3</a></li><li><a shape="rect" href="#UsingOpenZipkinBrave-SpringXML-Configuration">Spring XML-Configuration</a></li></ul>
Modified: websites/production/cxf/content/docs/using-the-jmsconfigfeature.html
==============================================================================
--- websites/production/cxf/content/docs/using-the-jmsconfigfeature.html (original)
+++ websites/production/cxf/content/docs/using-the-jmsconfigfeature.html Tue Sep 12 19:09:41 2017
@@ -32,6 +32,7 @@
<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/shBrushBash.js'></script>
<script src='/resources/highlighter/scripts/shBrushJava.js'></script>
<script>
SyntaxHighlighter.defaults['toolbar'] = false;
@@ -117,7 +118,7 @@ Apache CXF -- Using the JMSConfigFeature
<!-- Content -->
<div class="wiki-content">
<div id="ConfluenceContent"><p>Standard JMS transport configuration in CXF is done by defining a JMSConduit or JMSDestination. There is however an easier configuration option more conformant to Spring dependency injection. Additionally the new configuration offers many more options. For example it is not necessary anymore to use JNDI to resolve the connection factory. Instead it can be defined in the Spring configuration.</p><p>The following example configs use the <a shape="rect" class="external-link" href="http://static.springframework.org/spring/docs/2.5.x/reference/beans.html" rel="nofollow">p-namespace</a> from spring 2.5 but the old spring bean style is also possible.</p><p>Inside a features element the JMSConfigFeature can be defined.</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;"><jaxws:client id="CustomerService"
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><jaxws:client id="CustomerService"
xmlns:customer="http://customerservice.example.com/"
serviceName="customer:CustomerServiceService"
endpointName="customer:CustomerServiceEndpoint" address="jms://"
@@ -130,7 +131,7 @@ Apache CXF -- Using the JMSConfigFeature
</jaxws:client>
</pre>
</div></div><p>In the above example it references a bean "jmsConfig" where the whole configuration for the JMS transport can be done.</p><p>A jaxws Endpoint can be defined in the same way:</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;"><jaxws:endpoint
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><jaxws:endpoint
xmlns:customer="http://customerservice.example.com/"
id="CustomerService"
address="jms://"
@@ -144,13 +145,13 @@ Apache CXF -- Using the JMSConfigFeature
</jaxws:endpoint>
</pre>
</div></div><p>The JMSConfiguration bean needs at least a reference to a conncection factory and a target destination.</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;"><bean id="jmsConfig" class="org.apache.cxf.transport.jms.JMSConfiguration"
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><bean id="jmsConfig" class="org.apache.cxf.transport.jms.JMSConfiguration"
p:connectionFactory-ref="jmsConnectionFactory"
p:targetDestination="test.cxf.jmstransport.queue"
/>
</pre>
</div></div><p>If your ConnectionFactory does not cache connections you should wrap it in a spring SingleConnectionFactory. This is necessary because the JMS Transport creates a new connection for each message and the SingleConnectionFactory is needed to cache this connection.</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;"><bean id="jmsConnectionFactory" class="org.springframework.jms.connection.SingleConnectionFactory">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><bean id="jmsConnectionFactory" class="org.springframework.jms.connection.SingleConnectionFactory">
<property name="targetConnectionFactory">
<bean class="org.apache.activemq.ActiveMQConnectionFactory">
<property name="brokerURL" value="tcp://localhost:61616" />
@@ -159,7 +160,7 @@ Apache CXF -- Using the JMSConfigFeature
</bean>
</pre>
</div></div><h2 id="UsingtheJMSConfigFeature-UsingJMSConfigurationfromJava">Using JMSConfiguration from Java</h2><p>To do this from Java, you need to initialize a JMSConfiguration object, then store a reference to it in a JMSConfigFeature, and then add that to the features in the server factory. The code that follows is fragmentary. Note that you can't use query parameters in the endpoint URI that you set in the server factory, all the configuration has to be in the JMSConfiguration object.</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;">public static JMSConfiguration newJMSConfiguration(String taskId, String jmsBrokerUrl) {
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">public static JMSConfiguration newJMSConfiguration(String taskId, String jmsBrokerUrl) {
String destinationUri = "jms:queue:" + taskId;
JMSConfiguration conf = new JMSConfiguration();
conf.setRequestURI(destinationUri);
Modified: websites/production/cxf/content/docs/validationfeature.html
==============================================================================
--- websites/production/cxf/content/docs/validationfeature.html (original)
+++ websites/production/cxf/content/docs/validationfeature.html Tue Sep 12 19:09:41 2017
@@ -32,8 +32,9 @@
<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/shBrushBash.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();
@@ -118,11 +119,11 @@ Apache CXF -- ValidationFeature
<!-- Content -->
<div class="wiki-content">
<div id="ConfluenceContent"><h1 id="ValidationFeature-BeanValidationFeature">Bean Validation Feature</h1><p> </p><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1480373191673 {padding: 0px;}
-div.rbtoc1480373191673 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1480373191673 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1505242912723 {padding: 0px;}
+div.rbtoc1505242912723 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1505242912723 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1480373191673">
+/*]]>*/</style></p><div class="toc-macro rbtoc1505242912723">
<ul class="toc-indentation"><li><a shape="rect" href="#ValidationFeature-BeanValidationFeature">Bean Validation Feature</a></li><li><a shape="rect" href="#ValidationFeature-Introduction">Introduction</a></li><li><a shape="rect" href="#ValidationFeature-Dependencies">Dependencies</a>
<ul class="toc-indentation"><li><a shape="rect" href="#ValidationFeature-UsingHibernateValidatorasbeanvalidationprovider">Using Hibernate Validator as bean validation provider</a></li><li><a shape="rect" href="#ValidationFeature-UsingApacheBValasbeanvalidationprovider">Using Apache BVal as bean validation provider</a></li></ul>
</li><li><a shape="rect" href="#ValidationFeature-CommonBeanValidation1.1Interceptors">Common Bean Validation 1.1 Interceptors</a>
@@ -135,7 +136,7 @@ div.rbtoc1480373191673 li {margin-left:
<ul class="toc-indentation"><li><a shape="rect" href="#ValidationFeature-Validatingsimpleinputparameters">Validating simple input parameters</a></li><li><a shape="rect" href="#ValidationFeature-Validatingcomplexinputparameters">Validating complex input parameters</a></li><li><a shape="rect" href="#ValidationFeature-Validatingreturnvalues(non-Response)">Validating return values (non-Response)</a></li><li><a shape="rect" href="#ValidationFeature-Validatingreturnvalues(Response)">Validating return values (Response)</a></li></ul>
</li><li><a shape="rect" href="#ValidationFeature-BeanValidationandSchemaValidation">Bean Validation and Schema Validation</a></li></ul>
</div><h1 id="ValidationFeature-Introduction">Introduction</h1><p>Bean Validation 1.1 (JSR-349), an evolution of Bean Validation 1.0 (JSR-303), introduces declarative constraints (based on Java annotations) to define the expectations for:</p><ul class="alternate"><li>properties of Java Beans</li><li>method and constructor parameters</li><li>method return values</li></ul><p>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;">public class Person {
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">public class Person {
@NotNull private String firstName;
@NotNull private String lastName;
@Valid @NotNull private Person boss;
@@ -146,7 +147,7 @@ div.rbtoc1480373191673 li {margin-left:
}
</pre>
</div></div><p>Bean Validation API has been part of JPA 2.0 (JSR-317) and has proven to be successful and very useful, helping developers to delegate routine validation tasks to the solid, very extensible framework. It is very easy to create own constraints, including complex cross-field ones.</p><h1 id="ValidationFeature-Dependencies">Dependencies</h1><p>Bean Validation support in Apache CXF is implementation-independent and is built solely using Bean Validation API. The required dependencies are:</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>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>1.1.0.Final</version>
@@ -165,7 +166,7 @@ div.rbtoc1480373191673 li {margin-left:
</dependency>
</pre>
</div></div><p>A couple of API implementations is available. Please note that if no implementation is detected on the runtime class-path then the constraints validation won't have any effect.</p><h2 id="ValidationFeature-UsingHibernateValidatorasbeanvalidationprovider">Using Hibernate Validator as bean validation provider</h2><p><a shape="rect" class="external-link" href="http://www.hibernate.org/subprojects/validator.html" rel="nofollow">http://www.hibernate.org/subprojects/validator.html</a></p><p>Hibernate Validator is a mature and feature-rich validation provider with the full Bean Validation 1.1 support (as of version 5.x.x which is the reference implementation for JSR 349 - Bean Validation 1.1 API). Add the following dependency:</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.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>5.0.2.Final</version>
@@ -179,7 +180,7 @@ div.rbtoc1480373191673 li {margin-left:
</dependency>
</pre>
</div></div><h1 id="ValidationFeature-CommonBeanValidation1.1Interceptors">Common Bean Validation 1.1 Interceptors</h1><p>JAX-RS and JAX-WS frontends can rely on the following common interceptors to get Bean Validation 1.1 done:</p><ul class="alternate"><li><a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/core/src/main/java/org/apache/cxf/validation/BeanValidationInInterceptor.java">org.apache.cxf.validation.BeanValidationInInterceptor</a>: validates resource method parameters against validation constraints, raises javax.validation.ConstraintViolationException if any violations are encountered</li></ul><ul class="alternate"><li><a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/core/src/main/java/org/apache/cxf/validation/BeanValidationOutInterceptor.java">org.apache.cxf.validation.BeanValidationOutInterceptor</a>: validates resource method response values against validation constraints, raises <a shape="rect" c
lass="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/core/src/main/java/org/apache/cxf/validation/ResponseConstraintViolationException">org.apache.cxf.validation.ResponseConstraintViolationException</a> if any violations are encountered.</li></ul><p>Both interceptors depend on <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/core/src/main/java/org/apache/cxf/validation/BeanValidationProvider.java">org.apache.cxf.validation.BeanValidationProvider</a> which abstracts away Bean Validation 1.1 API and provides useful utility methods. This provider can be directly injected into the interceptors as a 'provider' property. Injecting the provider is optional, the interceptors will create a default provider instance if it has not been injected.</p><p>CXF exception handlers can check if a caught javax.validation.ValidationException is an instance of CXF-specific ResponseConstraintViolationException in order to find whether the failure occurr
ed during the return value validation or not.</p><p>The provider can be initialized with javax.validation.ParameterNameProvider or <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/core/src/main/java/org/apache/cxf/validation/ValidationConfiguration.java">ValidationConfiguration</a> in order to customize the way Bean Validation 1.1 implementation does its work.</p><p>Note that interceptors will only be effective if the current service object is a singleton. They will make a best effort of getting hold of a reference to the current service object, which can also be injected directly as a 'serviceObject' property.</p><p>Custom interceptors can customize the default processing (for example, see the section on Bean Validation 1.1 in JAX-RS 2.0). Typical customization is to have one of the input parameters or the response value unwrapped before it can be validated.</p><p><a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/tr
unk/core/src/main/java/org/apache/cxf/validation/BeanValidationFeature.java">org.apache.cxf.validation.BeanValidationFeature</a> can be used to register both in and out validation interceptors.</p><h2 id="ValidationFeature-Configuration">Configuration</h2><p>The following snippets show how to get Bean Validation 1.1 interceptors activated for both JAX-RS and JAX-WS services using 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;">// Interface implemented by both JAX-RS and JAX-WS services:
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">// Interface implemented by both JAX-RS and JAX-WS services:
@WebService(targetNamespace = "http://bookworld.com")
@Path("/")
public interface BookWorld {
@@ -204,7 +205,7 @@ public class BookWorldImpl implements Bo
</pre>
</div></div><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;"><!-- JAX-RS and JAX-WS endpoints -->
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><!-- JAX-RS and JAX-WS endpoints -->
<jaxrs:server address="/bwrest">
<jaxrs:serviceBeans>
<ref bean="bookWorldValidation"/>
@@ -231,7 +232,7 @@ public class BookWorldImpl implements Bo
<bean id="commonValidationFeature" class="org.apache.cxf.validation.BeanValidationFeature"/>
</pre>
</div></div><p>Check the next section for more examples specific to JAX-RS.</p><h1 id="ValidationFeature-BeanValidation1.1andJAX-RS2.0">Bean Validation 1.1 and JAX-RS 2.0</h1><h2 id="ValidationFeature-Server">Server</h2><p>JAX-RS 2.0 specification (Chapter 7) introduces an optional requirement to get Bean Validation 1.1 supported.</p><p>Using the common interceptors described in the previous section can be sufficient for JAX-RS 2.0 resource methods having their input parameters and response values validated.</p><p>However, if you need a response values wrapped in JAX-RS Response validated or make sure per-request service instances get validated then JAX-RS frontend specific interceptors and the invoker need to be used:</p><ul class="alternate"><li>org.apache.cxf.jaxrs.validation.JAXRSBeanValidationInInterceptor: validates JAX-RS resource method parameters. At the moment it is nearly identical to the common BeanValidationInInterceptor which it extends. It can also be used as a JAX-RS
2.0 ContainerRequestFilter</li></ul><ul class="alternate"><li>org.apache.cxf.jaxrs.validation.JAXRSBeanValidationOutInterceptor: validates JAX-RS resource method return values, unwraps JAX-RS Response. It can also be used as a JAX-RS 2.0 ContainerResponseFilter</li></ul><ul class="alternate"><li>org.apache.cxf.jaxrs.validation.JAXRSBeanValidationFeature can be used to register both in and out validation interceptors.</li></ul><ul class="alternate"><li>org.apache.cxf.jaxrs.validation.JAXRSBeanValidationInvoker needs to be used for validating non-singleton service objects, see below for more information.</li></ul><p>Note the default JAX-RS ExceptionMapper (org.apache.cxf.jaxrs.validation.ValidationExceptionMapper) which transforms javax.validation.ValidationException to corresponding HTTP status code has to be registered. Users can register the custom mappers if preferred.</p><p>org.apache.cxf.jaxrs.validation.JAXRSParameterNameProvider can be registered directly with the common Bean
ValidationProvider to get the error messages customized.</p><p>JAX-RS 2.0 developers should prefer using JAX-RS frontend specific interceptors when possible to make sure JAX-RS specific fixes are picked up automatically.</p><h3 id="ValidationFeature-Validationofnon-singletonserviceobjects">Validation of non-singleton service objects</h3><p>The non-singleton service objects are created in CXF JAXRSInvoker therefore its subclass org.apache.cxf.jaxrs.validation.JAXRSBeanValidationInvoker needs to be registered if these objects need to be validated.</p><p>Register it either in a jaxrs:invoker block when using Spring or Blueprint or with a "jaxrs.invoker" servlet init parameter when using CXFNonSpringJaxrsServlet.</p><p> </p><h3 id="ValidationFeature-ConfiguringBeanValidation1.1usingJAXRSServerFactoryBean">Configuring Bean Validation 1.1 using JAXRSServerFactoryBean</h3><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;">JAXRSServerFactoryBean sf = new JAXRSServerFactoryBean();
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">JAXRSServerFactoryBean sf = new JAXRSServerFactoryBean();
sf.setResourceClasses( ... );
sf.setResourceProvider( ... );
sf.setProvider(new ValidationExceptionMapper());
@@ -240,7 +241,7 @@ sf.setOutInterceptors(Arrays.< Interc
sf.create();
</pre>
</div></div><h3 id="ValidationFeature-ConfiguringBeanValidation1.1usingSpringbeandefinitionsXML">Configuring Bean Validation 1.1 using Spring bean definitions XML</h3><p>Following the similar approach as for JAXRSServerFactoryBean, in case of Spring respective bean definitions should be added under <jaxrs:outInterceptors>, <jaxrs:inInterceptors> and <jaxrs:providers> sections, f.e.:</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="/">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;"><jaxrs:server address="/">
<jaxrs:inInterceptors>
<ref bean="validationInInterceptor" />
</jaxrs:inInterceptors>
@@ -270,7 +271,7 @@ sf.create();
</bean>
</pre>
</div></div><h3 id="ValidationFeature-ValidationExceptionsandHTTPstatuscodes">Validation Exceptions and HTTP status codes</h3><p>As per JAX-RS 2.0 specification, any input parameter validation violation is mapped to HTTP status code 400 Bad Request and any return value validation violation (or internal validation violation) is mapped to HTTP status code 500 Internal Server Error. This is essentially what org.apache.cxf.jaxrs.validation.ValidationExceptionMapper does.</p><div class="confluence-information-macro confluence-information-macro-note"><span class="aui-icon aui-icon-small aui-iconfont-warning confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>The details of validation exceptions are not currently included into the response but only logged. Application developers are encouraged to register custom exception mappers if reporting the validation error details is required.</p></div></div><h2 id="ValidationFeature-ClientProxies">Client Prox
ies</h2><p>CXF 3.1.9 introduces an org.apache.cxf.jaxrs.client.validation.JAXRSClientBeanValidationFeature which can be used to validate the request parameters of a JAX-RS proxy method.</p><h1 id="ValidationFeature-CustomizingValidationProvider">Customizing Validation Provider</h1><p><a shape="rect" class="external-link" href="https://git-wip-us.apache.org/repos/asf?p=cxf.git;a=blob;f=core/src/main/java/org/apache/cxf/validation/BeanValidationProvider.java;h=2efc7a15f79646d93af9588244c726832221461d;hb=HEAD">org.apache.cxf.validation.BeanValidationProvider</a> is a wrapper around javax.validation.ValidationFactory and used by CXF validation interceptors.</p><p>It is created if it has not been injected. However if one needs to customize javax.validation.ValidationFactory then a custom BeanValidationProvider instance can be injected via the 'provider' property into</p><p>the bean validation interceptors.BeanValidationProvider has the default constructor, the one accepting javax.validat
ion.ParameterNameProvider, etc, see the source for more details.</p><p>For example, one can customize the way parameters can be described on the JAX-RS path by injecting <a shape="rect" class="external-link" href="https://git-wip-us.apache.org/repos/asf?p=cxf.git;a=blob;f=rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/validation/JAXRSParameterNameProvider.java;h=62898defcedf0f1f27505273a9ae34dc9adea528;hb=HEAD">JAXRSParameterNameProvider</a> into BeanValidationProvider.</p><h1 id="ValidationFeature-Examples">Examples</h1><p>The following examples show JAX-RS resource methods being validated but predefined or custom Bean Validation 1.1 constraints can be applied to JAX-WS service methods exactly the same way.</p><h2 id="ValidationFeature-Validatingsimpleinputparameters">Validating simple input parameters</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;">@POST
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">@POST
@Path("/books")
public Response addBook(
@NotNull @Pattern(regexp = "\\d+") @FormParam("id") String id,
@@ -280,7 +281,7 @@ public Response addBook(
}
</pre>
</div></div><h2 id="ValidationFeature-Validatingcomplexinputparameters">Validating complex input parameters</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;">@POST
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">@POST
@Path("/books")
public Response addBook( @Valid Book book ) {
// do some work
@@ -288,7 +289,7 @@ public Response addBook( @Valid Book boo
}
</pre>
</div></div><p>This example assumes that class Book has validation constraints defined:</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;">public class Book {
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">public class Book {
@NotNull @Pattern(regexp = "\\d+") private String id;
@NotNull @Size(min = 1, max = 50) private String name;
@@ -296,7 +297,7 @@ public Response addBook( @Valid Book boo
}
</pre>
</div></div><h2 id="ValidationFeature-Validatingreturnvalues(non-Response)">Validating return values (non-Response)</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;">@GET
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">@GET
@Path("/books/{bookId}")
@Override
@NotNull @Valid
@@ -305,7 +306,7 @@ public Book getBook(@PathParam("bookId")
}
</pre>
</div></div><p>This example assumes that class Book has validation constraints defined (as in example above).</p><h2 id="ValidationFeature-Validatingreturnvalues(Response)">Validating return values (Response)</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;">@GET
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">@GET
@Path("/books/{bookId}")
@Valid @NotNull
public Response getBookResponse(@PathParam("bookId") String id) {
Modified: websites/production/cxf/content/docs/webservicecontext.html
==============================================================================
--- websites/production/cxf/content/docs/webservicecontext.html (original)
+++ websites/production/cxf/content/docs/webservicecontext.html Tue Sep 12 19:09:41 2017
@@ -32,6 +32,7 @@
<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/shBrushBash.js'></script>
<script src='/resources/highlighter/scripts/shBrushJava.js'></script>
<script>
SyntaxHighlighter.defaults['toolbar'] = false;
@@ -120,7 +121,7 @@ Apache CXF -- WebserviceContext
<p> The following code fragment show how to use some parts of the WebserviceContext.</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;">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">
public class CustomerServiceImpl implements CustomerService {
@Resource
WebServiceContext wsContext;
Modified: websites/production/cxf/content/docs/websocket.html
==============================================================================
--- websites/production/cxf/content/docs/websocket.html (original)
+++ websites/production/cxf/content/docs/websocket.html Tue Sep 12 19:09:41 2017
@@ -32,6 +32,7 @@
<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/shBrushBash.js'></script>
<script src='/resources/highlighter/scripts/shBrushJava.js'></script>
<script>
SyntaxHighlighter.defaults['toolbar'] = false;
@@ -117,7 +118,7 @@ Apache CXF -- WebSocket
<!-- Content -->
<div class="wiki-content">
<div id="ConfluenceContent"><div class="confluence-information-macro confluence-information-macro-note"><span class="aui-icon aui-icon-small aui-iconfont-warning confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>This page summarizes the current status of WebSocket support in CXF. This feature is currently only available in trunk (CXF 3.0.0-SNAPSHOT).</p></div></div><h1 id="WebSocket-UsingtheWebSockettransport">Using the WebSocket transport</h1><p>The intention for providing the WebSocket transport in CXF is to turn CXF endpoint services capable of reading or writing data over the socket that is connected to the client. For example, a JAXRS service using the WebSocket transport can continuously push or write data (e.g., status changes, events, etc) to the client once the client establishes a WebSocket connection to the service.</p><p> </p><h1 id="WebSocket-CurrentStatus">Current Status</h1><h3 id="WebSocket-Shortsummary">Short summary</h
3><ul style="list-style-type: square;"><li>The code resides in rt/transport/http-websocket and it enables cxf services to be invoked over websockets.</li><li>It supports both the embedded mode and the servlet container mode. The former can be used in the standalone setup that uses an embedded jetty server and the latter can be used in the container setup that uses the servlet container provided by the container.</li><li>Some test cases are located in systests/jaxrs/src/test/java/org/apache/cxf/systest/jaxrs/websocket and systests/jaxws/src/test/java/org/apache/cxf/systest/jaxws/websocket. There is also a browser based demo at distribution/src/main/release/samples/jax_rs/websocket.</li><li> Several additional libraries are required to enable this feature depending on the usage. Concretely, jetty-websocket is required for the embedded standalone mode (i.e., the endpoint is given with the host and port part as in address="<a shape="rect" href="ws://hostport" rel="nofollo
w">ws://host:port/path</a>"). For the servlet mode (i.e., the endpoint is given using a relative path (i.e., address="/path"), it requires either jetty-websocket to use jetty or atmosphere-runtime and a specific websocket implementation such as jetty-websocket or tomcat-websocket to use that specific container's websocket capability.</li></ul><h3 id="WebSocket-UsagePatterns">Usage Patterns</h3><p><span style="font-size: 14.0px;line-height: 1.4285715;">We have the following message exchange patterns to use this websocket transport for cxf service invocation.</span></p><ol><li>the client opens a websocket to some URL hosting a cxf service (e.g. <a shape="rect" href="ws://localhost:8080/cxf/myapp/books" rel="nofollow">ws://localhost:8080/cxf/myapp/books</a>)</li><li><p><span style="line-height: 1.4285715;">the client can subsequently invoke an operation provided by this service (e.g., the book order operation at /myapp/books/order/123) by sending a request message that a simplified HTT
P request message.</span><br clear="none"><span style="line-height: 1.4285715;"><br clear="none"></span></p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Request Syntax</b></div><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">Request = Request-Line CRLF
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">Request = Request-Line CRLF
*(( header ) CRLF)
CRLF
[ body ]
@@ -126,7 +127,7 @@ Request-Line = Method SP Request-URI
</pre>
</div></div><p> </p><p>Method uses the HTTP methods.</p><p>header may include any headers that are required by CXF to determine the operation and expected by the operation itself (e.g., Content-Type).</p><br clear="none"><span style="line-height: 1.4285715;"><br clear="none"></span></li><li><p><span style="line-height: 1.4285715;">the response message returned by the the service is sent back to the client as</span><br clear="none"><span style="line-height: 1.4285715;"><br clear="none"></span></p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Request Syntax</b></div><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">Response = [ Status-Line CRLF ]
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">Response = [ Status-Line CRLF ]
*(( header ) CRLF)
CRLF
[ body ]
Modified: websites/production/cxf/content/docs/ws-addressing.html
==============================================================================
--- websites/production/cxf/content/docs/ws-addressing.html (original)
+++ websites/production/cxf/content/docs/ws-addressing.html Tue Sep 12 19:09:41 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();
@@ -123,7 +123,7 @@ Apache CXF -- WS-Addressing
<p>To enable WS-Addressing you may enable the WSAddressingFeature on your service. If you wish to use XML to configure this, you may use the following syntax:</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;">
<jaxws:endpoint id="{your.service.namespace}YourPortName">
<jaxws:features>
<wsa:addressing xmlns:wsa="http://cxf.apache.org/ws/addressing"/>
@@ -133,7 +133,7 @@ Apache CXF -- WS-Addressing
</div></div>
<p>You can also use the same exact syntax with a <jaxws:client></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;">
<jaxws: client id="{your.service.namespace}YourPortName">
<jaxws:features>
<wsa:addressing xmlns:wsa="http://cxf.apache.org/ws/addressing"/>
@@ -143,7 +143,7 @@ Apache CXF -- WS-Addressing
</div></div>
<p> From an API point of view this looks very similar:</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;">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">
import org.apache.cxf.jaxws.EndpointImpl;
import org.apache.cxf.ws.addressing.WSAddressingFeature;
@@ -155,7 +155,7 @@ ep.publish("http://some/address");
</div></div>
<p>You can also use it with the ClientProxyFactoryBeans and ServerFactoryBeans (and their JAX-WS versions, namely JaxWsProxyFactoryBean and JaxWsServerFactoryBean):</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;">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">
import org.apache.cxf.frontend.simple.ClientProxyFactoryBean;
import org.apache.cxf.ws.addressing.WSAddressingFeature;
@@ -177,7 +177,7 @@ MyService client = (MyService) factory.c
<p>The HTTP Conduit's client configuration has an option for a DecoupledEndpoint address. If the conduit has this configured, all requests sent via that conduit that have WS-Addressing enabled will have their responses sent to that endpoint:</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;">
<http:conduit name="{http://apache.org/hello_world_soap_http}SoapPort.http-conduit">
<http:client DecoupledEndpoint="http://localhost:9090/decoupled_endpoint"/>
</http:conduit>
@@ -187,7 +187,7 @@ MyService client = (MyService) factory.c
<h3 id="WS-Addressing-RequestProperty">Request Property</h3>
<p>The address can be set via a Request Context property. </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;">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">
((BindingProvider)proxy).getRequestContext()
.put("org.apache.cxf.ws.addressing.replyto", "http://localhost:9090/decoupled_endpoint");
</pre>
@@ -196,7 +196,7 @@ MyService client = (MyService) factory.c
<h3 id="WS-Addressing-AddressingProperties">AddressingProperties</h3>
<p>The CXF org.apache.cxf.ws.addressing.impl.AddressingPropertiesImpl object can be used to control many aspects of WS-Addressing including the Reply-To:</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;">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">
AddressingProperties maps = new AddressingPropertiesImpl();
EndpointReferenceType ref = new EndpointReferenceType();
AttributedURIType add = new AttributedURIType();
Modified: websites/production/cxf/content/docs/ws-discovery.html
==============================================================================
--- websites/production/cxf/content/docs/ws-discovery.html (original)
+++ websites/production/cxf/content/docs/ws-discovery.html Tue Sep 12 19:09:41 2017
@@ -133,7 +133,7 @@ Apache CXF -- WS-Discovery
<p>CXF also provides an API to probe the network or WS-Discovery proxy. The org.apache.cxf.ws.discovery.WSDiscoveryClient class provides several methods for probing the network. </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;">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">
//Use WS-Discovery to find references to services that implement the Greeter portType
WSDiscoveryClient client = new WSDiscoveryClient();
// or: new WSDiscoveryClient("soap.udp://proxyhost:3702");
Modified: websites/production/cxf/content/docs/ws-metadataexchange.html
==============================================================================
--- websites/production/cxf/content/docs/ws-metadataexchange.html (original)
+++ websites/production/cxf/content/docs/ws-metadataexchange.html Tue Sep 12 19:09:41 2017
@@ -120,7 +120,7 @@ Apache CXF -- WS-MetadataExchange
dependency will need to be included in your project:</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;">
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-ws-mex</artifactId>
Modified: websites/production/cxf/content/docs/ws-policy-framework-overview.html
==============================================================================
--- websites/production/cxf/content/docs/ws-policy-framework-overview.html (original)
+++ websites/production/cxf/content/docs/ws-policy-framework-overview.html Tue Sep 12 19:09:41 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();
@@ -141,7 +141,7 @@ Apache CXF -- WS-Policy Framework Overvi
<p>AssertionBuilder implementations are loaded dynamically and are automatically registered with the AssertionBuilderRegistry, which is available as a Bus extension. Currently, CXF supports AssertionBuilder and Assertion implementations for the following assertion types:</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;">
{http://schemas.xmlsoap.org/ws/2005/02/rm/policy}RMAssertion
{http://www.w3.org/2007/01/addressing/metadata}Addressing
{http://www.w3.org/2007/01/addressing/metadata}AnonymousResponses
@@ -158,7 +158,7 @@ Apache CXF -- WS-Policy Framework Overvi
<p>This API is used to automatically engage interceptors required to support domain specific assertions at runtime, thus simplifying interceptor configuration a lot.</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;">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">
public interface PolicyInterceptorProvider extends InterceptorProvider {
// return the schema types of the asssertions that can be supported
Collection<QName> getAssertionTypes()
@@ -167,7 +167,7 @@ public interface PolicyInterceptorProvid
</div></div>
<p>Currently, CXF supports PolicyInterceptorProvider implementations for the following assertion types:</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;">
{http://schemas.xmlsoap.org/ws/2005/02/rm/policy}RMAssertion
{http://www.w3.org/2007/01/addressing/metadata}Addressing
{http://www.w3.org/2007/01/addressing/metadata}AnonymousResponses
@@ -186,7 +186,7 @@ public interface PolicyInterceptorProvid
<p>Like most other CXF features, the policy framework is itself largely interceptor based. Thus, most interaction with the framework is indirect through the Message object: Policy interceptors make AssertionInfo objects (stateful representations of assertions) available to subsequently executing, policy-aware interceptors by inserting them into the Message object. Extracting the AssertionInfo objects from the Message allows interceptors to perform steps 1. and 2. above: </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;">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">
import org.apache.neethi.Assertion;
public class AssertionInfo {
@@ -206,7 +206,7 @@ And Destinations cannot normally exhibit
<p>Their interaction with the policy framework therefore typically involves the PolicyEngine through which they obtain the effective policy for the underlying endpoint (for step 1.):</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;">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">
public interface PolicyEngine {
...
EndpointPolicy getClientEndpointPolicy(EndpointInfo ei,
@@ -225,7 +225,7 @@ public interface EndpointPolicy {
<p>To perform step 2. they implement the Assertor interface (namely its assertMessage method):</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;">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">
public class Assertor {
...
public boolean canAssert(QName name);
Modified: websites/production/cxf/content/docs/ws-reliablemessaging.html
==============================================================================
--- websites/production/cxf/content/docs/ws-reliablemessaging.html (original)
+++ websites/production/cxf/content/docs/ws-reliablemessaging.html Tue Sep 12 19:09:41 2017
@@ -32,6 +32,7 @@
<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/shBrushBash.js'></script>
<script src='/resources/highlighter/scripts/shBrushJava.js'></script>
<script>
SyntaxHighlighter.defaults['toolbar'] = false;
@@ -148,7 +149,7 @@ Apache CXF -- WS-ReliableMessaging
<p>For example, if you have the JMX server enabled in your client configuration you could use this code to track the last acknowledgement number received:</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;">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">
private static class AcknowledgementListener implements NotificationListener {
private volatile long lastAcknowledgement;
Modified: websites/production/cxf/content/docs/ws-secureconversation.html
==============================================================================
--- websites/production/cxf/content/docs/ws-secureconversation.html (original)
+++ websites/production/cxf/content/docs/ws-secureconversation.html Tue Sep 12 19:09:41 2017
@@ -32,8 +32,9 @@
<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/shBrushBash.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();
@@ -134,7 +135,7 @@ Apache CXF -- WS-SecureConversation
<p>Configuring the WS-SecurityPolicy properties for WS-SecureConversation works exactly like the configuration for straight WS-SecurityPolicy. The only difference is that there needs to be a way to specify which properties are intended for the bootstrap policy in the SecureConversationToken and which are intended for the actual service policy. To accomplish this, properties intended for the SecureConversationToken bootstrap policy are appended with ".sct". 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;">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">
<jaxws:client name="{http://InteropBaseAddress/interop}XDC-SEES_IPingService"
createdFromAPI="true">
<jaxws:properties>
@@ -154,7 +155,7 @@ Apache CXF -- WS-SecureConversation
<p>Via the Java API, use code similar to the following:</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;">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">
org.apache.cxf.endpoint.Client client;
client.getRequestContext().put("ws-security.username.sct", username);
client.getRequestContext().put("ws-security.password.sct", password);
@@ -163,7 +164,7 @@ client.getRequestContext().put("ws-secur
<p>Via the Java API, use code similar to the following:</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;">
+<pre class="brush: bash; gutter: false; theme: Confluence" style="font-size:12px;">
org.apache.cxf.endpoint.Client client;
client.getRequestContext().put("ws-security.username.sct", username);
client.getRequestContext().put("ws-security.password.sct", password);