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 [13/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/debugging-and-logging.html
==============================================================================
--- websites/production/cxf/content/docs/debugging-and-logging.html (original)
+++ websites/production/cxf/content/docs/debugging-and-logging.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 - Debugging and Logging">
+
+ <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 -- Debugging and Logging
</title>
@@ -42,19 +54,15 @@ Apache CXF -- Debugging and Logging
<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 -- Debugging and Logging
<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>
@@ -139,68 +147,68 @@ Apache CXF -- Debugging and Logging
<p>For programmatic configuration, the logging interceptors can be added to your service endpoint as follows:</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> org.apache.cxf.interceptor.LoggingInInterceptor;
-<span class="code-keyword">import</span> org.apache.cxf.interceptor.LoggingOutInterceptor;
-<span class="code-keyword">import</span> org.apache.cxf.jaxws.EndpointImpl;
-
-<span class="code-object">Object</span> implementor = <span class="code-keyword">new</span> GreeterImpl();
-EndpointImpl ep = (EndpointImpl) Endpoint.publish(<span class="code-quote">"http:<span class="code-comment">//localhost/service"</span>, implementor);
-</span>
-ep.getServer().getEndpoint().getInInterceptors().add(<span class="code-keyword">new</span> LoggingInInterceptor());
-ep.getServer().getEndpoint().getOutInterceptors().add(<span class="code-keyword">new</span> LoggingOutInterceptor());
-</pre>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+import javax.xml.ws.Endpoint;
+import org.apache.cxf.interceptor.LoggingInInterceptor;
+import org.apache.cxf.interceptor.LoggingOutInterceptor;
+import org.apache.cxf.jaxws.EndpointImpl;
+
+Object implementor = new GreeterImpl();
+EndpointImpl ep = (EndpointImpl) Endpoint.publish("http://localhost/service", implementor);
+
+ep.getServer().getEndpoint().getInInterceptors().add(new LoggingInInterceptor());
+ep.getServer().getEndpoint().getOutInterceptors().add(new LoggingOutInterceptor());
+]]></script>
</div></div>
<p>For web services running on CXFServlet, the below annotations can be used on either the SEI or the SEI implementation class. If placed on the SEI, they activate logging both for client and server; if on the SEI implementation class, they are relevant just for server-side logging.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">import</span> org.apache.cxf.feature.Features;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+import org.apache.cxf.feature.Features;
-@javax.jws.WebService(portName = <span class="code-quote">"MyWebServicePort"</span>, serviceName = <span class="code-quote">"MyWebService"</span>, ...)
-@Features(features = <span class="code-quote">"org.apache.cxf.feature.LoggingFeature"</span>)
-<span class="code-keyword">public</span> class MyWebServicePortTypeImpl <span class="code-keyword">implements</span> MyWebServicePortType {
-</pre>
+@javax.jws.WebService(portName = "MyWebServicePort", serviceName = "MyWebService", ...)
+@Features(features = "org.apache.cxf.feature.LoggingFeature")
+public class MyWebServicePortTypeImpl implements MyWebServicePortType {
+]]></script>
</div></div>
<p>or (equivalent)</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">import</span> org.apache.cxf.interceptor.InInterceptors;
-<span class="code-keyword">import</span> org.apache.cxf.interceptor.OutInterceptors;
-
-@javax.jws.WebService(portName = <span class="code-quote">"WebServicePort"</span>, serviceName = <span class="code-quote">"WebServiceService"</span>, ...)
-@InInterceptors(interceptors = <span class="code-quote">"org.apache.cxf.interceptor.LoggingInInterceptor"</span>)
-@OutInterceptors(interceptors = <span class="code-quote">"org.apache.cxf.interceptor.LoggingOutInterceptor"</span>)
-<span class="code-keyword">public</span> class WebServicePortTypeImpl <span class="code-keyword">implements</span> WebServicePortType {
-</pre>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+import org.apache.cxf.interceptor.InInterceptors;
+import org.apache.cxf.interceptor.OutInterceptors;
+
+@javax.jws.WebService(portName = "WebServicePort", serviceName = "WebServiceService", ...)
+@InInterceptors(interceptors = "org.apache.cxf.interceptor.LoggingInInterceptor")
+@OutInterceptors(interceptors = "org.apache.cxf.interceptor.LoggingOutInterceptor")
+public class WebServicePortTypeImpl implements WebServicePortType {
+]]></script>
</div></div>
<p>For programmatic client-side logging, the following code snippet can be used as an example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">import</span> org.apache.cxf.endpoint.Client;
-<span class="code-keyword">import</span> org.apache.cxf.frontend.ClientProxy;
-<span class="code-keyword">import</span> org.apache.cxf.interceptor.LoggingInInterceptor;
-<span class="code-keyword">import</span> org.apache.cxf.interceptor.LoggingOutInterceptor;
-
-<span class="code-keyword">public</span> class WSClient {
- <span class="code-keyword">public</span> <span class="code-keyword">static</span> void main (<span class="code-object">String</span>[] args) {
- MyService ws = <span class="code-keyword">new</span> MyService();
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+import org.apache.cxf.endpoint.Client;
+import org.apache.cxf.frontend.ClientProxy;
+import org.apache.cxf.interceptor.LoggingInInterceptor;
+import org.apache.cxf.interceptor.LoggingOutInterceptor;
+
+public class WSClient {
+ public static void main (String[] args) {
+ MyService ws = new MyService();
MyPortType port = ws.getPort();
Client client = ClientProxy.getClient(port);
- client.getInInterceptors().add(<span class="code-keyword">new</span> LoggingInInterceptor());
- client.getOutInterceptors().add(<span class="code-keyword">new</span> LoggingOutInterceptor());
+ client.getInInterceptors().add(new LoggingInInterceptor());
+ client.getOutInterceptors().add(new LoggingOutInterceptor());
- <span class="code-comment">// make WS calls...</span>
-</pre>
+ // make WS calls...
+]]></script>
</div></div>
<h2><a shape="rect" name="DebuggingandLogging-Configurelogginglevels."></a>Configure logging levels. </h2>
@@ -208,28 +216,28 @@ ep.getServer().getEndpoint().getOutInter
<p>In the <a shape="rect" class="external-link" href="http://svn.apache.org/viewvc/cxf/trunk/distribution/src/main/release/etc/">/etc folder</a> of the CXF distribution there is a sample Java SE logging.properties file you can use to configure logging. For example, if you want to change the console logging level from WARNING to FINE, you need to update two properties in this logging.properties file as below:</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[
.level= FINE
java.util.logging.ConsoleHandler.level = FINE
-</pre>
+]]></script>
</div></div>
<p>Once this is done, you will need to set the <b>-Djava.util.logging.config.file</b> property to the location of the logging.properties file. As an example, the Ant target below has this property set:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><target name=<span class="code-quote">"runClient"</span>></span>
- <span class="code-tag"><java classname=<span class="code-quote">"client.WSClient"</span> fork=<span class="code-quote">"true"</span>></span>
- <span class="code-tag"><classpath></span>
- <span class="code-tag"><pathelement location=<span class="code-quote">"${build.classes.dir}"</span>/></span>
- <span class="code-tag"><fileset dir=<span class="code-quote">"${env.CXF_HOME}/lib"</span>></span>
- <span class="code-tag"><include name=<span class="code-quote">"*.jar"</span>/></span>
- <span class="code-tag"></fileset></span>
- <span class="code-tag"></classpath></span>
- <span class="code-tag"><jvmarg value=<span class="code-quote">"-Djava.util.logging.config.file=/usr/myclientapp/logging.properties"</span>/></span>
- <span class="code-tag"></java></span>
-<span class="code-tag"></target></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<target name="runClient">
+ <java classname="client.WSClient" fork="true">
+ <classpath>
+ <pathelement location="${build.classes.dir}"/>
+ <fileset dir="${env.CXF_HOME}/lib">
+ <include name="*.jar"/>
+ </fileset>
+ </classpath>
+ <jvmarg value="-Djava.util.logging.config.file=/usr/myclientapp/logging.properties"/>
+ </java>
+</target>
+]]></script>
</div></div>
<p>Alternatively, for SOAP clients, you can modify the Java-wide logging.properties file in the JDK_HOME/jre/lib folder, or for servlet-hosted web service providers, placing a logging.properties file in the WEB-INF/classes folder (see <a shape="rect" class="external-link" href="http://tomcat.apache.org/tomcat-6.0-doc/logging.html">here</a> for more details.)</p>
@@ -242,18 +250,18 @@ java.util.logging.ConsoleHandler.level =
<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[
-Dorg.apache.cxf.Logger=org.apache.cxf.common.logging.Log4jLogger
-</pre>
+]]></script>
</div></div>
<ul><li>Add the file <tt>META-INF/cxf/org.apache.cxf.Logger</tt> to the classpath and make sure it contains the following content:</li></ul>
<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[
org.apache.cxf.common.logging.Log4jLogger
-</pre>
+]]></script>
</div></div>
<h2><a shape="rect" name="DebuggingandLogging-UsingSLF4JInsteadofjava.util.logging%28since2.2.8%29"></a>Using SLF4J Instead of java.util.logging (since 2.2.8)</h2>
@@ -264,18 +272,18 @@ org.apache.cxf.common.logging.Log4jLogge
<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[
-Dorg.apache.cxf.Logger=org.apache.cxf.common.logging.Slf4jLogger
-</pre>
+]]></script>
</div></div>
<ul><li>Add the file <tt>META-INF/cxf/org.apache.cxf.Logger</tt> to the classpath and make sure it contains the following content:</li></ul>
<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[
org.apache.cxf.common.logging.Slf4jLogger
-</pre>
+]]></script>
</div></div>
@@ -316,33 +324,33 @@ org.apache.cxf.common.logging.Slf4jLogge
<h2><a shape="rect" name="DebuggingandLogging-Stacktraceinfaultdetails"></a>Stack trace in fault details</h2>
<p>CXF supports the ability to put server stack trace information into the fault message fault details, if you enable the option of 'faultStackTraceEnabled'. It is useful for debugging if the soap fault message is not defined in the WSDL operation.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<jaxws:endpoint id=<span class="code-quote">"server"</span> address=<span class="code-quote">"http:<span class="code-comment">//localhost:9002/TestMessage"</span>
-</span> wsdlURL=<span class="code-quote">"ship.wsdl"</span>
- endpointName=<span class="code-quote">"s:TestSoapEndpoint"</span>
- serviceName=<span class="code-quote">"s:TestService"</span>
- xmlns:s=<span class="code-quote">"http:<span class="code-comment">//test"</span> >
-</span> <jaxws:properties>
- <entry key=<span class="code-quote">"faultStackTraceEnabled"</span> value=<span class="code-quote">"<span class="code-keyword">true</span>"</span> />
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+<jaxws:endpoint id="server" address="http://localhost:9002/TestMessage"
+ wsdlURL="ship.wsdl"
+ endpointName="s:TestSoapEndpoint"
+ serviceName="s:TestService"
+ xmlns:s="http://test" >
+ <jaxws:properties>
+ <entry key="faultStackTraceEnabled" value="true" />
</jaxws:properties>
</jaxws:endpoint>
-</pre>
+]]></script>
</div></div>
<h2><a shape="rect" name="DebuggingandLogging-Showingthecauseexceptionmessage"></a>Showing the cause exception message</h2>
<p>CXF doesn't show the cause exception message in the fault message due to security consideration. However, this could potentially cause some trouble on the client side, as the client will not be able to see what the real cause of the exception is. You can let the CXF server return the fault message with the embedded cause exception message by enabling the option of 'exceptionMessageCauseEnabled' like this:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<jaxws:endpoint id=<span class="code-quote">"server"</span> address=<span class="code-quote">"http:<span class="code-comment">//localhost:9002/TestMessage"</span>
-</span> wsdlURL=<span class="code-quote">"ship.wsdl"</span>
- endpointName=<span class="code-quote">"s:TestSoapEndpoint"</span>
- serviceName=<span class="code-quote">"s:TestService"</span>
- xmlns:s=<span class="code-quote">"http:<span class="code-comment">//test"</span> >
-</span> <jaxws:properties>
- <entry key=<span class="code-quote">"exceptionMessageCauseEnabled"</span> value=<span class="code-quote">"<span class="code-keyword">true</span>"</span> />
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+<jaxws:endpoint id="server" address="http://localhost:9002/TestMessage"
+ wsdlURL="ship.wsdl"
+ endpointName="s:TestSoapEndpoint"
+ serviceName="s:TestService"
+ xmlns:s="http://test" >
+ <jaxws:properties>
+ <entry key="exceptionMessageCauseEnabled" value="true" />
</jaxws:properties>
</jaxws:endpoint>
-</pre>
+]]></script>
</div></div>
@@ -363,85 +371,85 @@ org.apache.cxf.common.logging.Slf4jLogge
<h3><a shape="rect" name="DebuggingandLogging-Springconfiguration"></a>Spring configuration</h3>
<p>In simplest case pushing ATOM Feeds can be declared this way:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.management.web.logging.atom.AtomPushBean"</span> init-method=<span class="code-quote">"init"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"url"</span> value=<span class="code-quote">"http://somewhere.com/foo/bar"</span>/></span>
- <span class="code-tag"><property name=<span class="code-quote">"level"</span> value=<span class="code-quote">"ALL"</span> /></span>
- <span class="code-tag"></bean></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <bean class="org.apache.cxf.management.web.logging.atom.AtomPushBean" init-method="init">
+ <property name="url" value="http://somewhere.com/foo/bar"/>
+ <property name="level" value="ALL" />
+ </bean>
+]]></script>
</div></div>
<p>Spring bean creates ATOM push handler and registers it with root logger for all log levels. This setup leads to logging everything CXF, Spring and others included. Since batch size is not specified default value of one is used - each event is packed up as single feed pushed out to specified URL. Default conversion strategy and default WebClient-based deliver are used. </p>
<p>More complex example shows how to specify non-root logger and define batch size:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.management.web.logging.atom.AtomPushBean"</span> init-method=<span class="code-quote">"init"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"url"</span> value=<span class="code-quote">"http://somewhere.com/foo/bar"</span>/></span>
- <span class="code-tag"><property name=<span class="code-quote">"logger"</span> value=<span class="code-quote">"org.apache.cxf.jaxrs"</span> /></span>
- <span class="code-tag"><property name=<span class="code-quote">"level"</span> value=<span class="code-quote">"INFO"</span> /></span>
- <span class="code-tag"><property name=<span class="code-quote">"batchSize"</span> value=<span class="code-quote">"10"</span> /></span>
- <span class="code-tag"></bean></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <bean class="org.apache.cxf.management.web.logging.atom.AtomPushBean" init-method="init">
+ <property name="url" value="http://somewhere.com/foo/bar"/>
+ <property name="logger" value="org.apache.cxf.jaxrs" />
+ <property name="level" value="INFO" />
+ <property name="batchSize" value="10" />
+ </bean>
+]]></script>
</div></div>
<p>To push to client events generated by different loggers on different levels, "loggers" property must be used instead of pair "logger" and "level":</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.jaxrs.management.web.atom.AtomPushBean"</span> init-method=<span class="code-quote">"init"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"url"</span> value=<span class="code-quote">"http://somewhere.com/foo/bar"</span>/></span>
- <property name=<span class="code-quote">"loggers"</span> value="
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <bean class="org.apache.cxf.jaxrs.management.web.atom.AtomPushBean" init-method="init">
+ <property name="url" value="http://somewhere.com/foo/bar"/>
+ <property name="loggers" value="
org.apache.cxf:DEBUG,
org.apache.cxf.jaxrs,
org.apache.cxf.bus:ERROR,
myNamedLogger:INFO" />
- <span class="code-tag"></bean></span>
-</pre>
+ </bean>
+]]></script>
</div></div>
<p>In example above, second logger does not have specified level, in such case default level of "INFO" is used.</p>
<p>In all above cases, when first delivery fails engine of ATOM push handler is shutdown and no events will be processed and pushed until configuration reload. To avoid this frequent case, retrial can be enabled:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.management.web.logging.atom.AtomPushBean"</span> init-method=<span class="code-quote">"init"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"url"</span> value=<span class="code-quote">"http://somewhere.com/foo/bar"</span>/></span>
- <span class="code-tag"><property name=<span class="code-quote">"logger"</span> value=<span class="code-quote">"org.apache.cxf.jaxrs"</span> /></span>
- <span class="code-tag"><property name=<span class="code-quote">"level"</span> value=<span class="code-quote">"INFO"</span> /></span>
- <span class="code-tag"><property name=<span class="code-quote">"retryPause"</span> value=<span class="code-quote">"linear"</span> /></span>
- <span class="code-tag"><property name=<span class="code-quote">"retryPauseTime"</span> value=<span class="code-quote">"60"</span> /></span>
- <span class="code-tag"><property name=<span class="code-quote">"retryTimeout"</span> value=<span class="code-quote">"300"</span> /></span>
- <span class="code-tag"></bean></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <bean class="org.apache.cxf.management.web.logging.atom.AtomPushBean" init-method="init">
+ <property name="url" value="http://somewhere.com/foo/bar"/>
+ <property name="logger" value="org.apache.cxf.jaxrs" />
+ <property name="level" value="INFO" />
+ <property name="retryPause" value="linear" />
+ <property name="retryPauseTime" value="60" />
+ <property name="retryTimeout" value="300" />
+ </bean>
+]]></script>
</div></div>
<p>In this case for 5 minutes ("retryTimeout") after delivery failure there will be 1 minute pause ("retryPauseTime") repeated every time with same value ("retryPause" as "linear"). Instead of same pause time, "exponential" value of "retryPause" can be used - each next time pause time doubles. When timeout value is set to 0 retrying is infinite. In case of invalid or missing values defaults are used: for pause time 30 seconds and for timeout 0 (infinite). Instead of same pause time, "exponential" value of "retryPauseType" can be used - each next time pause time doubles. When timeout value is set to 0 retrying is infinite. In case of invalid or missing values defaults are used: for pause time 30 seconds and for timeout 0 (infinite).</p>
<p>Ultimate control is given by "converter" and "deliverer" properties. Either beans of predefined or custom classes can be used (see "Programming syle" chapter for more details). Example below shows custom class using different transport protocol than default:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <bean id=<span class="code-quote">"soapDeliverer"</span> ...
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <bean id="soapDeliverer" ...
...
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.management.web.logging.atom.AtomPushBean"</span> init-method=<span class="code-quote">"init"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"deliverer"</span>></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"soapDeliverer"</span>/></span>
- <span class="code-tag"></property></span>
- <span class="code-tag"><property name=<span class="code-quote">"loggers"</span> ... /></span>
- <span class="code-tag"></bean></span>
-</pre>
+ <bean class="org.apache.cxf.management.web.logging.atom.AtomPushBean" init-method="init">
+ <property name="deliverer">
+ <ref bean="soapDeliverer"/>
+ </property>
+ <property name="loggers" ... />
+ </bean>
+]]></script>
</div></div>
<p>Note that specifying custom deliverer cause ignoring "url" and "retryXxx" because underneath configuration replaces employed tandem of RetryingDeliverer and WebClientDeliverer with provided one.</p>
<p>When ATOM feeds must be delivered to more than one endpoint and additionally each endpoint is fed by different loggers simply use multiple ATOM push beans in Spring config:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><bean id=<span class="code-quote">"atom1"</span> class=<span class="code-quote">"org.apache.cxf.management.web.logging.atom.AtomPushBean"</span> init-method=<span class="code-quote">"init"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"url"</span> value=<span class="code-quote">"http://someplace.com/foo/bar"</span>/></span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <bean id="atom1" class="org.apache.cxf.management.web.logging.atom.AtomPushBean" init-method="init">
+ <property name="url" value="http://someplace.com/foo/bar"/>
...
- <span class="code-tag"></bean></span>
- <span class="code-tag"><bean id=<span class="code-quote">"atom2"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.management.web.atom.AtomPushBean"</span> init-method=<span class="code-quote">"init"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"url"</span> value=<span class="code-quote">"http://otherplace.com/baz/blah"</span>/></span>
+ </bean>
+ <bean id="atom2" class="org.apache.cxf.jaxrs.management.web.atom.AtomPushBean" init-method="init">
+ <property name="url" value="http://otherplace.com/baz/blah"/>
...
- <span class="code-tag"></bean></span>
+ </bean>
....
-</pre>
+]]></script>
</div></div>
<h3><a shape="rect" name="DebuggingandLogging-Propertiesfile"></a>Properties file</h3>
@@ -453,19 +461,19 @@ org.apache.cxf.common.logging.Slf4jLogge
<p>Example:</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[
handlers = org.apache.cxf.management.web.logging.atom.AtomPushHandler, java.util.logging.ConsoleHandler
.level = INFO
...
- org.apache.cxf.jaxrs.ext.management.web.AtomPushHandler.url = http:<span class="code-comment">//localhost:9080
-</span> org.apache.cxf.jaxrs.ext.management.web.AtomPushHandler.batchSize = 10
+ org.apache.cxf.jaxrs.ext.management.web.AtomPushHandler.url = http://localhost:9080
+ org.apache.cxf.jaxrs.ext.management.web.AtomPushHandler.batchSize = 10
org.apache.cxf.jaxrs.ext.management.web.AtomPushHandler.deliverer = WebClientDeliverer
org.apache.cxf.jaxrs.ext.management.web.AtomPushHandler.converter = foo.bar.MyConverter
org.apache.cxf.jaxrs.ext.management.web.AtomPushHandler.retry.pause = linear
org.apache.cxf.jaxrs.ext.management.web.AtomPushHandler.retry.pause.time = 10
org.apache.cxf.jaxrs.ext.management.web.AtomPushHandler.retry.timeout = 360
...
-</pre>
+]]></script>
</div></div>
<h3><a shape="rect" name="DebuggingandLogging-Programmingstyle"></a>Programming style</h3>
@@ -473,28 +481,28 @@ org.apache.cxf.common.logging.Slf4jLogge
<p>Following example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
- Deliverer d = <span class="code-keyword">new</span> WebClientDeliverer(<span class="code-quote">"http:<span class="code-comment">//somewhere.com/foo/bar"</span>);
-</span> d = <span class="code-keyword">new</span> RetryingDeliverer(d, 300, 60, <span class="code-keyword">true</span>);
- Converter c = <span class="code-keyword">new</span> SingleEntryContentConverter();
- AtomPushHandler h = <span class="code-keyword">new</span> AtomPushHandler(1, c, d);
- Logger l = Logger.getLogger(<span class="code-quote">"org.apache.cxf.jaxrs"</span>);
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+ Deliverer d = new WebClientDeliverer("http://somewhere.com/foo/bar");
+ d = new RetryingDeliverer(d, 300, 60, true);
+ Converter c = new SingleEntryContentConverter();
+ AtomPushHandler h = new AtomPushHandler(1, c, d);
+ Logger l = Logger.getLogger("org.apache.cxf.jaxrs");
l.setLevel(Level.INFO);
l.addHandler(h);
-</pre>
+]]></script>
</div></div>
<p>is equivalent to Spring configuration:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
- <bean class=<span class="code-quote">"org.apache.cxf.management.web.logging.atom.AtomPushBean"</span> init-method=<span class="code-quote">"init"</span>>
- <property name=<span class="code-quote">"url"</span> value=<span class="code-quote">"http:<span class="code-comment">//somewhere.com/foo/bar"</span>/>
-</span> <property name=<span class="code-quote">"logger"</span> value=<span class="code-quote">"org.apache.cxf.jaxrs"</span> />
- <property name=<span class="code-quote">"level"</span> value=<span class="code-quote">"INFO"</span> />
- <property name=<span class="code-quote">"retryPause"</span> value=<span class="code-quote">"linear"</span> />
- <property name=<span class="code-quote">"retryPauseTime"</span> value=<span class="code-quote">"60"</span> />
- <property name=<span class="code-quote">"retryTimeout"</span> value=<span class="code-quote">"300"</span> />
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <bean class="org.apache.cxf.management.web.logging.atom.AtomPushBean" init-method="init">
+ <property name="url" value="http://somewhere.com/foo/bar"/>
+ <property name="logger" value="org.apache.cxf.jaxrs" />
+ <property name="level" value="INFO" />
+ <property name="retryPause" value="linear" />
+ <property name="retryPauseTime" value="60" />
+ <property name="retryTimeout" value="300" />
</bean>
-</pre>
+]]></script>
</div></div>
<h2><a shape="rect" name="DebuggingandLogging-PollStyle"></a>Poll Style</h2>
@@ -508,16 +516,16 @@ org.apache.cxf.common.logging.Slf4jLogge
<p>When configuring AtomPullServer endpoints, one can set the 'loggers' property the same way as it is done for AtomPushBeans, for example :</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.management.web.logging.atom.AtomPullServer"</span> init-method=<span class="code-quote">"init"</span>></span>
- <property name=<span class="code-quote">"loggers"</span> value="
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <bean class="org.apache.cxf.management.web.logging.atom.AtomPullServer" init-method="init">
+ <property name="loggers" value="
org.apache.cxf:DEBUG,
org.apache.cxf.jaxrs,
org.apache.cxf.bus:ERROR,
myNamedLogger:INFO" />
- <span class="code-tag"><property name=<span class="code-quote">"pageSize"</span> value=<span class="code-quote">"30"</span>/></span>
- <span class="code-tag"></bean></span>
-</pre>
+ <property name="pageSize" value="30"/>
+ </bean>
+]]></script>
</div></div>
<p>In addition to the 'loggers' property, a 'pageSize' property limiting a number of entries per page to 30 is also set (default is 40).</p>
@@ -525,17 +533,17 @@ org.apache.cxf.common.logging.Slf4jLogge
<p>One can have a <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/rt/management-web/src/main/java/org/apache/cxf/management/web/logging/ReadWriteLogStorage.java">ReadWriteLogStorage</a> bean injected into AtomPushBean if the log records have to be periodically offloaded from memory and persisted across restarts :</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><bean id=<span class="code-quote">"storage"</span> class=<span class="code-quote">"org.apache.cxf.systest.jaxrs.JAXRSLoggingAtomPullSpringTest$Storage"</span>/></span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <bean id="storage" class="org.apache.cxf.systest.jaxrs.JAXRSLoggingAtomPullSpringTest$Storage"/>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.management.web.logging.atom.AtomPullServer"</span> init-method=<span class="code-quote">"init"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"loggers"</span> value=<span class="code-quote">"org.apache.cxf.jaxrs"</span> /></span>
- <span class="code-tag"><property name=<span class="code-quote">"maxInMemorySize"</span> value=<span class="code-quote">"400"</span>/></span>
- <span class="code-tag"><property name=<span class="code-quote">"storage"</span>></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"storage"</span>/></span>
- <span class="code-tag"></property></span>
- <span class="code-tag"></bean></span>
-</pre>
+ <bean class="org.apache.cxf.management.web.logging.atom.AtomPullServer" init-method="init">
+ <property name="loggers" value="org.apache.cxf.jaxrs" />
+ <property name="maxInMemorySize" value="400"/>
+ <property name="storage">
+ <ref bean="storage"/>
+ </property>
+ </bean>
+]]></script>
</div></div>
<p>When a number of records in memory reaches 400 (default is 500) then the records will be offloaded into a provided storage and will be read from it after the restart or when a client has requested a relevant page. If no storage is available then after an in-memory limit is reached the oldest records will be discarded, one can set a maxInMemorySize property to a large enough value if needed.</p>
@@ -544,21 +552,21 @@ org.apache.cxf.common.logging.Slf4jLogge
<p>Once AtomPullServer has been configured, it has to be registered as a service bean with the jaxrs endpoint so that Atom aware clients (blog readers, etc) can start polling it :</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><jaxrs:server id=<span class="code-quote">"atomServer"</span> address=<span class="code-quote">"/atom"</span>></span>
- <span class="code-tag"><jaxrs:serviceBeans></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"atomPullServer"</span>/></span>
- <span class="code-tag"></jaxrs:serviceBeans></span>
-
- <span class="code-tag"><jaxrs:providers></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"feed"</span>/></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"entry"</span>/></span>
- <span class="code-tag"></jaxrs:providers></span>
-<span class="code-tag"></jaxrs:server></span>
-
-<span class="code-tag"><bean id=<span class="code-quote">"feed"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.AtomFeedProvider"</span>/></span>
-<span class="code-tag"><bean id=<span class="code-quote">"entry"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.provider.AtomEntryProvider"</span>/></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<jaxrs:server id="atomServer" address="/atom">
+ <jaxrs:serviceBeans>
+ <ref bean="atomPullServer"/>
+ </jaxrs:serviceBeans>
+
+ <jaxrs:providers>
+ <ref bean="feed"/>
+ <ref bean="entry"/>
+ </jaxrs:providers>
+</jaxrs:server>
+
+<bean id="feed" class="org.apache.cxf.jaxrs.provider.AtomFeedProvider"/>
+<bean id="entry" class="org.apache.cxf.jaxrs.provider.AtomEntryProvider"/>
+]]></script>
</div></div>
<h3><a shape="rect" name="DebuggingandLogging-LinkingtoAtomendpointsfromCXFServicespage"></a>Linking to Atom endpoints from CXF Services page</h3>
@@ -566,18 +574,18 @@ org.apache.cxf.common.logging.Slf4jLogge
<p>If you would like your users to find about the Atom feeds which are collecting log events from your endpoints then AtomPullServers will need to have a CXF bus injected, as well as be told about the address of the corresponding atom feed endpoint and of the jaxrs or jaxws endpoint :</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<bean id=<span class="code-quote">"atomPullServer"</span> class=<span class="code-quote">"org.apache.cxf.management.web.logging.atom.AtomPullServer"</span> init-method=<span class="code-quote">"init"</span>>
- <property name=<span class="code-quote">"loggers"</span> value=<span class="code-quote">"org.apache.cxf.systest.jaxrs.JAXRSLoggingAtomPullSpringTest$Resource:ALL"</span>/>
- <property name=<span class="code-quote">"bus"</span>>
- <ref bean=<span class="code-quote">"cxf"</span>/>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+<bean id="atomPullServer" class="org.apache.cxf.management.web.logging.atom.AtomPullServer" init-method="init">
+ <property name="loggers" value="org.apache.cxf.systest.jaxrs.JAXRSLoggingAtomPullSpringTest$Resource:ALL"/>
+ <property name="bus">
+ <ref bean="cxf"/>
</property>
- <!-- <span class="code-keyword">this</span> is a jaxrs:server/@adrress or jaxws:endpoint/@address of the endpoint generating the log events -->
- <property name=<span class="code-quote">"endpointAddress"</span> value=<span class="code-quote">"/resource"</span>/>
- <!-- <span class="code-keyword">this</span> is a jaxrs:server/@address of the endpoint <span class="code-keyword">for</span> which <span class="code-keyword">this</span> atomPullServer bean is registered as a service bean -->
- <property name=<span class="code-quote">"serverAddress"</span> value=<span class="code-quote">"/atom"</span>/>
+ <!-- this is a jaxrs:server/@adrress or jaxws:endpoint/@address of the endpoint generating the log events -->
+ <property name="endpointAddress" value="/resource"/>
+ <!-- this is a jaxrs:server/@address of the endpoint for which this atomPullServer bean is registered as a service bean -->
+ <property name="serverAddress" value="/atom"/>
</bean>
-</pre>
+]]></script>
</div></div>
</div>
</div>
Modified: websites/production/cxf/content/docs/defining-contract-first-webservices-with-wsdl-generation-from-java.html
==============================================================================
--- websites/production/cxf/content/docs/defining-contract-first-webservices-with-wsdl-generation-from-java.html (original)
+++ websites/production/cxf/content/docs/defining-contract-first-webservices-with-wsdl-generation-from-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 - Defining Contract first webservices with wsdl generation from 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 -- Defining Contract first webservices with wsdl generation from java
</title>
@@ -42,19 +54,15 @@ Apache CXF -- Defining Contract first we
<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 -- Defining Contract first we
<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>
@@ -139,20 +147,20 @@ Apache CXF -- Defining Contract first we
<h3><a shape="rect" name="DefiningContractfirstwebserviceswithwsdlgenerationfromjava-Customerdatatype"></a>Customer datatype</h3>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> com.example.customerservice;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package com.example.customerservice;
@XmlAccessorType( XmlAccessType.FIELD )
-<span class="code-keyword">public</span> class Customer {
- <span class="code-object">String</span> name;
- <span class="code-object">String</span>[] address;
- <span class="code-object">int</span> numOrders;
- <span class="code-object">double</span> revenue;
+public class Customer {
+ String name;
+ String[] address;
+ int numOrders;
+ double revenue;
BigDecimal test;
Date birthDate;
CustomerType type;
}
-</pre>
+]]></script>
</div></div>
<p>The sample class Customer gives a nice overview which primitive datatypes can be used. Additionally you can create arrays of primitive or class datatypes in this way. The complete example also contains an enumeration definition to show this is possible. I think this code is quite near the DSL I would imagine to describe my services.</p>
@@ -160,45 +168,45 @@ Apache CXF -- Defining Contract first we
<p>Shows how enumerations are handled:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> com.example.customerservice;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package com.example.customerservice;
-<span class="code-keyword">public</span> <span class="code-keyword">enum</span> CustomerType {
+public enum CustomerType {
PRIVATE, BUSINESS
}
-</pre>
+]]></script>
</div></div>
<h3><a shape="rect" name="DefiningContractfirstwebserviceswithwsdlgenerationfromjava-NoSuchCustomerException"></a>NoSuchCustomerException</h3>
<p> Defining Exceptions is a little tricky as the default behaviour is to create Exception_Exception classes in the later generated Java code. So we have to use the @WebFault annotation to give the Bean for the data a name that is separate from the Exception name.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> com.example.customerservice;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package com.example.customerservice;
-@WebFault(name=<span class="code-quote">"NoSuchCustomer"</span>)
+@WebFault(name="NoSuchCustomer")
@XmlAccessorType( XmlAccessType.FIELD )
-<span class="code-keyword">public</span> class NoSuchCustomerException <span class="code-keyword">extends</span> RuntimeException {
+public class NoSuchCustomerException extends RuntimeException {
/**
* We only define the fault details here. Additionally each fault has a message
* that should not be defined separately
*/
- <span class="code-object">String</span> customerName;
+ String customerName;
}
-</pre>
+]]></script>
</div></div>
<h3><a shape="rect" name="DefiningContractfirstwebserviceswithwsdlgenerationfromjava-Servicedefinition"></a>Service definition</h3>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> com.example.customerservice;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package com.example.customerservice;
@WebService
-<span class="code-keyword">public</span> <span class="code-keyword">interface</span> CustomerService {
- <span class="code-keyword">public</span> Customer[] getCustomersByName(@WebParam(name=<span class="code-quote">"name"</span>) <span class="code-object">String</span> name) <span class="code-keyword">throws</span> NoSuchCustomerException;
+public interface CustomerService {
+ public Customer[] getCustomersByName(@WebParam(name="name") String name) throws NoSuchCustomerException;
}
-</pre>
+]]></script>
</div></div>
<p>As you can see only two annotations are necessary here. @WebService marks the interface as a service and @Webparam is necessary as Java will else lose the name of the parameter and the wsdl will contain arg0 instead of the desired name. Using the @WebService annotation you can also customize the port name and service name.</p>
@@ -209,21 +217,21 @@ Apache CXF -- Defining Contract first we
<h2><a shape="rect" name="DefiningContractfirstwebserviceswithwsdlgenerationfromjava-Let%C2%B4stakealookattheresultingWSDL"></a>Let´s take a look at the resulting WSDL</h2>
-<p>You can <a shape="rect" href="defining-contract-first-webservices-with-wsdl-generation-from-java.data/CustomerService.wsdl?version=2&modificationDate=1219340552000">download the wsdl this example creates here</a>.</p>
+<p>You can <a shape="rect" href="defining-contract-first-webservices-with-wsdl-generation-from-java.data/CustomerService.wsdl?version=2&modificationDate=1219326152000">download the wsdl this example creates here</a>.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><xs:complexType name=<span class="code-quote">"customer"</span>></span>
- <span class="code-tag"><xs:sequence></span>
- <span class="code-tag"><xs:element minOccurs=<span class="code-quote">"0"</span> name=<span class="code-quote">"name"</span> type=<span class="code-quote">"xs:string"</span>/></span>
- <span class="code-tag"><xs:element maxOccurs=<span class="code-quote">"unbounded"</span> minOccurs=<span class="code-quote">"0"</span> name=<span class="code-quote">"address"</span> nillable=<span class="code-quote">"true"</span> type=<span class="code-quote">"xs:string"</span>/></span>
- <span class="code-tag"><xs:element name=<span class="code-quote">"numOrders"</span> type=<span class="code-quote">"xs:int"</span>/></span>
- <span class="code-tag"><xs:element name=<span class="code-quote">"revenue"</span> type=<span class="code-quote">"xs:double"</span>/></span>
- <span class="code-tag"><xs:element minOccurs=<span class="code-quote">"0"</span> name=<span class="code-quote">"test"</span> type=<span class="code-quote">"xs:decimal"</span>/></span>
- <span class="code-tag"><xs:element minOccurs=<span class="code-quote">"0"</span> name=<span class="code-quote">"birthDate"</span> type=<span class="code-quote">"xs:dateTime"</span>/></span>
- <span class="code-tag"><xs:element minOccurs=<span class="code-quote">"0"</span> name=<span class="code-quote">"type"</span> type=<span class="code-quote">"tns:customerType"</span>/></span>
- <span class="code-tag"></xs:sequence></span>
-<span class="code-tag"></xs:complexType></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<xs:complexType name="customer">
+ <xs:sequence>
+ <xs:element minOccurs="0" name="name" type="xs:string"/>
+ <xs:element maxOccurs="unbounded" minOccurs="0" name="address" nillable="true" type="xs:string"/>
+ <xs:element name="numOrders" type="xs:int"/>
+ <xs:element name="revenue" type="xs:double"/>
+ <xs:element minOccurs="0" name="test" type="xs:decimal"/>
+ <xs:element minOccurs="0" name="birthDate" type="xs:dateTime"/>
+ <xs:element minOccurs="0" name="type" type="tns:customerType"/>
+ </xs:sequence>
+</xs:complexType>
+]]></script>
</div></div>
<p>The customer Class is a complex type in xsd. As you can see the Java types have been described as their respective XSD primitive types.</p>
@@ -235,32 +243,32 @@ Apache CXF -- Defining Contract first we
<p>The enumeration customerType is described as a simple type with a restriction:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><xs:simpleType name=<span class="code-quote">"customerType"</span>></span>
- <span class="code-tag"><xs:restriction base=<span class="code-quote">"xs:string"</span>></span>
- <span class="code-tag"><xs:enumeration value=<span class="code-quote">"PRIVATE"</span>/></span>
- <span class="code-tag"><xs:enumeration value=<span class="code-quote">"BUSINESS"</span>/></span>
- <span class="code-tag"></xs:restriction></span>
-<span class="code-tag"></xs:simpleType></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<xs:simpleType name="customerType">
+ <xs:restriction base="xs:string">
+ <xs:enumeration value="PRIVATE"/>
+ <xs:enumeration value="BUSINESS"/>
+ </xs:restriction>
+</xs:simpleType>
+]]></script>
</div></div>
<h3><a shape="rect" name="DefiningContractfirstwebserviceswithwsdlgenerationfromjava-FaultNoSuchCustomerException"></a>Fault NoSuchCustomerException</h3>
<p>The Exception we defined is generated as a complexType with the defined details and a message for the fault. It is important here that the Element and the Message have different names. We ensure this by using the @Webfault Annotation above. Else the later Java Code generation will produce an ugly Exception name NoSuchCustomerException_Exception.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><xs:element name=<span class="code-quote">"NoSuchCustomer"</span> type=<span class="code-quote">"tns:NoSuchCustomer"</span>/></span>
-<span class="code-tag"><xs:complexType name=<span class="code-quote">"NoSuchCustomer"</span>></span>
- <span class="code-tag"><xs:sequence></span>
- <span class="code-tag"><xs:element name=<span class="code-quote">"customerName"</span> nillable=<span class="code-quote">"true"</span> type=<span class="code-quote">"xs:string"</span>/></span>
- <span class="code-tag"></xs:sequence></span>
-<span class="code-tag"></xs:complexType></span>
-<span class="code-tag"><wsdl:message name=<span class="code-quote">"NoSuchCustomerException"</span>></span>
- <span class="code-tag"><wsdl:part name=<span class="code-quote">"NoSuchCustomerException"</span> element=<span class="code-quote">"tns:NoSuchCustomer"</span>></span>
- <span class="code-tag"></wsdl:part></span>
-<span class="code-tag"></wsdl:message></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<xs:element name="NoSuchCustomer" type="tns:NoSuchCustomer"/>
+<xs:complexType name="NoSuchCustomer">
+ <xs:sequence>
+ <xs:element name="customerName" nillable="true" type="xs:string"/>
+ </xs:sequence>
+</xs:complexType>
+<wsdl:message name="NoSuchCustomerException">
+ <wsdl:part name="NoSuchCustomerException" element="tns:NoSuchCustomer">
+ </wsdl:part>
+</wsdl:message>
+]]></script>
</div></div>
<p>The wsdl defines a SOAP/HTTP binding by default but can also be used to build services based on JMS as I will show in my next post.</p>
@@ -270,7 +278,7 @@ Apache CXF -- Defining Contract first we
<p>In the next post I will show ho to build service consumers and providers using the WSDL we just built.</p>
-<p>You can <a shape="rect" href="defining-contract-first-webservices-with-wsdl-generation-from-java.data/cxfjava2wsexample.zip?version=1&modificationDate=1219340511000">download the complete example here</a>.
+<p>You can <a shape="rect" href="defining-contract-first-webservices-with-wsdl-generation-from-java.data/cxfjava2wsexample.zip?version=1&modificationDate=1219326111000">download the complete example here</a>.
<br clear="none" class="atl-forced-newline"></p>
<h2><a shape="rect" name="DefiningContractfirstwebserviceswithwsdlgenerationfromjava-References"></a>References</h2>
Modified: websites/production/cxf/content/docs/deployment.html
==============================================================================
--- websites/production/cxf/content/docs/deployment.html (original)
+++ websites/production/cxf/content/docs/deployment.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 - Deployment">
+
+
<title>
Apache CXF -- Deployment
</title>
@@ -42,19 +44,15 @@ Apache CXF -- Deployment
<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 -- Deployment
<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>