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 [28/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/jax-ws-configuration.html
==============================================================================
--- websites/production/cxf/content/docs/jax-ws-configuration.html (original)
+++ websites/production/cxf/content/docs/jax-ws-configuration.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 - JAX-WS Configuration">
+
+ <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 -- JAX-WS Configuration
</title>
@@ -42,19 +54,15 @@ Apache CXF -- JAX-WS Configuration
<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 -- JAX-WS Configuration
<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>
@@ -127,24 +135,24 @@ Apache CXF -- JAX-WS Configuration
<p>A JAX-WS Endpoint can be configured in XML in addition to using the JAX-WS APIs. Once you've created your <a shape="rect" href="developing-a-service.html" title="Developing a Service">server implementation</a>, you simply need to provide the class name and an address. Here is a simple example:</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
http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd">
-<jaxws:endpoint id=<span class="code-quote">"classImpl"</span>
- implementor=<span class="code-quote">"org.apache.cxf.jaxws.service.Hello"</span>
- endpointName=<span class="code-quote">"e:HelloEndpointCustomized"</span>
- serviceName=<span class="code-quote">"s:HelloServiceCustomized"</span>
- address=<span class="code-quote">"http://localhost:8080/test"</span>
- <span class="code-keyword">xmlns:e</span>=<span class="code-quote">"http://service.jaxws.cxf.apache.org/endpoint"</span>
- <span class="code-keyword">xmlns:s</span>=<span class="code-quote">"http://service.jaxws.cxf.apache.org/service"</span>/>
+<jaxws:endpoint id="classImpl"
+ implementor="org.apache.cxf.jaxws.service.Hello"
+ endpointName="e:HelloEndpointCustomized"
+ serviceName="s:HelloServiceCustomized"
+ address="http://localhost:8080/test"
+ xmlns:e="http://service.jaxws.cxf.apache.org/endpoint"
+ xmlns:s="http://service.jaxws.cxf.apache.org/service"/>
-<span class="code-tag"></beans></span>
-</pre>
+</beans>
+]]></script>
</div></div>
<p>Be sure to include the JAX-WS <tt>schemaLocation</tt> attribute specified on the root beans element. This allows CXF to validate the file and is required. Also note the namespace declarations at the end of the <jaxws:endpoint/> tag--these are required because the combined "{namespace}localName" syntax is presently not supported for this tag's attribute values.</p>
@@ -161,11 +169,11 @@ http://cxf.apache.org/jaxws http://cxf.a
<p>Here is a more advanced example which shows how to provide interceptors and properties:</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>
- <span class="code-keyword">xmlns:soap</span>=<span class="code-quote">"http://cxf.apache.org/bindings/soap"</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"
+ xmlns:soap="http://cxf.apache.org/bindings/soap"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
http://cxf.apache.org/bindings/soap
@@ -173,44 +181,44 @@ http://cxf.apache.org/jaxws http://cxf.a
http://cxf.apache.org/jaxws
http://cxf.apache.org/schemas/jaxws.xsd">
- <span class="code-tag"><import resource=<span class="code-quote">"classpath:META-INF/cxf/cxf.xml"</span>/></span>
- <span class="code-tag"><import resource=<span class="code-quote">"classpath:META-INF/cxf/cxf-extension-soap.xml"</span>/></span>
+ <import resource="classpath:META-INF/cxf/cxf.xml"/>
+ <import resource="classpath:META-INF/cxf/cxf-extension-soap.xml"/>
<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:inInterceptors></span>
- <span class="code-tag"><bean class=<span class="code-quote">"com.acme.SomeInterceptor"</span>/></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"anotherInterceptor"</span>/></span>
- <span class="code-tag"></jaxws:inInterceptor></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>
-
- <span class="code-tag"><bean id=<span class="code-quote">"anotherInterceptor"</span> class=<span class="code-quote">"com.acme.SomeInterceptor"</span>/></span>
-
- <jaxws:endpoint id=<span class="code-quote">"simpleWithBinding"</span>
- implementor=<span class="code-quote">"#greeter"</span>
- address=<span class="code-quote">"http://localhost:8080/simpleWithAddress"</span>>
- <span class="code-tag"><jaxws:binding></span>
- <span class="code-tag"><soap:soapBinding mtomEnabled=<span class="code-quote">"true"</span> version=<span class="code-quote">"1.2"</span>/></span>
- <span class="code-tag"></jaxws:binding></span>
- <span class="code-tag"></jaxws:endpoint></span>
-
- <jaxws:endpoint id=<span class="code-quote">"inlineInvoker"</span>
- address=<span class="code-quote">"http://localhost:8080/simpleWithAddress"</span>>
- <span class="code-tag"><jaxws:implementor></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.hello_world_soap_http.GreeterImpl"</span>/></span>
- <span class="code-tag"></jaxws:implementor></span>
- <span class="code-tag"><jaxws:invoker></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.jaxws.spring.NullInvoker"</span>/></span>
- <span class="code-tag"></jaxws:invoker></span>
- <span class="code-tag"></jaxws:endpoint></span>
+ id="helloWorld"
+ implementor="demo.spring.HelloWorldImpl"
+ address="http://localhost/HelloWorld">
+ <jaxws:inInterceptors>
+ <bean class="com.acme.SomeInterceptor"/>
+ <ref bean="anotherInterceptor"/>
+ </jaxws:inInterceptor>
+ <jaxws:properties>
+ <entry key="mtom-enabled" value="true"/>
+ </jaxws:properties>
+ </jaxws:endpoint>
+
+ <bean id="anotherInterceptor" class="com.acme.SomeInterceptor"/>
+
+ <jaxws:endpoint id="simpleWithBinding"
+ implementor="#greeter"
+ address="http://localhost:8080/simpleWithAddress">
+ <jaxws:binding>
+ <soap:soapBinding mtomEnabled="true" version="1.2"/>
+ </jaxws:binding>
+ </jaxws:endpoint>
+
+ <jaxws:endpoint id="inlineInvoker"
+ address="http://localhost:8080/simpleWithAddress">
+ <jaxws:implementor>
+ <bean class="org.apache.hello_world_soap_http.GreeterImpl"/>
+ </jaxws:implementor>
+ <jaxws:invoker>
+ <bean class="org.apache.cxf.jaxws.spring.NullInvoker"/>
+ </jaxws:invoker>
+ </jaxws:endpoint>
-<span class="code-tag"></beans></span>
-</pre>
+</beans>
+]]></script>
</div></div>
<p>If you are a Spring user, you'll notice that the <tt>jaxws:properties</tt> element follows the Spring Map syntax.</p>
@@ -219,22 +227,22 @@ http://cxf.apache.org/jaxws http://cxf.a
<div class="panelMacro"><table class="infoMacro"><colgroup span="1"><col span="1" width="24"><col span="1"></colgroup><tr><td colspan="1" rowspan="1" valign="top"><img align="middle" src="https://cwiki.apache.org/confluence/images/icons/emoticons/information.gif" width="16" height="16" alt="" border="0"></td><td colspan="1" rowspan="1">This technique lets you add a Web Services client to your Spring application. You can inject it into other Spring beans, or manually retrieve it from the Spring context for use by non-Spring-aware client code.</td></tr></table></div>
<p>The easiest way to add a Web Services client to a Spring context is to use the <tt><jaxws:client></tt> element (similar to the <tt><jaxws:endpoint></tt> element used for the server side). Here's a simple example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?></span>
-<beans xmlns=<span class="code-quote">"http://www.springframework.org/schema/beans"</span>
- <span class="code-keyword">xmlns:jaxws</span>=<span class="code-quote">"http://cxf.apache.org/jaxws"</span>
- <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+ xmlns:jaxws="http://cxf.apache.org/jaxws"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://cxf.apache.org/jaxws
http://cxf.apache.org/schemas/jaxws.xsd">
- <jaxws:client id=<span class="code-quote">"helloClient"</span>
- serviceClass=<span class="code-quote">"demo.spring.HelloWorld"</span>
- address=<span class="code-quote">"http://localhost:9002/HelloWorld"</span> />
-<span class="code-tag"></beans></span>
-</pre>
+ <jaxws:client id="helloClient"
+ serviceClass="demo.spring.HelloWorld"
+ address="http://localhost:9002/HelloWorld" />
+</beans>
+]]></script>
</div></div>
<p>The attributes available on <tt><jaxws:client></tt> include:</p>
<div class="table-wrap">
@@ -248,11 +256,11 @@ http://cxf.apache.org/jaxws http://cxf.a
<p>Here is a more advanced example which shows how to provide interceptors, JAX-WS handlers, and properties:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?></span>
-<beans xmlns=<span class="code-quote">"http://www.springframework.org/schema/beans"</span>
- <span class="code-keyword">xmlns:jaxws</span>=<span class="code-quote">"http://cxf.apache.org/jaxws"</span>
- <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+ xmlns:jaxws="http://cxf.apache.org/jaxws"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
@@ -261,28 +269,28 @@ http://cxf.apache.org/jaxws http://cxf.a
<!-- Interceptors extend e.g.
org.apache.cxf.phase.AbstractPhaseInterceptor -->
- <span class="code-tag"><bean id=<span class="code-quote">"anotherInterceptor"</span> class=<span class="code-quote">"..."</span> /></span>
+ <bean id="anotherInterceptor" class="..." />
- <span class="code-tag"><span class="code-comment"><!-- Handlers implement e.g. javax.xml.ws.handler.soap.SOAPHandler --></span></span>
- <span class="code-tag"><bean id=<span class="code-quote">"jaxwsHandler"</span> class=<span class="code-quote">"..."</span> /></span>
+ <!-- Handlers implement e.g. javax.xml.ws.handler.soap.SOAPHandler -->
+ <bean id="jaxwsHandler" class="..." />
- <span class="code-tag"><span class="code-comment"><!-- The SOAP client bean --></span></span>
- <jaxws:client id=<span class="code-quote">"helloClient"</span>
- serviceClass=<span class="code-quote">"demo.spring.HelloWorld"</span>
- address=<span class="code-quote">"http://localhost:9002/HelloWorld"</span>>
- <span class="code-tag"><jaxws:inInterceptors></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.interceptor.LoggingInInterceptor"</span>/></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"anotherInterceptor"</span>/></span>
- <span class="code-tag"></jaxws:inInterceptor></span>
- <span class="code-tag"><jaxws:handlers></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"jaxwsHandler"</span> /></span>
- <span class="code-tag"></jaxws:handlers></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:client></span>
-<span class="code-tag"></beans></span>
-</pre>
+ <!-- The SOAP client bean -->
+ <jaxws:client id="helloClient"
+ serviceClass="demo.spring.HelloWorld"
+ address="http://localhost:9002/HelloWorld">
+ <jaxws:inInterceptors>
+ <bean class="org.apache.cxf.interceptor.LoggingInInterceptor"/>
+ <ref bean="anotherInterceptor"/>
+ </jaxws:inInterceptor>
+ <jaxws:handlers>
+ <ref bean="jaxwsHandler" />
+ </jaxws:handlers>
+ <jaxws:properties>
+ <entry key="mtom-enabled" value="true"/>
+ </jaxws:properties>
+ </jaxws:client>
+</beans>
+]]></script>
</div></div>
<h1><a shape="rect" name="JAX-WSConfiguration-ConfiguringaSpringClient%28Option2%29"></a>Configuring a Spring Client (Option 2)</h1>
@@ -290,52 +298,52 @@ http://cxf.apache.org/jaxws http://cxf.a
<div class="panelMacro"><table class="infoMacro"><colgroup span="1"><col span="1" width="24"><col span="1"></colgroup><tr><td colspan="1" rowspan="1" valign="top"><img align="middle" src="https://cwiki.apache.org/confluence/images/icons/emoticons/information.gif" width="16" height="16" alt="" border="0"></td><td colspan="1" rowspan="1">Building a Client using this configuration is only applicable for those wishing to inject a Client into their Spring ApplicationContext.</td></tr></table></div>
<p>This approach requires more explicit Spring bean configuration than the previous option, and may require more configuration data depending on which features are used. To configure a client this way, you'll need to declare a proxy factory bean and also a client bean which is created by that proxy factory. Here is an example:</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
http://cxf.apache.org/jaxws
http://cxf.apache.org/schemas/jaxws.xsd">
- <bean id=<span class="code-quote">"proxyFactory"</span>
- class=<span class="code-quote">"org.apache.cxf.jaxws.JaxWsProxyFactoryBean"</span>>
- <span class="code-tag"><property name=<span class="code-quote">"serviceClass"</span> value=<span class="code-quote">"demo.spring.HelloWorld"</span>/></span>
- <span class="code-tag"><property name=<span class="code-quote">"address"</span> value=<span class="code-quote">"http://localhost:9002/HelloWorld"</span>/></span>
- <span class="code-tag"></bean></span>
+ <bean id="proxyFactory"
+ class="org.apache.cxf.jaxws.JaxWsProxyFactoryBean">
+ <property name="serviceClass" value="demo.spring.HelloWorld"/>
+ <property name="address" value="http://localhost:9002/HelloWorld"/>
+ </bean>
- <bean id=<span class="code-quote">"client"</span> class=<span class="code-quote">"demo.spring.HelloWorld"</span>
- factory-bean=<span class="code-quote">"proxyFactory"</span> factory-method=<span class="code-quote">"create"</span>/>
+ <bean id="client" class="demo.spring.HelloWorld"
+ factory-bean="proxyFactory" factory-method="create"/>
-<span class="code-tag"></beans></span>
-</pre>
+</beans>
+]]></script>
</div></div>
<p>The JaxWsProxyFactoryBean in this case takes two properties. The service class, which is the interface of the Client proxy you wish to create. The address is the address of the service you wish to call.</p>
<p>The second bean definition is for the client. In this case it implements the HelloWorld interface and is created by the proxyFactory <bean> by calling the create() method. You can then reference this "client" bean and inject it anywhere into your application. Here is an example of a very simple Java class which accesses the client bean:</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[
include org.springframework.context.support.ClassPathXmlApplicationContext;
-<span class="code-keyword">public</span> <span class="code-keyword">final</span> class HelloWorldClient {
+public final class HelloWorldClient {
- <span class="code-keyword">private</span> HelloWorldClient() { }
+ private HelloWorldClient() { }
- <span class="code-keyword">public</span> <span class="code-keyword">static</span> void main(<span class="code-object">String</span> args[]) <span class="code-keyword">throws</span> Exception {
+ public static void main(String args[]) throws Exception {
ClassPathXmlApplicationContext context
- = <span class="code-keyword">new</span> ClassPathXmlApplicationContext(
- <span class="code-keyword">new</span> <span class="code-object">String</span>[]{<span class="code-quote">"my/path/to/client-beans.xml"</span>});
+ = new ClassPathXmlApplicationContext(
+ new String[]{"my/path/to/client-beans.xml"});
- HelloWorld client = (HelloWorld)context.getBean(<span class="code-quote">"client"</span>);
+ HelloWorld client = (HelloWorld)context.getBean("client");
- <span class="code-object">String</span> response = client.sayHi(<span class="code-quote">"Dan"</span>);
- <span class="code-object">System</span>.out.println(<span class="code-quote">"Response: "</span> + response);
- <span class="code-object">System</span>.exit(0);
+ String response = client.sayHi("Dan");
+ System.out.println("Response: " + response);
+ System.exit(0);
}
}
-</pre>
+]]></script>
</div></div>
<p>The JaxWsProxyFactoryBean supports many other properties:</p>
<div class="table-wrap">
@@ -344,17 +352,17 @@ include org.springframework.context.supp
<p>Using some of the properties will require additional configuration in the Spring context. For instance, using JAX-WS handlers requires that you explicitly import several CXF Spring configurations, and assign the "bus" property of the JaxWsProxyFactory bean like this:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><import resource=<span class="code-quote">"classpath:META-INF/cxf/cxf.xml"</span> /></span>
-<span class="code-tag"><import resource=<span class="code-quote">"classpath:META-INF/cxf/cxf-extension-soap.xml"</span> /></span>
-<span class="code-tag"><import resource=<span class="code-quote">"classpath:META-INF/cxf/cxf-extension-http.xml"</span> /></span>
-
-<span class="code-tag"><bean id=<span class="code-quote">"clientFactory"</span> class=<span class="code-quote">"org.apache.cxf.jaxws.JaxWsProxyFactoryBean"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"serviceClass"</span> value=<span class="code-quote">"demo.spring.HelloWorld"</span>/></span>
- <span class="code-tag"><property name=<span class="code-quote">"address"</span> value=<span class="code-quote">"http://localhost:9002/HelloWorld"</span>/></span>
- <span class="code-tag"><property name=<span class="code-quote">"bus"</span> ref=<span class="code-quote">"cxf"</span> /></span>
-<span class="code-tag"></bean></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<import resource="classpath:META-INF/cxf/cxf.xml" />
+<import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" />
+<import resource="classpath:META-INF/cxf/cxf-extension-http.xml" />
+
+<bean id="clientFactory" class="org.apache.cxf.jaxws.JaxWsProxyFactoryBean">
+ <property name="serviceClass" value="demo.spring.HelloWorld"/>
+ <property name="address" value="http://localhost:9002/HelloWorld"/>
+ <property name="bus" ref="cxf" />
+</bean>
+]]></script>
</div></div>
<h1><a shape="rect" name="JAX-WSConfiguration-ConfiguringanEndpoint%2FClientProxyUsingCXFAPIs"></a>Configuring an Endpoint/Client Proxy Using CXF APIs</h1>
@@ -363,40 +371,40 @@ include org.springframework.context.supp
<p>To cast a client proxy to a CXF client:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-GreeterService gs = <span class="code-keyword">new</span> GreeterService();
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+GreeterService gs = new GreeterService();
Greeter greeter = gs.getGreeterPort();
org.apache.cxf.endpoint.Client client =
org.apache.cxf.frontend.ClientProxy.getClient(greeter);
org.apache.cxf.endpoint.Endpoint cxfEndpoint = client.getEndpoint();
cxfEndpoint.getOutInterceptors().add(...);
-</pre>
+]]></script>
</div></div>
<p>To cast a JAX-WS endpoint to a CXF server:</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[
javax.xml.ws.Endpoint jaxwsEndpoint = javax.xml.ws.Endpoint.publish(
- <span class="code-quote">"http:<span class="code-comment">//localhost:9020/SoapContext/GreeterPort"</span>, <span class="code-keyword">new</span> GreeterImpl());
-</span>org.apache.cxf.jaxws.EndpointImpl jaxwsEndpointImpl =
+ "http://localhost:9020/SoapContext/GreeterPort", new GreeterImpl());
+org.apache.cxf.jaxws.EndpointImpl jaxwsEndpointImpl =
(org.apache.cxf.jaxws.EndpointImpl)jaxwsEndpoint;
org.apache.cxf.endpoint.Server server = jaxwsEndpointImpl.getServer();
org.apache.cxf.endpoint.Endpoint cxfEndpoint = server.getEndpoint();
cxfEndpoint.getOutInterceptors().add(...);
org.apache.cxf.service.Service cxfService = cxfEndpoint.getService();
cxfService.getOutInterceptors().add(...);
-</pre>
+]]></script>
</div></div>
<h1><a shape="rect" name="JAX-WSConfiguration-ConfiguretheJAXWSServer%2FClientUsingSpring"></a>Configure the JAXWS Server/Client Using Spring</h1>
<p>CXF provides <jaxws:server>, <jaxws:client> to configure the server/client side endpoint. Here are some examples:</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>
- <span class="code-keyword">xmlns:soap</span>=<span class="code-quote">"http://cxf.apache.org/bindings/soap"</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"
+ xmlns:soap="http://cxf.apache.org/bindings/soap"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
@@ -404,45 +412,45 @@ cxfService.getOutInterceptors().add(...)
http://cxf.apache.org/schemas/configuration/soap.xsd
http://cxf.apache.org/jaxws
http://cxf.apache.org/schemas/jaxws.xsd">
- <span class="code-tag"><jaxws:server id=<span class="code-quote">"inlineImplementor"</span> address=<span class="code-quote">"http://localhost:8080/simpleWithAddress"</span>></span>
- <span class="code-tag"><jaxws:serviceBean></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.hello_soap_http.GreeterImpl"</span>/></span>
- <span class="code-tag"></jaxws:serviceBean></span>
- <span class="code-tag"></jaxws:server></span>
-
- <jaxws:server id=<span class="code-quote">"bookServer"</span> serviceClass=
- <span class="code-quote">"org.apache.cxf.mytype.AnonymousComplexTypeImpl"</span>
- address=<span class="code-quote">"http://localhost:8080/act"</span>
- bus=<span class="code-quote">"cxf"</span>>
- <span class="code-tag"><jaxws:invoker></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.service.invoker.BeanInvoker"</span>></span>
- <span class="code-tag"><constructor-arg></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.mytype.AnonymousComplexTypeImpl"</span>/></span>
- <span class="code-tag"></constructor-arg></span>
- <span class="code-tag"></bean></span>
- <span class="code-tag"></jaxws:invoker></span>
- <span class="code-tag"><jaxws:dataBinding></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.jaxb.JAXBDataBinding"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"namespaceMap"</span>></span>
- <span class="code-tag"><map></span>
- <span class="code-tag"><entry></span>
- <span class="code-tag"><key></span>
- <span class="code-tag"><value></span>http://cxf.apache.org/anon_complex_type/<span class="code-tag"></value></span>
- <span class="code-tag"></key></span>
- <span class="code-tag"><value></span>BeepBeep<span class="code-tag"></value></span>
- <span class="code-tag"></entry></span>
- <span class="code-tag"></map></span>
- <span class="code-tag"></property></span>
- <span class="code-tag"></bean></span>
- <span class="code-tag"></jaxws:dataBinding></span>
- <span class="code-tag"></jaxws:server></span>
-
- <jaxws:client id=<span class="code-quote">"bookClient"</span>
- serviceClass=<span class="code-quote">"org.apache.cxf.mytype.AnonymousComplexType"</span>
- address=<span class="code-quote">"http://localhost:8080/act"</span>/>
+ <jaxws:server id="inlineImplementor" address="http://localhost:8080/simpleWithAddress">
+ <jaxws:serviceBean>
+ <bean class="org.apache.hello_soap_http.GreeterImpl"/>
+ </jaxws:serviceBean>
+ </jaxws:server>
+
+ <jaxws:server id="bookServer" serviceClass=
+ "org.apache.cxf.mytype.AnonymousComplexTypeImpl"
+ address="http://localhost:8080/act"
+ bus="cxf">
+ <jaxws:invoker>
+ <bean class="org.apache.cxf.service.invoker.BeanInvoker">
+ <constructor-arg>
+ <bean class="org.apache.cxf.mytype.AnonymousComplexTypeImpl"/>
+ </constructor-arg>
+ </bean>
+ </jaxws:invoker>
+ <jaxws:dataBinding>
+ <bean class="org.apache.cxf.jaxb.JAXBDataBinding">
+ <property name="namespaceMap">
+ <map>
+ <entry>
+ <key>
+ <value>http://cxf.apache.org/anon_complex_type/</value>
+ </key>
+ <value>BeepBeep</value>
+ </entry>
+ </map>
+ </property>
+ </bean>
+ </jaxws:dataBinding>
+ </jaxws:server>
+
+ <jaxws:client id="bookClient"
+ serviceClass="org.apache.cxf.mytype.AnonymousComplexType"
+ address="http://localhost:8080/act"/>
-<span class="code-tag"></beans></span>
-</pre>
+</beans>
+]]></script>
</div></div>
<p>Since JAX-WS frontend server and client spring configuration parser are inherited from the simple frontend, please see <a shape="rect" href="simple-frontend-configuration.html" title="Simple Frontend Configuration">Simple Frontend Configuration</a> for the attribute and element definitions. </p></div>
</div>
Modified: websites/production/cxf/content/docs/jax-ws-dispatch-api.html
==============================================================================
--- websites/production/cxf/content/docs/jax-ws-dispatch-api.html (original)
+++ websites/production/cxf/content/docs/jax-ws-dispatch-api.html Mon Jun 24 17:10:51 2013
@@ -25,6 +25,17 @@
<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 - JAX-WS Dispatch API">
+
+ <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 type="text/javascript">
+ SyntaxHighlighter.defaults['toolbar'] = false;
+ SyntaxHighlighter.all();
+ </script>
+
<title>
Apache CXF -- JAX-WS Dispatch API
</title>
@@ -42,19 +53,15 @@ Apache CXF -- JAX-WS Dispatch API
<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 +101,7 @@ Apache CXF -- JAX-WS Dispatch API
<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>
@@ -194,17 +201,17 @@ Apache CXF -- JAX-WS Dispatch API
<p>To create a <tt>Dispatch</tt> object do the following:</p>
<ol><li>Create a <tt>Service</tt> object to represent the <tt>wsdl:service</tt> element defining the service on which the <tt>Dispatch</tt> object will make invocations.</li><li>Create the <tt>Dispatch</tt> object using the <tt>Service</tt> object's <tt>createDispatch()</tt> method.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">public</span> Dispatch<T> createDispatch(QName portName, java.lang.<span class="code-object">Class</span><T> type, Service.Mode mode)
-<span class="code-keyword">throws</span> WebServiceException;
-</pre>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+public Dispatch<T> createDispatch(QName portName, java.lang.Class<T> type, Service.Mode mode)
+throws WebServiceException;
+]]></script>
</div></div>
<div class="panelMacro"><table class="noteMacro"><colgroup span="1"><col span="1" width="24"><col span="1"></colgroup><tr><td colspan="1" rowspan="1" valign="top"><img align="middle" src="https://cwiki.apache.org/confluence/images/icons/emoticons/warning.gif" width="16" height="16" alt="" border="0"></td><td colspan="1" rowspan="1">If you are using JAXB objects the method signature for <tt>createDispatch()</tt> is:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">public</span> Dispatch<T> createDispatch(QName portName, javax.xml.bind.JAXBContext context, Service.Mode mode)
-<span class="code-keyword">throws</span> WebServiceException;
-</pre>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+public Dispatch<T> createDispatch(QName portName, javax.xml.bind.JAXBContext context, Service.Mode mode)
+throws WebServiceException;
+]]></script>
</div></div></td></tr></table></div></li></ol>
@@ -216,25 +223,25 @@ Apache CXF -- JAX-WS Dispatch API
<p>The code below creates a <tt>Dispatch</tt> object that works with <tt>DOMSource</tt> objects in payload mode.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> com.mycompany.demo;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package com.mycompany.demo;
-<span class="code-keyword">import</span> javax.xml.namespace.QName;
-<span class="code-keyword">import</span> javax.xml.ws.Service;
+import javax.xml.namespace.QName;
+import javax.xml.ws.Service;
-<span class="code-keyword">public</span> class Client {
- <span class="code-keyword">public</span> <span class="code-keyword">static</span> void main(<span class="code-object">String</span> args[]) {
- QName serviceName = <span class="code-keyword">new</span> QName(<span class="code-quote">"http:<span class="code-comment">//org.apache.cxf"</span>, <span class="code-quote">"stockQuoteReporter"</span>);
-</span> Service s = Service.create(serviceName);
+public class Client {
+ public static void main(String args[]) {
+ QName serviceName = new QName("http://org.apache.cxf", "stockQuoteReporter");
+ Service s = Service.create(serviceName);
- QName portName = <span class="code-keyword">new</span> QName(<span class="code-quote">"http:<span class="code-comment">//org.apache.cxf"</span>, <span class="code-quote">"stockQuoteReporterPort"</span>);
-</span> Dispatch<DOMSource> dispatch = s.createDispatch(portName,
+ QName portName = new QName("http://org.apache.cxf", "stockQuoteReporterPort");
+ Dispatch<DOMSource> dispatch = s.createDispatch(portName,
DOMSource.class,
Service.Mode.PAYLOAD);
...
}
}
-</pre>
+]]></script>
</div></div>
<h3><a shape="rect" name="JAX-WSDispatchAPI-Constructingrequestmessages"></a>Constructing request messages</h3>
@@ -253,25 +260,25 @@ Apache CXF -- JAX-WS Dispatch API
<p>For consumers that make synchronous invocations that generate a response, you use the <tt>Dispatch</tt> object's <tt>invoke()</tt> method shown bellow.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-T invoke(T msg) <span class="code-keyword">throws</span> WebServiceException;
-</pre>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+T invoke(T msg) throws WebServiceException;
+]]></script>
</div></div>
<p>The type of both the response and the request passed to the <tt>invoke()</tt> method are determined when the Dispatch object is created. For example if you created a <tt>Dispatch</tt> object using <tt>createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE)</tt> the response and the request would both be <tt>SOAPMessage</tt> objects.</p>
<div class="panelMacro"><table class="noteMacro"><colgroup span="1"><col span="1" width="24"><col span="1"></colgroup><tr><td colspan="1" rowspan="1" valign="top"><img align="middle" src="https://cwiki.apache.org/confluence/images/icons/emoticons/warning.gif" width="16" height="16" alt="" border="0"></td><td colspan="1" rowspan="1">When using JAXB objects, the response and the request can be of any type the provided <tt>JAXBContext</tt> object can marshal and unmarshal. Also, the response and the request can be different JAXB objects.</td></tr></table></div>
<p>The code bellow makes a synchronous invocation on a remote service using a <tt>DOMSource</tt> object.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-comment">// Creating a DOMSource <span class="code-object">Object</span> <span class="code-keyword">for</span> the request
-</span>DocumentBuilder db = DocumentBuilderFactory.newDocumentBuilder();
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+// Creating a DOMSource Object for the request
+DocumentBuilder db = DocumentBuilderFactory.newDocumentBuilder();
Document requestDoc = db.newDocument();
-Element root = requestDoc.createElementNS(<span class="code-quote">"http:<span class="code-comment">//org.apache.cxf/stockExample"</span>, <span class="code-quote">"getStockPrice"</span>);
-</span>root.setNodeValue(<span class="code-quote">"DOW"</span>);
-DOMSource request = <span class="code-keyword">new</span> DOMSource(requestDoc);
-
-<span class="code-comment">// Dispatch disp created previously
-</span>DOMSource response = disp.invoke(request);
-</pre>
+Element root = requestDoc.createElementNS("http://org.apache.cxf/stockExample", "getStockPrice");
+root.setNodeValue("DOW");
+DOMSource request = new DOMSource(requestDoc);
+
+// Dispatch disp created previously
+DOMSource response = disp.invoke(request);
+]]></script>
</div></div>
<h4><a shape="rect" name="JAX-WSDispatchAPI-Asynchronousinvocation"></a>Asynchronous invocation</h4>
@@ -280,16 +287,16 @@ DOMSource request = <span class="code-ke
<p>When using the polling approach the <tt>invokeAsync()</tt> method returns a <tt>Response<t></tt> object that can be periodically polled to see if the response has arrived.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-Response <T> invokeAsync(T msg) <span class="code-keyword">throws</span> WebServiceException;
-</pre>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+Response <T> invokeAsync(T msg) throws WebServiceException;
+]]></script>
</div></div>
<p>When using the callback approach the <tt>invokeAsync()</tt> method takes an <tt>AsyncHandler</tt> implementation that processes the response when it is returned.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-Future<?> invokeAsync(T msg, AsyncHandler<T> handler) <span class="code-keyword">throws</span> WebServiceException;
-</pre>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+Future<?> invokeAsync(T msg, AsyncHandler<T> handler) throws WebServiceException;
+]]></script>
</div></div>
<div class="panelMacro"><table class="noteMacro"><colgroup span="1"><col span="1" width="24"><col span="1"></colgroup><tr><td colspan="1" rowspan="1" valign="top"><img align="middle" src="https://cwiki.apache.org/confluence/images/icons/emoticons/warning.gif" width="16" height="16" alt="" border="0"></td><td colspan="1" rowspan="1">As with the synchronous <tt>invoke()</tt> method, the type of the response and the type of the request are determined when you create the <tt>Dispatch</tt> object.</td></tr></table></div>
@@ -298,26 +305,26 @@ Future<?> invokeAsync(T msg, Async
<p>When a request does not generate a response, you make remote invocations using the <tt>Dispatch</tt> object's <tt>invokeOneWay()</tt>.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-void invokeOneWay(T msg) <span class="code-keyword">throws</span> WebServiceException;
-</pre>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+void invokeOneWay(T msg) throws WebServiceException;
+]]></script>
</div></div>
<p>The type of object used to package the request is determined when the <tt>Dispatch</tt> object is created. For example if the <tt>Dispatch</tt> object is created using <tt>createDispatch(portName, DOMSource.class, Service.Mode.PAYLOAD)</tt> the request would be packaged into a <tt>DOMSource</tt> object.</p>
<div class="panelMacro"><table class="noteMacro"><colgroup span="1"><col span="1" width="24"><col span="1"></colgroup><tr><td colspan="1" rowspan="1" valign="top"><img align="middle" src="https://cwiki.apache.org/confluence/images/icons/emoticons/warning.gif" width="16" height="16" alt="" border="0"></td><td colspan="1" rowspan="1">When using JAXB objects, the response and the request can be of any type the provided <tt>JAXBContext</tt> object can marshal and unmarshal. Also, the response and the request can be different JAXB objects.</td></tr></table></div>
<p>The code bellow makes a one way invocation on a remote service using a JAXB object.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-comment">// Creating a JAXBContext and an Unmarshaller <span class="code-keyword">for</span> the request
-</span>JAXBContext jbc = JAXBContext.newInstance(<span class="code-quote">"com.mycompany.StockExample"</span>);
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+// Creating a JAXBContext and an Unmarshaller for the request
+JAXBContext jbc = JAXBContext.newInstance("com.mycompany.StockExample");
Unmarshaller u = jbc.createUnmarshaller();
-<span class="code-comment">// Read the request from disk
-</span>File rf = <span class="code-keyword">new</span> File(<span class="code-quote">"request.xml"</span>);
+// Read the request from disk
+File rf = new File("request.xml");
GetStockPrice request = (GetStockPrice)u.unmarshal(rf);
-<span class="code-comment">// Dispatch disp created previously
-</span>disp.invokeOneWay(request);
-</pre>
+// Dispatch disp created previously
+disp.invokeOneWay(request);
+]]></script>
</div></div>
Modified: websites/production/cxf/content/docs/jax-ws.html
==============================================================================
--- websites/production/cxf/content/docs/jax-ws.html (original)
+++ websites/production/cxf/content/docs/jax-ws.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 - JAX-WS">
+
+
<title>
Apache CXF -- JAX-WS
</title>
@@ -42,19 +44,15 @@ Apache CXF -- JAX-WS
<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 -- JAX-WS
<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/jaxb.html
==============================================================================
--- websites/production/cxf/content/docs/jaxb.html (original)
+++ websites/production/cxf/content/docs/jaxb.html Mon Jun 24 17:10:51 2013
@@ -25,6 +25,17 @@
<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 - 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 type="text/javascript">
+ SyntaxHighlighter.defaults['toolbar'] = false;
+ SyntaxHighlighter.all();
+ </script>
+
<title>
Apache CXF -- JAXB
</title>
@@ -42,19 +53,15 @@ Apache CXF -- 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 +101,7 @@ Apache CXF -- 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>
@@ -145,21 +152,21 @@ Apache CXF -- JAXB
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<jaxws:server id=<span class="code-quote">"bookServer"</span>
- serviceClass=<span class="code-quote">"org.myorg.mytypes.AnonymousComplexTypeImpl"</span>
- address=<span class="code-quote">"http:<span class="code-comment">//localhost:8080/act"</span>
-</span> bus=<span class="code-quote">"cxf"</span>>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+<jaxws:server id="bookServer"
+ serviceClass="org.myorg.mytypes.AnonymousComplexTypeImpl"
+ address="http://localhost:8080/act"
+ bus="cxf">
<jaxws:invoker>
- <bean class=<span class="code-quote">"org.apache.cxf.service.invoker.BeanInvoker"</span>>
+ <bean class="org.apache.cxf.service.invoker.BeanInvoker">
<constructor-arg>
- <bean class=<span class="code-quote">"org.myorg.mytypes.AnonymousComplexTypeImpl"</span>/>
+ <bean class="org.myorg.mytypes.AnonymousComplexTypeImpl"/>
</constructor-arg>
</bean>
</jaxws:invoker>
<jaxws:dataBinding>
- <bean class=<span class="code-quote">"org.apache.cxf.jaxb.JAXBDataBinding"</span>>
- <property name=<span class="code-quote">"contextProperties"</span>>
+ <bean class="org.apache.cxf.jaxb.JAXBDataBinding">
+ <property name="contextProperties">
<map>
<entry>
<key><value>com.sun.xml.bind.defaultNamespaceRemap</value></key>
@@ -170,7 +177,7 @@ Apache CXF -- JAXB
</bean>
</jaxws:dataBinding>
</jaxws:server>
-</pre>
+]]></script>
</div></div>
<h2><a shape="rect" name="JAXB-ActivatingJAXBValidationofSOAPrequestsandresponses"></a>Activating JAXB Validation of SOAP requests and responses</h2>
@@ -183,32 +190,32 @@ Apache CXF -- JAXB
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<jaxws:server id=<span class="code-quote">"bookServer"</span>
- serviceClass=<span class="code-quote">"org.myorg.mytypes.AnonymousComplexTypeImpl"</span>
- address=<span class="code-quote">"http:<span class="code-comment">//localhost:8080/act"</span>
-</span> bus=<span class="code-quote">"cxf"</span>>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+<jaxws:server id="bookServer"
+ serviceClass="org.myorg.mytypes.AnonymousComplexTypeImpl"
+ address="http://localhost:8080/act"
+ bus="cxf">
<jaxws:invoker>
- <bean class=<span class="code-quote">"org.apache.cxf.service.invoker.BeanInvoker"</span>>
+ <bean class="org.apache.cxf.service.invoker.BeanInvoker">
<constructor-arg>
- <bean class=<span class="code-quote">"org.myorg.mytypes.AnonymousComplexTypeImpl"</span>/>
+ <bean class="org.myorg.mytypes.AnonymousComplexTypeImpl"/>
</constructor-arg>
</bean>
</jaxws:invoker>
<jaxws:dataBinding>
- <bean class=<span class="code-quote">"org.apache.cxf.jaxb.JAXBDataBinding"</span>>
- <property name=<span class="code-quote">"namespaceMap"</span>>
+ <bean class="org.apache.cxf.jaxb.JAXBDataBinding">
+ <property name="namespaceMap">
<map>
<entry>
- <key><value>http:<span class="code-comment">//cxf.apache.org/anonymous_complex_type/</value></key>
-</span> <value>BeepBeep</value>
+ <key><value>http://cxf.apache.org/anonymous_complex_type/</value></key>
+ <value>BeepBeep</value>
</entry>
</map>
</property>
</bean>
</jaxws:dataBinding>
</jaxws:server>
-</pre>
+]]></script>
</div></div></div>
</div>
<!-- Content -->
Modified: websites/production/cxf/content/docs/jaxrs-kerberos.html
==============================================================================
--- websites/production/cxf/content/docs/jaxrs-kerberos.html (original)
+++ websites/production/cxf/content/docs/jaxrs-kerberos.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 - JAXRS Kerberos">
+
+ <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 -- JAXRS Kerberos
</title>
@@ -42,19 +54,15 @@ Apache CXF -- JAXRS Kerberos
<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 -- JAXRS Kerberos
<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>
@@ -192,9 +200,9 @@ Please follow the step 1.4 from <a shape
<p>'Negotiate' authentication scheme is used to pass Kerberos service tickets over HTTP.<br clear="none">
Example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-Authorization: Negotiate <span class="code-quote">"the encrypted service ticket"</span>
-</pre>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+Authorization: Negotiate "the encrypted service ticket"
+]]></script>
</div></div>
<h2><a shape="rect" name="JAXRSKerberos-GSSAPI"></a>GSS API</h2>
@@ -225,20 +233,20 @@ especially when SSL is also being setup
<p>As explained on <a shape="rect" href="http://cxf.apache.org/docs/client-http-transport-including-ssl-support.html#ClientHTTPTransport%28includingSSLsupport%29-SpnegoAuthentication%28Kerberos%29">this page</a>, Authorization Policy typically needs to have its type set to "Negotiate" and its "authorization" property set to the name of the JAAS context. AuthorizationPolicy is set as a "policy" property on the interceptor, example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-WebClient wc = WebClient.create(<span class="code-quote">"http:<span class="code-comment">//localhost:"</span> + PORT + <span class="code-quote">"/bookstore/books/123"</span>);
-</span>
-KerberosAuthOutInterceptor kbInterceptor = <span class="code-keyword">new</span> KerberosAuthOutInterceptor();
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+WebClient wc = WebClient.create("http://localhost:" + PORT + "/bookstore/books/123");
+
+KerberosAuthOutInterceptor kbInterceptor = new KerberosAuthOutInterceptor();
-AuthorizationPolicy policy = <span class="code-keyword">new</span> AuthorizationPolicy();
+AuthorizationPolicy policy = new AuthorizationPolicy();
policy.setAuthorizationType(HttpAuthHeader.AUTH_TYPE_NEGOTIATE);
-policy.setAuthorization(<span class="code-quote">"KerberosClientKeyTab"</span>);
+policy.setAuthorization("KerberosClientKeyTab");
kbInterceptor.setPolicy(policy);
WebClient.getConfig(wc).getOutInterceptors().add(kbInterceptor);
Book b = wc.get(Book.class);
-</pre>
+]]></script>
</div></div>
<p>In this example, the <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/systests/jaxrs/src/test/java/org/apache/cxf/systest/jaxrs/security/kerberos.cfg">KerberosClientKeyTab</a> policy is used which links to the available keytab; otherwise AuthorizationPolicy 'UserName' and 'Password' properties would most likely have to be set too (with the possible exceptions on Windows) </p>
@@ -270,21 +278,21 @@ Finally, if the user actually owns the J
<p>org.apache.cxf.jaxrs.security.KerberosAuthenticationFilter can be used to protected JAX-RS endpoints and enforce that a Negotiate authentication scheme is used by clients, example:</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"><bean id=<span class="code-quote">"kerberosFilter"</span> class=<span class="code-quote">"org.apache.cxf.jaxrs.security.KerberosAuthenticationFilter"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"loginContextName"</span> value=<span class="code-quote">"KerberosServiceKeyTab"</span>/></span>
-<span class="code-tag"></bean></span>
-
-<span class="code-tag"><jaxrs:server></span>
- <span class="code-tag"><jaxrs:serviceBeans></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.mycompany.MyCompanyResource"</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">"kerberosFilter"</span>></span>
- <span class="code-tag"></jaxrs:providers></span>
-<span class="code-tag"></jaxrs:server></span>
-</pre>
+<bean id="kerberosFilter" class="org.apache.cxf.jaxrs.security.KerberosAuthenticationFilter">
+ <property name="loginContextName" value="KerberosServiceKeyTab"/>
+</bean>
+
+<jaxrs:server>
+ <jaxrs:serviceBeans>
+ <bean class="org.mycompany.MyCompanyResource"/>
+ </jaxrs:serviceBeans>
+ <jaxrs:providers>
+ <ref bean="kerberosFilter">
+ </jaxrs:providers>
+</jaxrs:server>
+]]></script>
</div></div>
<p>KerberosAuthenticationFilter will set a CXF <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/api/src/main/java/org/apache/cxf/security/SecurityContext.java">SecurityContext</a> on the current message if the authentication has been successful. This SecurityContext will return an instance of KerberosAuthenticationFilter$KerberosPrincipal, this Principal will return a 'simple' and 'kerberos' source principal names, example, given "HTTP/localhost@myrealm.com", Principal#getName will return "HTTP/localhost", and KerberosPrincipal#getKerberosName will return "HTTP/localhost@myrealm.com".</p>
@@ -298,27 +306,27 @@ Finally, if the user actually owns the J
<p>javax.security.auth.callback.CallbackHandler needs to be registered if no Kerberos key tabs are used, here is an example of setting it up from Java:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">public</span> class TestResource {
- <span class="code-keyword">public</span> <span class="code-keyword">static</span> void main(<span class="code-object">String</span>[] args) {
- JAXRSServerFactoryBean sf = <span class="code-keyword">new</span> JAXRSServerFactoryBean();
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+public class TestResource {
+ public static void main(String[] args) {
+ JAXRSServerFactoryBean sf = new JAXRSServerFactoryBean();
sf.setResourceClasses(BookStore.class);
- KerberosAuthenticationFilter filter = <span class="code-keyword">new</span> KerberosAuthenticationFilter();
- filter.setLoginContextName(<span class="code-quote">"KerberosServer"</span>);
+ KerberosAuthenticationFilter filter = new KerberosAuthenticationFilter();
+ filter.setLoginContextName("KerberosServer");
CallbackHandler handler =
- <span class="code-keyword">new</span> org.apache.cxf.interceptor.security.NamePasswordCallbackHandler(<span class="code-quote">"HTTP/localhost"</span>, <span class="code-quote">"http"</span>);
+ new org.apache.cxf.interceptor.security.NamePasswordCallbackHandler("HTTP/localhost", "http");
filter.setCallbackHandler(handler);
- <span class="code-comment">//filter.setLoginContextName(<span class="code-quote">"KerberosServerKeyTab"</span>);
-</span> <span class="code-comment">//filter.setServicePrincipalName(<span class="code-quote">"HTTP/ktab"</span>);
-</span> sf.setProvider(filter);
- sf.setAddress(<span class="code-quote">"http:<span class="code-comment">//localhost:"</span> + PORT + <span class="code-quote">"/"</span>);
-</span>
+ //filter.setLoginContextName("KerberosServerKeyTab");
+ //filter.setServicePrincipalName("HTTP/ktab");
+ sf.setProvider(filter);
+ sf.setAddress("http://localhost:" + PORT + "/");
+
sf.create();
}
}
-</pre>
+]]></script>
</div></div>
<p>In this example, the <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/systests/jaxrs/src/test/java/org/apache/cxf/systest/jaxrs/security/kerberos.cfg">KerberosServer</a> policy is used.</p>
@@ -330,34 +338,34 @@ Finally, if the user actually owns the J
<p>Note that if you have a JAX-RS KerberosAuthenticationFilter protecting the endpoints, then the filter will have an org.ietf.jgss.GSSContext instance available in the current CXF SecurityContext, via its KerberosAuthenticationFilter$KerberosSecurityContext implementation, which can be used to get to org.ietf.jgss.GSSCredential if the credential delegation is supported for a given source principal. The current credential if any can be set as a client property next, for 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[
-<span class="code-keyword">import</span> org.ietf.jgss.GSSCredential;
+import org.ietf.jgss.GSSCredential;
-<span class="code-keyword">import</span> org.apache.cxf.jaxrs.security.KerberosAuthenticationFilter;
-<span class="code-keyword">import</span> org.apache.cxf.jaxrs.security.KerberosAuthenticationFilter.KerberosSecurityContext;
+import org.apache.cxf.jaxrs.security.KerberosAuthenticationFilter;
+import org.apache.cxf.jaxrs.security.KerberosAuthenticationFilter.KerberosSecurityContext;
-@Path(<span class="code-quote">"service"</span>)
-<span class="code-keyword">public</span> class MyResource {
+@Path("service")
+public class MyResource {
@Context
- <span class="code-keyword">private</span> javax.ws.rs.core.SecurityContext securityContext;
+ private javax.ws.rs.core.SecurityContext securityContext;
@GET
- <span class="code-keyword">public</span> Book getBookFromKerberosProtectedStore() {
- WebClient wc = webClient.create(<span class="code-quote">"http:<span class="code-comment">//internal.com/store"</span>);
-</span> <span class="code-keyword">if</span> (securityContext <span class="code-keyword">instanceof</span> KerberosSecurityContext) {
+ public Book getBookFromKerberosProtectedStore() {
+ WebClient wc = webClient.create("http://internal.com/store");
+ if (securityContext instanceof KerberosSecurityContext) {
KerberosSecurityContext ksc = (KerberosSecurityContext)securityContext;
GSSCredential cred = ksc.getGSSContext().getDelegCred();
- <span class="code-keyword">if</span> (cred != <span class="code-keyword">null</span>) {
+ if (cred != null) {
WebClient.getConfig(wc).getRequestContext().put(GSSCredential.class.getName(), cred);
}
}
- <span class="code-keyword">return</span> wc.get(Book.class);
+ return wc.get(Book.class);
}
}
-</pre>
+]]></script>
</div></div>
<p>The HTTPConduit or KerberosAuthOutInterceptor handler will use the available GSSCredential.</p>