You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by dk...@apache.org on 2013/06/24 19:10:57 UTC
svn commit: r867253 [33/46] - in /websites/production/cxf/content: ./
2008/04/28/ 2008/06/20/ 2009/02/10/ 2009/08/04/ cache/ docs/
docs/cxf-architecture.thumbs/ docs/cxf-dependency-graphs.thumbs/
docs/logbrowser-configuration.thumbs/ docs/logbrowser-so...
Modified: websites/production/cxf/content/docs/maven-cxf-codegen-plugin-wsdl-to-java.html
==============================================================================
--- websites/production/cxf/content/docs/maven-cxf-codegen-plugin-wsdl-to-java.html (original)
+++ websites/production/cxf/content/docs/maven-cxf-codegen-plugin-wsdl-to-java.html Mon Jun 24 17:10:51 2013
@@ -25,6 +25,18 @@
<meta http-equiv="Content-type" content="text/html;charset=UTF-8">
<meta name="keywords" content="business integration, EAI, SOA, Service Oriented Architecture, web services, SOAP, JBI, JMS, WSDL, XML, EDI, Electronic Data Interchange, standards support, integration standards, application integration, middleware, software, solutions, services, CXF, open source">
<meta name="description" content="Apache CXF, Services Framework - Maven cxf-codegen-plugin (WSDL to Java)">
+
+ <link href='http://cxf.apache.org/resources/highlighter/styles/shCore.css' rel='stylesheet' type='text/css' />
+ <link href='http://cxf.apache.org/resources/highlighter/styles/shThemeCXF.css' rel='stylesheet' type='text/css' />
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shCore.js' type='text/javascript'></script>
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shBrushXml.js' type='text/javascript'></script>
+
+ <script type="text/javascript">
+ SyntaxHighlighter.defaults['toolbar'] = false;
+ SyntaxHighlighter.all();
+ </script>
+
<title>
Apache CXF -- Maven cxf-codegen-plugin (WSDL to Java)
</title>
@@ -42,19 +54,15 @@ Apache CXF -- Maven cxf-codegen-plugin (
<td id="cell-1-0"> </td>
<td id="cell-1-1"> </td>
<td id="cell-1-2">
- <div style="padding: 5px;">
- <div id="banner">
- <!-- Banner -->
-<div id="banner-content">
+ <!-- Banner -->
+<div class="banner" id="banner"><p>
<table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td align="left" colspan="1" nowrap>
<a shape="rect" href="http://cxf.apache.org/" title="Apache CXF"><span style="font-weight: bold; font-size: 170%; color: white">Apache CXF</span></a>
</td><td align="right" colspan="1" nowrap>
<a shape="rect" href="http://www.apache.org/" title="The Apache Sofware Foundation"><img border="0" alt="ASF Logo" src="http://cxf.apache.org/images/asf-logo.png"></a>
</td></tr></table>
-</div>
- <!-- Banner -->
- </div>
- </div>
+</p></div>
+ <!-- Banner -->
<div id="top-menu">
<table border="0" cellpadding="1" cellspacing="0" width="100%">
<tr>
@@ -94,7 +102,7 @@ Apache CXF -- Maven cxf-codegen-plugin (
<hr>
-<ul class="alternate" type="square"><li>Search
+<ul class="alternate" type="square"><li>Search<br clear="none">
<form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
<div>
@@ -123,52 +131,52 @@ Apache CXF -- Maven cxf-codegen-plugin (
<div class="wiki-content">
<div id="ConfluenceContent"><p>CXF includes a Maven plugin which can generate java artifacts from WSDL. Here is a simple example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><plugin></span>
- <span class="code-tag"><groupId></span>org.apache.cxf<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>cxf-codegen-plugin<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>${cxf.version}<span class="code-tag"></version></span>
- <span class="code-tag"><executions></span>
- <span class="code-tag"><execution></span>
- <span class="code-tag"><id></span>generate-sources<span class="code-tag"></id></span>
- <span class="code-tag"><phase></span>generate-sources<span class="code-tag"></phase></span>
- <span class="code-tag"><configuration></span>
- <span class="code-tag"><sourceRoot></span>${project.build.directory}/generated/cxf<span class="code-tag"></sourceRoot></span>
- <span class="code-tag"><wsdlOptions></span>
- <span class="code-tag"><wsdlOption></span>
- <span class="code-tag"><wsdl></span>${basedir}/src/main/resources/myService.wsdl<span class="code-tag"></wsdl></span>
- <span class="code-tag"></wsdlOption></span>
- <span class="code-tag"></wsdlOptions></span>
- <span class="code-tag"></configuration></span>
- <span class="code-tag"><goals></span>
- <span class="code-tag"><goal></span>wsdl2java<span class="code-tag"></goal></span>
- <span class="code-tag"></goals></span>
- <span class="code-tag"></execution></span>
- <span class="code-tag"></executions></span>
-<span class="code-tag"></plugin></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<plugin>
+ <groupId>org.apache.cxf</groupId>
+ <artifactId>cxf-codegen-plugin</artifactId>
+ <version>${cxf.version}</version>
+ <executions>
+ <execution>
+ <id>generate-sources</id>
+ <phase>generate-sources</phase>
+ <configuration>
+ <sourceRoot>${project.build.directory}/generated/cxf</sourceRoot>
+ <wsdlOptions>
+ <wsdlOption>
+ <wsdl>${basedir}/src/main/resources/myService.wsdl</wsdl>
+ </wsdlOption>
+ </wsdlOptions>
+ </configuration>
+ <goals>
+ <goal>wsdl2java</goal>
+ </goals>
+ </execution>
+ </executions>
+</plugin>
+]]></script>
</div></div>
<p>In this example we're running the wsdl2java goal in the generate-sources phase. By running <b>mvn generate-sources</b>, CXF will generate artifacts in the <sourceRoot> directory that you specify. Each <wsdlOption> element corresponds to a WSDL that you're generated artifacts for. The WSDL location is specified via the <wsdl> option. Following <a shape="rect" class="external-link" href="http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html">Maven standard directory layout</a>, if you're planning on packaging the WSDL in the JAR you're creating you'll want the WSDL above in /src/main/resources/ (alternatively in a subfolder underneath it if desired to avoid placing resources in the root of a JAR); else use the /src/main/config folder to keep the WSDL out of the JAR.</p>
<p>The following example shows some customization options. By default, the codegen plugin follows the Maven convention of "target/generated-sources/cxf" for the output folder for the generated classes. You can override this value using <sourceRoot> as shown below, but note this is usually not necessary, the default is fine for most people and can make it easier for some IDE's to detect the generated source code. Other configuration arguments can be included inside the <wsdlOption> element. These pass arguments to the tooling and correspond to the options outlined on the <a shape="rect" href="wsdl-to-java.html" title="WSDL to Java">WSDL to Java</a> page.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
...
-<span class="code-tag"><configuration></span>
- <span class="code-tag"><sourceRoot></span>${project.build.directory}/generated-code/mywebservice<span class="code-tag"></sourceRoot></span>
- <span class="code-tag"><wsdlOptions></span>
- <span class="code-tag"><wsdlOption></span>
- <span class="code-tag"><wsdl></span>${basedir}/src/main/resources/wsdl/myService.wsdl<span class="code-tag"></wsdl></span>
- <span class="code-tag"><extraargs></span>
- <span class="code-tag"><extraarg></span>-impl<span class="code-tag"></extraarg></span>
- <span class="code-tag"><extraarg></span>-verbose<span class="code-tag"></extraarg></span>
- <span class="code-tag"></extraargs></span>
- <span class="code-tag"></wsdlOption></span>
- <span class="code-tag"></wsdlOptions></span>
-<span class="code-tag"></configuration></span>
+<configuration>
+ <sourceRoot>${project.build.directory}/generated-code/mywebservice</sourceRoot>
+ <wsdlOptions>
+ <wsdlOption>
+ <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
+ <extraargs>
+ <extraarg>-impl</extraarg>
+ <extraarg>-verbose</extraarg>
+ </extraargs>
+ </wsdlOption>
+ </wsdlOptions>
+</configuration>
...
-</pre>
+]]></script>
</div></div>
<p>See <a shape="rect" class="external-link" href="http://www.jroller.com/gmazza/entry/web_service_tutorial" rel="nofollow">this blog entry</a> for a full service and client example that uses the cxf-codegen-plugin.</p>
@@ -176,18 +184,18 @@ Apache CXF -- Maven cxf-codegen-plugin (
<h3><a shape="rect" name="Mavencxf-codegen-plugin%28WSDLtoJava%29-Example1%3APassinginaJAXWSBindingfile"></a>Example 1: Passing in a JAX-WS Binding file</h3>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><configuration></span>
- <span class="code-tag"><wsdlOptions></span>
- <span class="code-tag"><wsdlOption></span>
- <span class="code-tag"><wsdl></span>${basedir}/src/main/resources/wsdl/myService.wsdl<span class="code-tag"></wsdl></span>
- <span class="code-tag"><bindingFiles></span>
- <span class="code-tag"><bindingFile></span>${basedir}/src/main/resources/async_binding.xml<span class="code-tag"></bindingFile></span>
- <span class="code-tag"></bindingFiles></span>
- <span class="code-tag"></wsdlOption></span>
- <span class="code-tag"></wsdlOptions></span>
-<span class="code-tag"></configuration></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<configuration>
+ <wsdlOptions>
+ <wsdlOption>
+ <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
+ <bindingFiles>
+ <bindingFile>${basedir}/src/main/resources/async_binding.xml</bindingFile>
+ </bindingFiles>
+ </wsdlOption>
+ </wsdlOptions>
+</configuration>
+]]></script>
</div></div>
<p>In this example we're specifying that we want CXF to use our JAX-WS binding file. Binding files are a way to customize the output of the artifacts that CXF generates. For instance, it allows you to change the package name CXF uses.</p>
@@ -195,16 +203,16 @@ Apache CXF -- Maven cxf-codegen-plugin (
<h3><a shape="rect" name="Mavencxf-codegen-plugin%28WSDLtoJava%29-Example2%3ASpecifyingaservicetogenerateartifactsfor"></a>Example 2: Specifying a service to generate artifacts for</h3>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><configuration></span>
- <span class="code-tag"><wsdlOptions></span>
- <span class="code-tag"><wsdlOption></span>
- <span class="code-tag"><wsdl></span>${basedir}/src/main/resources/wsdl/myService.wsdl<span class="code-tag"></wsdl></span>
- <span class="code-tag"><serviceName></span>MyWSDLService<span class="code-tag"></serviceName></span>
- <span class="code-tag"></wsdlOption></span>
- <span class="code-tag"></wsdlOptions></span>
-<span class="code-tag"></configuration></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<configuration>
+ <wsdlOptions>
+ <wsdlOption>
+ <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
+ <serviceName>MyWSDLService</serviceName>
+ </wsdlOption>
+ </wsdlOptions>
+</configuration>
+]]></script>
</div></div>
<p>In this example we're specifying that we only want to generate artifacts for the service named "MyWSDLService" in the WSDL.</p>
@@ -213,26 +221,26 @@ Apache CXF -- Maven cxf-codegen-plugin (
<h3><a shape="rect" name="Mavencxf-codegen-plugin%28WSDLtoJava%29-Example3%3AUsingdefaultOptiontoavoidrepetition"></a>Example 3: Using defaultOption to avoid repetition</h3>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><configuration></span>
- <span class="code-tag"><defaultOptions></span>
- <span class="code-tag"><bindingFiles></span>
- <span class="code-tag"><bindingFile></span>${basedir}/src/main/jaxb/bindings.xml<span class="code-tag"></bindingFile></span>
- <span class="code-tag"></bindingFiles></span>
- <span class="code-tag"><noAddressBinding></span>true<span class="code-tag"></noAddressBinding></span>
- <span class="code-tag"></defaultOptions></span>
- <span class="code-tag"><wsdlOptions></span>
- <span class="code-tag"><wsdlOption></span>
- <span class="code-tag"><wsdl></span>${basedir}/src/main/resources/wsdl/myService.wsdl<span class="code-tag"></wsdl></span>
- <span class="code-tag"><serviceName></span>MyWSDLService<span class="code-tag"></serviceName></span>
- <span class="code-tag"></wsdlOption></span>
- <span class="code-tag"><wsdlOption></span>
- <span class="code-tag"><wsdl></span>${basedir}/src/main/resources/wsdl/myOtherService.wsdl<span class="code-tag"></wsdl></span>
- <span class="code-tag"><serviceName></span>MyOtherWSDLService<span class="code-tag"></serviceName></span>
- <span class="code-tag"></wsdlOption></span>
- <span class="code-tag"></wsdlOptions></span>
-<span class="code-tag"></configuration></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<configuration>
+ <defaultOptions>
+ <bindingFiles>
+ <bindingFile>${basedir}/src/main/jaxb/bindings.xml</bindingFile>
+ </bindingFiles>
+ <noAddressBinding>true</noAddressBinding>
+ </defaultOptions>
+ <wsdlOptions>
+ <wsdlOption>
+ <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
+ <serviceName>MyWSDLService</serviceName>
+ </wsdlOption>
+ <wsdlOption>
+ <wsdl>${basedir}/src/main/resources/wsdl/myOtherService.wsdl</wsdl>
+ <serviceName>MyOtherWSDLService</serviceName>
+ </wsdlOption>
+ </wsdlOptions>
+</configuration>
+]]></script>
</div></div>
<p><defaultOption> and <wsdlOption> correspond to the options outlined on the <a shape="rect" href="wsdl-to-java.html" title="WSDL to Java">WSDL to Java</a> page, you may look at <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/maven-plugins/codegen-plugin/src/main/java/org/apache/cxf/maven_plugin/Option.java">http://svn.apache.org/repos/asf/cxf/trunk/maven-plugins/codegen-plugin/src/main/java/org/apache/cxf/maven_plugin/Option.java</a> for a more detailed description of those parameters.</p>
@@ -242,20 +250,20 @@ Apache CXF -- Maven cxf-codegen-plugin (
<h3><a shape="rect" name="Mavencxf-codegen-plugin%28WSDLtoJava%29-Example4%3AUsingwsdlRootwithincludes%2Fexcludespatterns"></a>Example 4: Using wsdlRoot with includes/excludes patterns</h3>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><configuration></span>
- <span class="code-tag"><defaultOptions></span>
- <span class="code-tag"><bindingFiles></span>
- <span class="code-tag"><bindingFile></span>${basedir}/src/main/jaxb/bindings.xml<span class="code-tag"></bindingFile></span>
- <span class="code-tag"></bindingFiles></span>
- <span class="code-tag"><noAddressBinding></span>true<span class="code-tag"></noAddressBinding></span>
- <span class="code-tag"></defaultOptions></span>
- <span class="code-tag"><wsdlRoot></span>${basedir}/src/main/resources/wsdl<span class="code-tag"></wsdlRoot></span>
- <span class="code-tag"><includes></span>
- <span class="code-tag"><include></span>*Service.wsdl<span class="code-tag"></include></span>
- <span class="code-tag"></includes></span>
-<span class="code-tag"></configuration></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<configuration>
+ <defaultOptions>
+ <bindingFiles>
+ <bindingFile>${basedir}/src/main/jaxb/bindings.xml</bindingFile>
+ </bindingFiles>
+ <noAddressBinding>true</noAddressBinding>
+ </defaultOptions>
+ <wsdlRoot>${basedir}/src/main/resources/wsdl</wsdlRoot>
+ <includes>
+ <include>*Service.wsdl</include>
+ </includes>
+</configuration>
+]]></script>
</div></div>
<p>wsdlRoot default value is <tt>src/main/resources/wsdl</tt> so you may omit this declaration.</p>
@@ -265,19 +273,19 @@ Apache CXF -- Maven cxf-codegen-plugin (
<p>For CXF 2.3 and latter there is a new config element <wsdlArtifact> which can be used to load a wsdl file from the maven repository.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><configuration></span>
- <span class="code-tag"><wsdlOptions></span>
- <span class="code-tag"><wsdlOption></span>
- <span class="code-tag"><wsdlArtifact></span>
- <span class="code-tag"><groupId></span>org.apache.pizza<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>PizzaService<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>1.0.0<span class="code-tag"></version></span>
- <span class="code-tag"></wsdlArtifact></span>
- <span class="code-tag"></wsdlOption></span>
- <span class="code-tag"></wsdlOptions></span>
- <span class="code-tag"></configuration></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <configuration>
+ <wsdlOptions>
+ <wsdlOption>
+ <wsdlArtifact>
+ <groupId>org.apache.pizza</groupId>
+ <artifactId>PizzaService</artifactId>
+ <version>1.0.0</version>
+ </wsdlArtifact>
+ </wsdlOption>
+ </wsdlOptions>
+ </configuration>
+]]></script>
</div></div>
<p>This will load the wsdl /org/apache/pizza/PizzaService-1.0.0.wsdl into your local maven repository and generate java code from it.</p>
@@ -294,40 +302,40 @@ Apache CXF -- Maven cxf-codegen-plugin (
<p>An example showing attachment of a JAXB binding file and the CXF toString() extension is below:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><plugin></span>
-<span class="code-tag"><groupId></span>org.apache.cxf<span class="code-tag"></groupId></span>
-<span class="code-tag"><artifactId></span>cxf-codegen-plugin<span class="code-tag"></artifactId></span>
-<span class="code-tag"><version></span>${cxf.version}<span class="code-tag"></version></span>
-<span class="code-tag"><executions></span>
- <span class="code-tag"><execution></span>
- <span class="code-tag"><id></span>generate-sources<span class="code-tag"></id></span>
- <span class="code-tag"><phase></span>generate-sources<span class="code-tag"></phase></span>
- <span class="code-tag"><configuration></span>
- <span class="code-tag"><wsdlOptions></span>
- <span class="code-tag"><wsdlOption></span>
- <span class="code-tag"><wsdl></span>${basedir}/src/main/resources/wsdl/myService.wsdl<span class="code-tag"></wsdl></span>
- <span class="code-tag"><extraargs></span>
- <span class="code-tag"><extraarg></span>-xjc-b,binding.xjb<span class="code-tag"></extraarg></span>
- <span class="code-tag"><extraarg></span>-xjc-Xts<span class="code-tag"></extraarg></span>
- <span class="code-tag"></extraargs></span>
- <span class="code-tag"></wsdlOption></span>
- <span class="code-tag"></wsdlOptions></span>
- <span class="code-tag"></configuration></span>
- <span class="code-tag"><goals></span>
- <span class="code-tag"><goal></span>wsdl2java<span class="code-tag"></goal></span>
- <span class="code-tag"></goals></span>
- <span class="code-tag"></execution></span>
-<span class="code-tag"></executions></span>
-<span class="code-tag"><dependencies></span>
- <span class="code-tag"><dependency></span>
- <span class="code-tag"><groupId></span>org.apache.cxf<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>cxf-xjc-ts<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>${cxf.version}<span class="code-tag"></version></span>
- <span class="code-tag"></dependency></span>
-<span class="code-tag"></dependencies></span>
-<span class="code-tag"></plugin></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<plugin>
+<groupId>org.apache.cxf</groupId>
+<artifactId>cxf-codegen-plugin</artifactId>
+<version>${cxf.version}</version>
+<executions>
+ <execution>
+ <id>generate-sources</id>
+ <phase>generate-sources</phase>
+ <configuration>
+ <wsdlOptions>
+ <wsdlOption>
+ <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
+ <extraargs>
+ <extraarg>-xjc-b,binding.xjb</extraarg>
+ <extraarg>-xjc-Xts</extraarg>
+ </extraargs>
+ </wsdlOption>
+ </wsdlOptions>
+ </configuration>
+ <goals>
+ <goal>wsdl2java</goal>
+ </goals>
+ </execution>
+</executions>
+<dependencies>
+ <dependency>
+ <groupId>org.apache.cxf</groupId>
+ <artifactId>cxf-xjc-ts</artifactId>
+ <version>${cxf.version}</version>
+ </dependency>
+</dependencies>
+</plugin>
+]]></script>
</div></div>
@@ -336,98 +344,98 @@ Apache CXF -- Maven cxf-codegen-plugin (
<p>Java 6 includes JAXB/JAX-WS 2.1 API's and a 2.1 implementations. However, sometimes it's desirable to use JAXB or JAX-WS 2.2 instead to obtain various bug fixes and enhancements. Using 2.2 with Java 6 and Maven can be a bit tricky as it requires endorsing the API jars which requires configuration of a bunch of plugins, requires use of "forking", etc... First off, both Surefire and the Compiler plugins need to be setup to point at an endorsed dir:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
-<span class="code-tag"><pluginManagement></span>
- <span class="code-tag"><plugins></span>
- <span class="code-tag"><plugin></span>
- <span class="code-tag"><groupId></span>org.apache.maven.plugins<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>maven-compiler-plugin<span class="code-tag"></artifactId></span>
- <span class="code-tag"><configuration></span>
- <span class="code-tag"><compilerArguments></span>
- <span class="code-tag"><endorseddirs></span>${project.build.directory}/endorsed<span class="code-tag"></endorseddirs></span>
- <span class="code-tag"></compilerArguments></span>
- <span class="code-tag"></configuration></span>
- <span class="code-tag"></plugin></span>
- <span class="code-tag"><plugin></span>
- <span class="code-tag"><groupId></span>org.apache.maven.plugins<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>maven-surefire-plugin<span class="code-tag"></artifactId></span>
- <span class="code-tag"><configuration></span>
- <span class="code-tag"><forkMode></span>once<span class="code-tag"></forkMode></span>
- <span class="code-tag"><argLine></span>-Djava.endorsed.dirs=${project.build.directory}/endorsed<span class="code-tag"></argLine></span>
- <span class="code-tag"></configuration></span>
- <span class="code-tag"></plugin></span>
- <span class="code-tag"></plugins></span>
-<span class="code-tag"></pluginManagement></span>
-</pre>
+<pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-compiler-plugin</artifactId>
+ <configuration>
+ <compilerArguments>
+ <endorseddirs>${project.build.directory}/endorsed</endorseddirs>
+ </compilerArguments>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-surefire-plugin</artifactId>
+ <configuration>
+ <forkMode>once</forkMode>
+ <argLine>-Djava.endorsed.dirs=${project.build.directory}/endorsed</argLine>
+ </configuration>
+ </plugin>
+ </plugins>
+</pluginManagement>
+]]></script>
</div></div>
<p>You will then need to use the maven-dependency-plugin to copy the needed artifacts into the endorsed.dir:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><plugins></span>
- <span class="code-tag"><plugin></span>
- <span class="code-tag"><groupId></span>org.apache.maven.plugins<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>maven-dependency-plugin<span class="code-tag"></artifactId></span>
- <span class="code-tag"><executions></span>
- <span class="code-tag"><execution></span>
- <span class="code-tag"><phase></span>generate-sources<span class="code-tag"></phase></span>
- <span class="code-tag"><goals></span>
- <span class="code-tag"><goal></span>copy<span class="code-tag"></goal></span>
- <span class="code-tag"></goals></span>
- <span class="code-tag"><configuration></span>
- <span class="code-tag"><artifactItems></span>
- <span class="code-tag"><artifactItem></span>
- <span class="code-tag"><groupId></span>javax.xml.bind<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>jaxb-api<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>2.2<span class="code-tag"></version></span>
- <span class="code-tag"></artifactItem></span>
- <span class="code-tag"><artifactItem></span>
- <span class="code-tag"><groupId></span>javax.xml.ws<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>jaxws-api<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>2.2<span class="code-tag"></version></span>
- <span class="code-tag"></artifactItem></span>
- <span class="code-tag"></artifactItems></span>
- <span class="code-tag"><outputDirectory></span>${project.build.directory}/endorsed<span class="code-tag"></outputDirectory></span>
- <span class="code-tag"></configuration></span>
- <span class="code-tag"></execution></span>
- <span class="code-tag"></executions></span>
- <span class="code-tag"></plugin></span>
-<span class="code-tag"></plugins></span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-dependency-plugin</artifactId>
+ <executions>
+ <execution>
+ <phase>generate-sources</phase>
+ <goals>
+ <goal>copy</goal>
+ </goals>
+ <configuration>
+ <artifactItems>
+ <artifactItem>
+ <groupId>javax.xml.bind</groupId>
+ <artifactId>jaxb-api</artifactId>
+ <version>2.2</version>
+ </artifactItem>
+ <artifactItem>
+ <groupId>javax.xml.ws</groupId>
+ <artifactId>jaxws-api</artifactId>
+ <version>2.2</version>
+ </artifactItem>
+ </artifactItems>
+ <outputDirectory>${project.build.directory}/endorsed</outputDirectory>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+</plugins>
-</pre>
+]]></script>
</div></div>
<p>Finally, you need to do similar setup for the CXF Codegen plugin so it picks up the 2.2 API's and runtimes:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
-<span class="code-tag"><plugin></span>
- <span class="code-tag"><groupId></span>org.apache.cxf<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>cxf-codegen-plugin<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>${cxf.version}<span class="code-tag"></version></span>
- <span class="code-tag"><configuration></span>
- <span class="code-tag"><fork></span>once<span class="code-tag"></fork></span>
- <span class="code-tag"><additionalJvmArgs></span>-Djava.endorsed.dirs=${project.build.directory}/endorsed<span class="code-tag"></additionalJvmArgs></span>
- <span class="code-tag"><span class="code-comment"><!-- rest of the normal codegen configuration options --></span></span>
- <span class="code-tag"></configuraion></span>
- <span class="code-tag"><dependencies></span>
- <span class="code-tag"><dependency></span>
- <span class="code-tag"><groupId></span>com.sun.xml.bind<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>jaxb-impl<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>2.2<span class="code-tag"></version></span>
- <span class="code-tag"></dependency></span>
- <span class="code-tag"><dependency></span>
- <span class="code-tag"><groupId></span>com.sun.xml.bind<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>jaxb-xjc<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>2.2<span class="code-tag"></version></span>
- <span class="code-tag"></dependency></span>
- <span class="code-tag"></dependencies></span>
-<span class="code-tag"></plugin></span>
+<plugin>
+ <groupId>org.apache.cxf</groupId>
+ <artifactId>cxf-codegen-plugin</artifactId>
+ <version>${cxf.version}</version>
+ <configuration>
+ <fork>once</fork>
+ <additionalJvmArgs>-Djava.endorsed.dirs=${project.build.directory}/endorsed</additionalJvmArgs>
+ <!-- rest of the normal codegen configuration options -->
+ </configuraion>
+ <dependencies>
+ <dependency>
+ <groupId>com.sun.xml.bind</groupId>
+ <artifactId>jaxb-impl</artifactId>
+ <version>2.2</version>
+ </dependency>
+ <dependency>
+ <groupId>com.sun.xml.bind</groupId>
+ <artifactId>jaxb-xjc</artifactId>
+ <version>2.2</version>
+ </dependency>
+ </dependencies>
+</plugin>
-</pre>
+]]></script>
</div></div>
Modified: websites/production/cxf/content/docs/maven-java2ws-plugin.html
==============================================================================
--- websites/production/cxf/content/docs/maven-java2ws-plugin.html (original)
+++ websites/production/cxf/content/docs/maven-java2ws-plugin.html Mon Jun 24 17:10:51 2013
@@ -25,6 +25,18 @@
<meta http-equiv="Content-type" content="text/html;charset=UTF-8">
<meta name="keywords" content="business integration, EAI, SOA, Service Oriented Architecture, web services, SOAP, JBI, JMS, WSDL, XML, EDI, Electronic Data Interchange, standards support, integration standards, application integration, middleware, software, solutions, services, CXF, open source">
<meta name="description" content="Apache CXF, Services Framework - Maven Java2WS plugin">
+
+ <link href='http://cxf.apache.org/resources/highlighter/styles/shCore.css' rel='stylesheet' type='text/css' />
+ <link href='http://cxf.apache.org/resources/highlighter/styles/shThemeCXF.css' rel='stylesheet' type='text/css' />
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shCore.js' type='text/javascript'></script>
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shBrushXml.js' type='text/javascript'></script>
+
+ <script type="text/javascript">
+ SyntaxHighlighter.defaults['toolbar'] = false;
+ SyntaxHighlighter.all();
+ </script>
+
<title>
Apache CXF -- Maven Java2WS plugin
</title>
@@ -42,19 +54,15 @@ Apache CXF -- Maven Java2WS plugin
<td id="cell-1-0"> </td>
<td id="cell-1-1"> </td>
<td id="cell-1-2">
- <div style="padding: 5px;">
- <div id="banner">
- <!-- Banner -->
-<div id="banner-content">
+ <!-- Banner -->
+<div class="banner" id="banner"><p>
<table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td align="left" colspan="1" nowrap>
<a shape="rect" href="http://cxf.apache.org/" title="Apache CXF"><span style="font-weight: bold; font-size: 170%; color: white">Apache CXF</span></a>
</td><td align="right" colspan="1" nowrap>
<a shape="rect" href="http://www.apache.org/" title="The Apache Sofware Foundation"><img border="0" alt="ASF Logo" src="http://cxf.apache.org/images/asf-logo.png"></a>
</td></tr></table>
-</div>
- <!-- Banner -->
- </div>
- </div>
+</p></div>
+ <!-- Banner -->
<div id="top-menu">
<table border="0" cellpadding="1" cellspacing="0" width="100%">
<tr>
@@ -94,7 +102,7 @@ Apache CXF -- Maven Java2WS plugin
<hr>
-<ul class="alternate" type="square"><li>Search
+<ul class="alternate" type="square"><li>Search<br clear="none">
<form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
<div>
@@ -124,71 +132,71 @@ Apache CXF -- Maven Java2WS plugin
<div id="ConfluenceContent"><p>This plugin can generate WSDL, server side code used to start web service and client side code from a java class.<br clear="none">
Here is a simple example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><plugin></span>
- <span class="code-tag"><groupId></span>org.apache.cxf<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>cxf-java2ws-plugin<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>${cxf.version}<span class="code-tag"></version></span>
- <span class="code-tag"><dependencies></span>
- <span class="code-tag"><dependency></span>
- <span class="code-tag"><groupId></span>org.apache.cxf<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>cxf-rt-frontend-jaxws<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>${cxf.version}<span class="code-tag"></version></span>
- <span class="code-tag"></dependency></span>
- <span class="code-tag"><dependency></span>
- <span class="code-tag"><groupId></span>org.apache.cxf<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>cxf-rt-frontend-simple<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>${cxf.version}<span class="code-tag"></version></span>
- <span class="code-tag"></dependency></span>
- <span class="code-tag"></dependencies></span>
-
- <span class="code-tag"><executions></span>
- <span class="code-tag"><execution></span>
- <span class="code-tag"><id></span>process-classes<span class="code-tag"></id></span>
- <span class="code-tag"><phase></span>process-classes<span class="code-tag"></phase></span>
- <span class="code-tag"><configuration></span>
- <span class="code-tag"><className></span>org.apache.hello_world.Greeter<span class="code-tag"></className></span>
- <span class="code-tag"><genWsdl></span>true<span class="code-tag"></genWsdl></span>
- <span class="code-tag"><verbose></span>true<span class="code-tag"></verbose></span>
- <span class="code-tag"></configuration></span>
- <span class="code-tag"><goals></span>
- <span class="code-tag"><goal></span>java2ws<span class="code-tag"></goal></span>
- <span class="code-tag"></goals></span>
- <span class="code-tag"></execution></span>
- <span class="code-tag"></executions></span>
-<span class="code-tag"></plugin></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<plugin>
+ <groupId>org.apache.cxf</groupId>
+ <artifactId>cxf-java2ws-plugin</artifactId>
+ <version>${cxf.version}</version>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.cxf</groupId>
+ <artifactId>cxf-rt-frontend-jaxws</artifactId>
+ <version>${cxf.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.cxf</groupId>
+ <artifactId>cxf-rt-frontend-simple</artifactId>
+ <version>${cxf.version}</version>
+ </dependency>
+ </dependencies>
+
+ <executions>
+ <execution>
+ <id>process-classes</id>
+ <phase>process-classes</phase>
+ <configuration>
+ <className>org.apache.hello_world.Greeter</className>
+ <genWsdl>true</genWsdl>
+ <verbose>true</verbose>
+ </configuration>
+ <goals>
+ <goal>java2ws</goal>
+ </goals>
+ </execution>
+ </executions>
+</plugin>
+]]></script>
</div></div>
<p>Here are the options you can use and their defaults:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
<configuration>
<className>...</className>
<classpath>...</classpath>
<outputFile>...</outputFile>
- <genWsdl><span class="code-keyword">true</span></genWsdl>
- <genServer><span class="code-keyword">false</span></genServer>
- <genClient><span class="code-keyword">false</span></genClient>
- <genWrapperbean><span class="code-keyword">false</span></genWrapperbean>
+ <genWsdl>true</genWsdl>
+ <genServer>false</genServer>
+ <genClient>false</genClient>
+ <genWrapperbean>false</genWrapperbean>
<frontend>jaxws</frontend>
<databinding>jaxb</databinding>
<serviceName>...</serviceName>
- <soap12><span class="code-keyword">false</span></soap12>
+ <soap12>false</soap12>
<targetNameSpace>...</targetNameSpace>
- <verbose><span class="code-keyword">false</span></verbose>
- <quiet><span class="code-keyword">false</span></quiet>
- <attachWsdl><span class="code-keyword">false</span></attachWsdl>
+ <verbose>false</verbose>
+ <quiet>false</quiet>
+ <attachWsdl>false</attachWsdl>
<address>...</address>
</configuration>
-</pre>
+]]></script>
</div></div>
<p>For detailed descriptions of the configuration elements see <a shape="rect" href="java-to-ws.html" title="Java to WS">Java to WS</a> page.</p>
<p>The outputFile value by default will be:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
${project.build.directory}/generated/wsdl/${className}.wsdl
-</pre>
+]]></script>
</div></div></div>
</div>
<!-- Content -->
Modified: websites/production/cxf/content/docs/maven-java2wsdl-plugin-cxf-20x-only-removed-in-21-and-replaced-with-java2ws.html
==============================================================================
--- websites/production/cxf/content/docs/maven-java2wsdl-plugin-cxf-20x-only-removed-in-21-and-replaced-with-java2ws.html (original)
+++ websites/production/cxf/content/docs/maven-java2wsdl-plugin-cxf-20x-only-removed-in-21-and-replaced-with-java2ws.html Mon Jun 24 17:10:51 2013
@@ -25,6 +25,18 @@
<meta http-equiv="Content-type" content="text/html;charset=UTF-8">
<meta name="keywords" content="business integration, EAI, SOA, Service Oriented Architecture, web services, SOAP, JBI, JMS, WSDL, XML, EDI, Electronic Data Interchange, standards support, integration standards, application integration, middleware, software, solutions, services, CXF, open source">
<meta name="description" content="Apache CXF, Services Framework - Maven Java2WSDL plugin (CXF 2.0.x only. Removed in 2.1 and replaced with Java2WS)">
+
+ <link href='http://cxf.apache.org/resources/highlighter/styles/shCore.css' rel='stylesheet' type='text/css' />
+ <link href='http://cxf.apache.org/resources/highlighter/styles/shThemeCXF.css' rel='stylesheet' type='text/css' />
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shCore.js' type='text/javascript'></script>
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shBrushXml.js' type='text/javascript'></script>
+
+ <script type="text/javascript">
+ SyntaxHighlighter.defaults['toolbar'] = false;
+ SyntaxHighlighter.all();
+ </script>
+
<title>
Apache CXF -- Maven Java2WSDL plugin (CXF 2.0.x only. Removed in 2.1 and replaced with Java2WS)
</title>
@@ -42,19 +54,15 @@ Apache CXF -- Maven Java2WSDL plugin (CX
<td id="cell-1-0"> </td>
<td id="cell-1-1"> </td>
<td id="cell-1-2">
- <div style="padding: 5px;">
- <div id="banner">
- <!-- Banner -->
-<div id="banner-content">
+ <!-- Banner -->
+<div class="banner" id="banner"><p>
<table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td align="left" colspan="1" nowrap>
<a shape="rect" href="http://cxf.apache.org/" title="Apache CXF"><span style="font-weight: bold; font-size: 170%; color: white">Apache CXF</span></a>
</td><td align="right" colspan="1" nowrap>
<a shape="rect" href="http://www.apache.org/" title="The Apache Sofware Foundation"><img border="0" alt="ASF Logo" src="http://cxf.apache.org/images/asf-logo.png"></a>
</td></tr></table>
-</div>
- <!-- Banner -->
- </div>
- </div>
+</p></div>
+ <!-- Banner -->
<div id="top-menu">
<table border="0" cellpadding="1" cellspacing="0" width="100%">
<tr>
@@ -94,7 +102,7 @@ Apache CXF -- Maven Java2WSDL plugin (CX
<hr>
-<ul class="alternate" type="square"><li>Search
+<ul class="alternate" type="square"><li>Search<br clear="none">
<form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
<div>
@@ -123,36 +131,36 @@ Apache CXF -- Maven Java2WSDL plugin (CX
<div class="wiki-content">
<div id="ConfluenceContent"><p>CXF also includes a Maven plugin which can generate WSDL from Java code. Here is a simple example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><plugin></span>
- <span class="code-tag"><groupId></span>org.apache.cxf<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>cxf-codegen-plugin<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>2.0.9<span class="code-tag"></version></span>
- <span class="code-tag"><dependencies></span>
- <span class="code-tag"><dependency></span>
- <span class="code-tag"><groupId></span>org.apache.cxf<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>cxf-rt-frontend-jaxws<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>2.0.9<span class="code-tag"></version></span>
- <span class="code-tag"></dependency></span>
- <span class="code-tag"></dependencies></span>
- <span class="code-tag"><executions></span>
- <span class="code-tag"><execution></span>
- <span class="code-tag"><id></span>generate-wsdl<span class="code-tag"></id></span>
- <span class="code-tag"><phase></span>process-classes<span class="code-tag"></phase></span>
- <span class="code-tag"><configuration></span>
- <span class="code-tag"><className></span>org.example.MyService<span class="code-tag"></className></span>
- <span class="code-tag"></configuration></span>
- <span class="code-tag"><goals></span>
- <span class="code-tag"><goal></span>java2wsdl<span class="code-tag"></goal></span>
- <span class="code-tag"></goals></span>
- <span class="code-tag"></execution></span>
- <span class="code-tag"></executions></span>
-<span class="code-tag"></plugin></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<plugin>
+ <groupId>org.apache.cxf</groupId>
+ <artifactId>cxf-codegen-plugin</artifactId>
+ <version>2.0.9</version>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.cxf</groupId>
+ <artifactId>cxf-rt-frontend-jaxws</artifactId>
+ <version>2.0.9</version>
+ </dependency>
+ </dependencies>
+ <executions>
+ <execution>
+ <id>generate-wsdl</id>
+ <phase>process-classes</phase>
+ <configuration>
+ <className>org.example.MyService</className>
+ </configuration>
+ <goals>
+ <goal>java2wsdl</goal>
+ </goals>
+ </execution>
+ </executions>
+</plugin>
+]]></script>
</div></div>
<p>Here are the options you can use:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
<configuration>
<className>...</className>
<classpath>...</classpath>
@@ -163,7 +171,7 @@ Apache CXF -- Maven Java2WSDL plugin (CX
<verbose>...</verbose>
<quiet>...</quiet>
</configuration>
-</pre>
+]]></script>
</div></div></div>
</div>
<!-- Content -->
Modified: websites/production/cxf/content/docs/migration-guides.html
==============================================================================
--- websites/production/cxf/content/docs/migration-guides.html (original)
+++ websites/production/cxf/content/docs/migration-guides.html Mon Jun 24 17:10:51 2013
@@ -25,6 +25,8 @@
<meta http-equiv="Content-type" content="text/html;charset=UTF-8">
<meta name="keywords" content="business integration, EAI, SOA, Service Oriented Architecture, web services, SOAP, JBI, JMS, WSDL, XML, EDI, Electronic Data Interchange, standards support, integration standards, application integration, middleware, software, solutions, services, CXF, open source">
<meta name="description" content="Apache CXF, Services Framework - Migration Guides">
+
+
<title>
Apache CXF -- Migration Guides
</title>
@@ -42,19 +44,15 @@ Apache CXF -- Migration Guides
<td id="cell-1-0"> </td>
<td id="cell-1-1"> </td>
<td id="cell-1-2">
- <div style="padding: 5px;">
- <div id="banner">
- <!-- Banner -->
-<div id="banner-content">
+ <!-- Banner -->
+<div class="banner" id="banner"><p>
<table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td align="left" colspan="1" nowrap>
<a shape="rect" href="http://cxf.apache.org/" title="Apache CXF"><span style="font-weight: bold; font-size: 170%; color: white">Apache CXF</span></a>
</td><td align="right" colspan="1" nowrap>
<a shape="rect" href="http://www.apache.org/" title="The Apache Sofware Foundation"><img border="0" alt="ASF Logo" src="http://cxf.apache.org/images/asf-logo.png"></a>
</td></tr></table>
-</div>
- <!-- Banner -->
- </div>
- </div>
+</p></div>
+ <!-- Banner -->
<div id="top-menu">
<table border="0" cellpadding="1" cellspacing="0" width="100%">
<tr>
@@ -94,7 +92,7 @@ Apache CXF -- Migration Guides
<hr>
-<ul class="alternate" type="square"><li>Search
+<ul class="alternate" type="square"><li>Search<br clear="none">
<form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
<div>
Modified: websites/production/cxf/content/docs/mtom-attachments-with-jaxb.html
==============================================================================
--- websites/production/cxf/content/docs/mtom-attachments-with-jaxb.html (original)
+++ websites/production/cxf/content/docs/mtom-attachments-with-jaxb.html Mon Jun 24 17:10:51 2013
@@ -25,6 +25,18 @@
<meta http-equiv="Content-type" content="text/html;charset=UTF-8">
<meta name="keywords" content="business integration, EAI, SOA, Service Oriented Architecture, web services, SOAP, JBI, JMS, WSDL, XML, EDI, Electronic Data Interchange, standards support, integration standards, application integration, middleware, software, solutions, services, CXF, open source">
<meta name="description" content="Apache CXF, Services Framework - MTOM Attachments with JAXB">
+
+ <link href='http://cxf.apache.org/resources/highlighter/styles/shCore.css' rel='stylesheet' type='text/css' />
+ <link href='http://cxf.apache.org/resources/highlighter/styles/shThemeCXF.css' rel='stylesheet' type='text/css' />
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shCore.js' type='text/javascript'></script>
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shBrushXml.js' type='text/javascript'></script>
+
+ <script type="text/javascript">
+ SyntaxHighlighter.defaults['toolbar'] = false;
+ SyntaxHighlighter.all();
+ </script>
+
<title>
Apache CXF -- MTOM Attachments with JAXB
</title>
@@ -42,19 +54,15 @@ Apache CXF -- MTOM Attachments with JAXB
<td id="cell-1-0"> </td>
<td id="cell-1-1"> </td>
<td id="cell-1-2">
- <div style="padding: 5px;">
- <div id="banner">
- <!-- Banner -->
-<div id="banner-content">
+ <!-- Banner -->
+<div class="banner" id="banner"><p>
<table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td align="left" colspan="1" nowrap>
<a shape="rect" href="http://cxf.apache.org/" title="Apache CXF"><span style="font-weight: bold; font-size: 170%; color: white">Apache CXF</span></a>
</td><td align="right" colspan="1" nowrap>
<a shape="rect" href="http://www.apache.org/" title="The Apache Sofware Foundation"><img border="0" alt="ASF Logo" src="http://cxf.apache.org/images/asf-logo.png"></a>
</td></tr></table>
-</div>
- <!-- Banner -->
- </div>
- </div>
+</p></div>
+ <!-- Banner -->
<div id="top-menu">
<table border="0" cellpadding="1" cellspacing="0" width="100%">
<tr>
@@ -94,7 +102,7 @@ Apache CXF -- MTOM Attachments with JAXB
<hr>
-<ul class="alternate" type="square"><li>Search
+<ul class="alternate" type="square"><li>Search<br clear="none">
<form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
<div>
@@ -134,59 +142,59 @@ Apache CXF -- MTOM Attachments with JAXB
<h2><a shape="rect" name="MTOMAttachmentswithJAXB-1a%29ModifyingyourschemaforMTOM"></a>1a) Modifying your schema for MTOM</h2>
<p>Lets say we have a Picture schema type like this:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<schema targetNamespace=<span class="code-quote">"http://pictures.com"</span>
- <span class="code-keyword">xmlns:xsd</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema"</span>>
- <span class="code-tag"><element name=<span class="code-quote">"Picture"</span>></span>
- <span class="code-tag"><complexType></span>
- <span class="code-tag"><sequence></span>
- <span class="code-tag"><element name=<span class="code-quote">"Title"</span> type=<span class="code-quote">"xsd:string"</span>/></span>
- <span class="code-tag"><element name=<span class="code-quote">"ImageData"</span> type=<span class="code-quote">"xsd:base64Binary"</span>/></span>
- <span class="code-tag"></sequence></span>
- <span class="code-tag"></complexType></span>
- <span class="code-tag"></element></span>
-<span class="code-tag"></schema></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<schema targetNamespace="http://pictures.com"
+ xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+ <element name="Picture">
+ <complexType>
+ <sequence>
+ <element name="Title" type="xsd:string"/>
+ <element name="ImageData" type="xsd:base64Binary"/>
+ </sequence>
+ </complexType>
+ </element>
+</schema>
+]]></script>
</div></div>
<p>In this case the ImageData element is something we would like to have transferred as an attachment. To do this we just need to add an xmime:expectedContentTypes annotation:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<schema targetNamespace=<span class="code-quote">"http://pictures.com"</span>
- <span class="code-keyword">xmlns:xsd</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema"</span>
- <span class="code-keyword">xmlns:xmime</span>=<span class="code-quote">"http://www.w3.org/2005/05/xmlmime"</span>>
- <span class="code-tag"><element name=<span class="code-quote">"Picture"</span>></span>
- <span class="code-tag"><complexType></span>
- <span class="code-tag"><sequence></span>
- <span class="code-tag"><element name=<span class="code-quote">"Title"</span> type=<span class="code-quote">"xsd:string"</span>/></span>
- <element name=<span class="code-quote">"ImageData"</span> type=<span class="code-quote">"xsd:base64Binary"</span>
- xmime:expectedContentTypes=<span class="code-quote">"application/octet-stream"</span>/>
- <span class="code-tag"></sequence></span>
- <span class="code-tag"></complexType></span>
- <span class="code-tag"></element></span>
-<span class="code-tag"></schema></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<schema targetNamespace="http://pictures.com"
+ xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+ xmlns:xmime="http://www.w3.org/2005/05/xmlmime">
+ <element name="Picture">
+ <complexType>
+ <sequence>
+ <element name="Title" type="xsd:string"/>
+ <element name="ImageData" type="xsd:base64Binary"
+ xmime:expectedContentTypes="application/octet-stream"/>
+ </sequence>
+ </complexType>
+ </element>
+</schema>
+]]></script>
</div></div>
<p>This tells JAXB (which WSDL2Java uses to generate POJOs for your service) that this field could be of any content type. Instead of creating a byte[] array for the base64Binary element, it will create a DataHandler instead which can be used to stream the data.</p>
<h2><a shape="rect" name="MTOMAttachmentswithJAXB-1b%29AnnotationyourJAXBbeanstoenableMTOM"></a>1b) Annotation your JAXB beans to enable MTOM</h2>
<p>If you're doing code first, you need to add an annotation to your POJO to tell JAXB that the field is a candidate for MTOM optimization. Lets say we have a Picture class with has Title and ImageData fields, then it might look like this:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
@XmlType
-<span class="code-keyword">public</span> class Picture {
- <span class="code-keyword">private</span> <span class="code-object">String</span> title;
+public class Picture {
+ private String title;
- @XmlMimeType(<span class="code-quote">"application/octet-stream"</span>)
- <span class="code-keyword">private</span> DataHandler imageData;
+ @XmlMimeType("application/octet-stream")
+ private DataHandler imageData;
- <span class="code-keyword">public</span> <span class="code-object">String</span> getTitle() { <span class="code-keyword">return</span> title; }
- <span class="code-keyword">public</span> void setTitle(<span class="code-object">String</span> title) { <span class="code-keyword">this</span>.title = title; }
+ public String getTitle() { return title; }
+ public void setTitle(String title) { this.title = title; }
- <span class="code-keyword">public</span> DataHandler getImageData() { <span class="code-keyword">return</span> imageData; }
- <span class="code-keyword">public</span> void setImageData(DataHandler imageData) {
- <span class="code-keyword">this</span>.imageData = imageData; }
+ public DataHandler getImageData() { return imageData; }
+ public void setImageData(DataHandler imageData) {
+ this.imageData = imageData; }
}
-</pre>
+]]></script>
</div></div>
<p>Note the use of 'application/octet-stream'. According to the standard, you should be able to use any MIME type you like, in order to specify the actual content of the attachment. However, due to a defect in the JAX-B reference implementation, this won't work. </p>
@@ -194,23 +202,23 @@ Apache CXF -- MTOM Attachments with JAXB
<h1><a shape="rect" name="MTOMAttachmentswithJAXB-2%29EnableMTOMonyourservice"></a>2) Enable MTOM on your service</h1>
<p>If you've used JAX-WS to publish your endpoint you can enable MTOM like so:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">import</span> javax.xml.ws.Endpoint;
-<span class="code-keyword">import</span> javax.xml.ws.soap.SOAPBinding;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+import javax.xml.ws.Endpoint;
+import javax.xml.ws.soap.SOAPBinding;
-Endpoint ep = Endpoint.publish(<span class="code-quote">"http:<span class="code-comment">//localhost/myService"</span>,
-</span> <span class="code-keyword">new</span> MyService());
+Endpoint ep = Endpoint.publish("http://localhost/myService",
+ new MyService());
SOAPBinding binding = (SOAPBinding) ep.getBinding();
-binding.setMTOMEnabled(<span class="code-keyword">true</span>);
-</pre>
+binding.setMTOMEnabled(true);
+]]></script>
</div></div>
<p>Or, if you used XML to publish your endpoint:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<beans xmlns=<span class="code-quote">"http://www.springframework.org/schema/beans"</span>
- <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span>
- <span class="code-keyword">xmlns:jaxws</span>=<span class="code-quote">"http://cxf.apache.org/jaxws"</span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<beans xmlns="http://www.springframework.org/schema/beans"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns:jaxws="http://cxf.apache.org/jaxws"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
@@ -218,44 +226,44 @@ binding.setMTOMEnabled(<span class="code
http://cxf.apache.org/schema/jaxws.xsd">
<jaxws:endpoint
- id=<span class="code-quote">"helloWorld"</span>
- implementor=<span class="code-quote">"demo.spring.HelloWorldImpl"</span>
- address=<span class="code-quote">"http://localhost/HelloWorld"</span>>
- <span class="code-tag"><jaxws:properties></span>
- <span class="code-tag"><entry key=<span class="code-quote">"mtom-enabled"</span> value=<span class="code-quote">"true"</span>/></span>
- <span class="code-tag"></jaxws:properties></span>
- <span class="code-tag"></jaxws:endpoint></span>
+ id="helloWorld"
+ implementor="demo.spring.HelloWorldImpl"
+ address="http://localhost/HelloWorld">
+ <jaxws:properties>
+ <entry key="mtom-enabled" value="true"/>
+ </jaxws:properties>
+ </jaxws:endpoint>
-<span class="code-tag"></beans></span>
-</pre>
+</beans>
+]]></script>
</div></div>
<p>If you're using the simple frontend you can set the mtom-enabled property on your ServerFactoryBean or ClientProxyFactoryBean:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-Map<<span class="code-object">String</span>,<span class="code-object">Object</span>> props = <span class="code-keyword">new</span> HashMap<<span class="code-object">String</span>, <span class="code-object">Object</span>>();
-<span class="code-comment">// <span class="code-object">Boolean</span>.TRUE or <span class="code-quote">"<span class="code-keyword">true</span>"</span> will work as the property value below
-</span>props.put(<span class="code-quote">"mtom-enabled"</span>, <span class="code-object">Boolean</span>.TRUE);
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+Map<String,Object> props = new HashMap<String, Object>();
+// Boolean.TRUE or "true" will work as the property value below
+props.put("mtom-enabled", Boolean.TRUE);
-ClientProxyFactoryBean pf = <span class="code-keyword">new</span> ClientProxyFactoryBean();
+ClientProxyFactoryBean pf = new ClientProxyFactoryBean();
pf.setPropertyies(props);
....
YourClient client = (YourClient) pf.create();
-ServerFactoryBean sf = <span class="code-keyword">new</span> ServerFactoryBean();
+ServerFactoryBean sf = new ServerFactoryBean();
sf.setPropertyies(props);
...
sf.create();
-</pre>
+]]></script>
</div></div>
<p>Similarly, you can use the XML configuration:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<beans xmlns=<span class="code-quote">"http://www.springframework.org/schema/beans"</span>
- <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span>
- <span class="code-keyword">xmlns:simple</span>=<span class="code-quote">"http://cxf.apache.org/simple"</span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<beans xmlns="http://www.springframework.org/schema/beans"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns:simple="http://cxf.apache.org/simple"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
@@ -263,47 +271,47 @@ http://cxf.apache.org/simple
http://cxf.apache.org/schema/simple.xsd">
<simple:server
- id=<span class="code-quote">"helloWorld"</span>
- serviceClass=<span class="code-quote">"demo.spring.HelloWorldImpl"</span>
- address=<span class="code-quote">"http://localhost/HelloWorld"</span>>
- <span class="code-tag"><simple:properties></span>
- <span class="code-tag"><entry key=<span class="code-quote">"mtom-enabled"</span> value=<span class="code-quote">"true"</span>/></span>
- <span class="code-tag"></simple:properties></span>
- <span class="code-tag"></simple:server></span>
+ id="helloWorld"
+ serviceClass="demo.spring.HelloWorldImpl"
+ address="http://localhost/HelloWorld">
+ <simple:properties>
+ <entry key="mtom-enabled" value="true"/>
+ </simple:properties>
+ </simple:server>
<simple:client
- id=<span class="code-quote">"helloWorldClient"</span>
- serviceClass=<span class="code-quote">"demo.spring.HelloWorldImpl"</span>
- address=<span class="code-quote">"http://localhost/HelloWorld"</span>>
- <span class="code-tag"><simple:properties></span>
- <span class="code-tag"><entry key=<span class="code-quote">"mtom-enabled"</span> value=<span class="code-quote">"true"</span>/></span>
- <span class="code-tag"></simple:properties></span>
- <span class="code-tag"></simple:client></span>
+ id="helloWorldClient"
+ serviceClass="demo.spring.HelloWorldImpl"
+ address="http://localhost/HelloWorld">
+ <simple:properties>
+ <entry key="mtom-enabled" value="true"/>
+ </simple:properties>
+ </simple:client>
-<span class="code-tag"></beans></span>
-</pre>
+</beans>
+]]></script>
</div></div>
<h1><a shape="rect" name="MTOMAttachmentswithJAXB-UsingDataHandlers"></a>Using DataHandlers</h1>
<p>Once you've got the above done, its time to start writing your logic. DataHandlers are easy to use and create. To consume a DataHandler:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
Picture picture = ...;
DataHandler handler = picture.getImageData();
InputStream is = handler.getInputStream();
-</pre>
+]]></script>
</div></div>
<p>There are many ways to create DataHandlers. You can use a FileDataSource, ByteArrayDataSource, or write your own DataSource:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-DataSource source = <span class="code-keyword">new</span> ByteArrayDataSource(<span class="code-keyword">new</span> <span class="code-object">byte</span>[] {...},
- <span class="code-quote">"content/type"</span>);
-DataSource source = <span class="code-keyword">new</span> FileDataSource(<span class="code-keyword">new</span> File(<span class="code-quote">"my/file"</span>));
-
-Picture picture = <span class="code-keyword">new</span> Picture();
-picture.setImageData(<span class="code-keyword">new</span> DataHandler(source));
-</pre>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+DataSource source = new ByteArrayDataSource(new byte[] {...},
+ "content/type");
+DataSource source = new FileDataSource(new File("my/file"));
+
+Picture picture = new Picture();
+picture.setImageData(new DataHandler(source));
+]]></script>
</div></div></div>
</div>
<!-- Content -->