You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by bu...@apache.org on 2019/04/01 14:56:53 UTC
svn commit: r1042977 - in /websites/production/cxf/content:
cache/docs.pageCache docs/maven-cxf-codegen-plugin-wsdl-to-java.html
Author: buildbot
Date: Mon Apr 1 14:56:53 2019
New Revision: 1042977
Log:
Production update by buildbot for cxf
Modified:
websites/production/cxf/content/cache/docs.pageCache
websites/production/cxf/content/docs/maven-cxf-codegen-plugin-wsdl-to-java.html
Modified: websites/production/cxf/content/cache/docs.pageCache
==============================================================================
Binary files - no diff available.
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 Apr 1 14:56:53 2019
@@ -32,7 +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/shBrushXml.js'></script>
+<script src='/resources/highlighter/scripts/shBrushBash.js'></script>
<script>
SyntaxHighlighter.defaults['toolbar'] = false;
SyntaxHighlighter.all();
@@ -116,7 +118,14 @@ Apache CXF -- Maven cxf-codegen-plugin (
<td height="100%">
<!-- Content -->
<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 pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div id="ConfluenceContent"><p><style type="text/css">/*<![CDATA[*/
+div.rbtoc1554130573955 {padding: 0px;}
+div.rbtoc1554130573955 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1554130573955 li {margin-left: 0px;padding-left: 0px;}
+
+/*]]>*/</style></p><div class="toc-macro rbtoc1554130573955">
+<ul class="toc-indentation"><li><a shape="rect" href="#Mavencxf-codegen-plugin(WSDLtoJava)-Introduction">Introduction</a></li><li><a shape="rect" href="#Mavencxf-codegen-plugin(WSDLtoJava)-Example1:PassinginaJAX-WSBindingfile">Example 1: Passing in a JAX-WS Binding file</a></li><li><a shape="rect" href="#Mavencxf-codegen-plugin(WSDLtoJava)-Example2:Specifythedatabinding">Example 2: Specify the data binding</a></li><li><a shape="rect" href="#Mavencxf-codegen-plugin(WSDLtoJava)-Example3:Specifyingaservicetogenerateartifactsfor">Example 3: Specifying a service to generate artifacts for</a></li><li><a shape="rect" href="#Mavencxf-codegen-plugin(WSDLtoJava)-Example4:UsingdefaultOptiontoavoidrepetition">Example 4: Using defaultOption to avoid repetition</a></li><li><a shape="rect" href="#Mavencxf-codegen-plugin(WSDLtoJava)-Example5:UsingwsdlRootwithincludes/excludespatterns">Example 5: Using wsdlRoot with includes/excludes patterns</a></li><li><a shape="rect" href="#Mavencxf-codegen-plugi
n(WSDLtoJava)-Example6:Loadingawsdlfromthemavenrepository">Example 6: Loading a wsdl from the maven repository</a></li><li><a shape="rect" href="#Mavencxf-codegen-plugin(WSDLtoJava)-Example7:Usingxjcextensions">Example 7: Using xjc extensions</a></li><li><a shape="rect" href="#Mavencxf-codegen-plugin(WSDLtoJava)-Example8-UsingJAXB/JAX-WS2.2withJava6">Example 8 - Using JAXB/JAX-WS 2.2 with Java 6</a></li><li><a shape="rect" href="#Mavencxf-codegen-plugin(WSDLtoJava)-ReadingexternalDTDs">Reading external DTDs</a></li><li><a shape="rect" href="#Mavencxf-codegen-plugin(WSDLtoJava)-Otherconfigurationoptions">Other configuration options</a></li></ul>
+</div><h3 id="Mavencxf-codegen-plugin(WSDLtoJava)-Introduction">Introduction</h3><p>CXF includes a Maven plugin which can generate java artifacts from WSDL. Here is a simple example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="brush: xml; gutter: false; theme: Default"><plugin>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-codegen-plugin</artifactId>
@@ -239,7 +248,7 @@ Apache CXF -- Maven cxf-codegen-plugin (
</wsdlOptions>
</configuration>
</pre>
-</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><h3 id="Mavencxf-codegen-plugin(WSDLtoJava)-Example7:Usingxjcextensions">Example 7: Using xjc extensions</h3><p>Standard JAXB command-line customizations can be added via <extraarg> elements, either one per line or comma separated. <a shape="rect" href="../xjc-utils.html">CXF also offers some JAXB extensions for the code generation</a>. They have to be added as dependencies and then activated by using an extraarg with content -xjc-X<extension id></p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>artifact id</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>description</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>extension id</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>cxf-xjc-boolean</p></td><td colspan="1
" rowspan="1" class="confluenceTd"><p>Adds getters for booleans</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>boolean</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>cxf-xjc-bug671</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Workaroung for JAXB bug 671</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>bug671</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>cxf-xjc-dv</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Default value support</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>dv</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>cxf-xjc-ts</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Adds toString to objects</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>ts</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>cxf-xjc-wsdlextension</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>WsdlExtension support<
/p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>wsdlextension</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>jaxb-fluent-api</p><p>(<img class="emoticon emoticon-warning" src="https://cwiki.apache.org/confluence/s/en_GB/7701/d7b403a44466e5e8970db7530201039d865e79e1/_/images/icons/emoticons/warning.svg" data-emoticon-name="warning" alt="(warning)"> not part of CXF:</p><p>group id is net.java.dev.jaxb2-commons)</p></td><td colspan="1" rowspan="1" class="confluenceTd">Fluent API for setters</td><td colspan="1" rowspan="1" class="confluenceTd">fluent-api</td></tr></tbody></table></div><p>An example showing attachment of a JAXB binding file and the CXF toString() extension is below:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</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><h3 id="Mavencxf-codegen-plugin(WSDLtoJava)-Example7:Usingxjcextensions">Example 7: Using xjc extensions</h3><p>Standard JAXB command-line customizations can be added via <extraarg> elements, either one per line or comma separated. <a shape="rect" href="../xjc-utils.html">CXF also offers some JAXB extensions for the code generation</a>. They have to be added as dependencies and then activated by using an extraarg with content -xjc-X<extension id></p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>artifact id</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>description</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>extension id</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>cxf-xjc-boolean</p></td><td colspan="1
" rowspan="1" class="confluenceTd"><p>Adds getters for booleans</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>boolean</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>cxf-xjc-bug671</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Workaroung for JAXB bug 671</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>bug671</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>cxf-xjc-dv</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Default value support</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>dv</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>cxf-xjc-ts</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Adds toString to objects</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>ts</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>cxf-xjc-wsdlextension</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>WsdlExtension support<
/p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>wsdlextension</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>jaxb-fluent-api</p><p>(<img class="emoticon emoticon-warning" title="(warning)" src="http://cwiki.apache.org/confluence/s/en_GB/7701/d7b403a44466e5e8970db7530201039d865e79e1/_/images/icons/emoticons/warning.svg" alt="(warning)" border="0"> not part of CXF:</p><p>group id is net.java.dev.jaxb2-commons)</p></td><td colspan="1" rowspan="1" class="confluenceTd">Fluent API for setters</td><td colspan="1" rowspan="1" class="confluenceTd">fluent-api</td></tr></tbody></table></div><p>An example showing attachment of a JAXB binding file and the CXF toString() extension is below:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="brush: xml; gutter: false; theme: Default"><plugin>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-codegen-plugin</artifactId>
@@ -358,7 +367,33 @@ Apache CXF -- Maven cxf-codegen-plugin (
</plugin>
</pre>
-</div></div><h3 id="Mavencxf-codegen-plugin(WSDLtoJava)-Otherconfigurationoptions">Other configuration options</h3><p>The cxf-codegen-plugin has some additional configuration options that may be useful:</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><fork>false/always/once</fork></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Forks a separate JVM for the code generation</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><additionalJvmArgs>....</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Additional JVM args set on the forked process if fork is not false</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><encoding>UTF-8</encoding></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>(new in 2.6.1, requires configuring plugin to use very latest JAXB 2.2.11 impl jars)</p></td></tr></tbody></table></div></div>
+</div></div><h3 id="Mavencxf-codegen-plugin(WSDLtoJava)-ReadingexternalDTDs">Reading external DTDs</h3><p>More recent versions of XML Schema will throw an exception by default if the schema has an external DTD. For example:</p><p>[Fatal Error] xmldsig-core-schema.xsd:10:5: External DTD: Failed to read external DTD 'XMLSchema.dtd', because 'http' access is not allowed due to restriction set by the accessExternalDTD property.</p><p>If you wish to allow external DTDs then it's possible to do this via the the <additionalJvmArgs>' configuration switch as follows:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default"><plugin>
+ <groupId>org.apache.cxf</groupId>
+ <artifactId>cxf-codegen-plugin</artifactId>
+ <version>${cxf.version}</version>
+ <executions>
+ <execution>
+ <phase>generate-sources</phase>
+ <configuration>
+ <fork>once</fork>
+ <wsdlOptions>
+ <wsdlOption>
+ <wsdl>${basedir}/src/main/resources/org/apache/cxf/wsn/wsdl/wsn.wsdl</wsdl>
+ <extraargs>
+ <extraarg>-verbose</extraarg>
+ </extraargs>
+ </wsdlOption>
+ </wsdlOptions>
+ <additionalJvmArgs>-Djavax.xml.accessExternalDTD=all</additionalJvmArgs>
+ </configuration>
+ <goals>
+ <goal>wsdl2java</goal>
+ </goals>
+ </execution>
+ </executions>
+</plugin></pre>
+</div></div><p><br clear="none"></p><h3 id="Mavencxf-codegen-plugin(WSDLtoJava)-Otherconfigurationoptions">Other configuration options</h3><p>The cxf-codegen-plugin has some additional configuration options that may be useful:</p><div class="table-wrap"><table class="confluenceTable"><colgroup span="1"><col span="1"><col span="1"></colgroup><tbody><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><fork>false/always/once</fork></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Forks a separate JVM for the code generation</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><additionalJvmArgs>....</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Additional JVM args set on the forked process if fork is not false</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><encoding>UTF-8</encoding></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>(new in 2.6.1, requires configuring plugin to use
very latest JAXB 2.2.11 impl jars)</p></td></tr></tbody></table></div></div>
</div>
<!-- Content -->
</td>