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 [16/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/how-to-define-policies.html
==============================================================================
--- websites/production/cxf/content/docs/how-to-define-policies.html (original)
+++ websites/production/cxf/content/docs/how-to-define-policies.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 - How to Define Policies">
+
+ <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 -- How to Define Policies
</title>
@@ -42,19 +54,15 @@ Apache CXF -- How to Define Policies
<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 -- How to Define Policies
<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>
@@ -130,59 +138,59 @@ Apache CXF -- How to Define Policies
<h4><a shape="rect" name="HowtoDefinePolicies-WSDLPolicyattachment"></a>WSDL Policy attachment</h4>
<p>WS-Policies can be attached and referenced in WSDL elements. <a shape="rect" class="external-link" href="http://www.w3.org/TR/ws-policy-attach/" rel="nofollow">Web Services Policy 1.5 - Attachment </a> standard describes all possible alternatives. WS-Policies can be placed inside WSDL itself or referenced as external documents. CXF will automatically recognize, read and use policies defined or referenced in WSDL. Sample of attached policy is shown below:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<wsdl:definitions name=<span class="code-quote">"HelloWorld"</span> targetNamespace=<span class="code-quote">"http://apache.org/hello_world_soap_http"</span>
-…
-<span class="code-tag"><wsdl:service name=<span class="code-quote">"SOAPService"</span>></span>
- <span class="code-tag"><wsdl:port binding=<span class="code-quote">"tns:Greeter_SOAPBinding"</span> name=<span class="code-quote">"SoapPort"</span>></span>
- <span class="code-tag"><soap:address location=<span class="code-quote">"http://localhost:9000/SoapContext/SoapPort"</span>/></span>
- <span class="code-tag"><wsp:Policy <span class="code-keyword">xmlns:wsp</span>=<span class="code-quote">"http://www.w3.org/ns/ws-policy"</span>></span>
- <span class="code-tag"><wsam:Addressing <span class="code-keyword">xmlns:wsam</span>=<span class="code-quote">"http://www.w3.org/2007/02/addressing/metadata"</span>></span>
- <span class="code-tag"><wsp:Policy/></span>
- <span class="code-tag"></wsam:Addressing></span>
- <span class="code-tag"></wsp:Policy></span>
- <span class="code-tag"></wsdl:port></span>
-<span class="code-tag"></wsdl:service></span>
-<span class="code-tag"></wsdl:definitions></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<wsdl:definitions name="HelloWorld" targetNamespace="http://apache.org/hello_world_soap_http"
+É
+<wsdl:service name="SOAPService">
+ <wsdl:port binding="tns:Greeter_SOAPBinding" name="SoapPort">
+ <soap:address location="http://localhost:9000/SoapContext/SoapPort"/>
+ <wsp:Policy xmlns:wsp="http://www.w3.org/ns/ws-policy">
+ <wsam:Addressing xmlns:wsam="http://www.w3.org/2007/02/addressing/metadata">
+ <wsp:Policy/>
+ </wsam:Addressing>
+ </wsp:Policy>
+ </wsdl:port>
+</wsdl:service>
+</wsdl:definitions>
+]]></script>
</div></div>
<h4><a shape="rect" name="HowtoDefinePolicies-Springconfiguration"></a>Spring configuration</h4>
<p>It is possible to define policies directly in Spring configuration of client and service as jaxws feature. CXF will recognize and use configured WS-Policies:<br clear="none">
Client:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<jaxws:client id=<span class="code-quote">"CRMServiceClient"</span> name=<span class="code-quote">"{http://services.talend.org/CRMService}CRMServiceProvider"</span>
- <span class="code-keyword">xmlns:serviceNamespace</span>=<span class="code-quote">"http://services.talend.org/CRMService"</span>
- serviceClass=<span class="code-quote">"org.talend.services.crmservice.CRMService"</span>
- serviceName=<span class="code-quote">"serviceNamespace:CRMServiceProvider"</span>
- endpointName=<span class="code-quote">"serviceNamespace:CRMServicePort"</span>
- address=<span class="code-quote">"${endpoint.prefix}/CRMServiceProvider"</span>>
- <span class="code-tag"><jaxws:features></span>
- <span class="code-tag"><p:policies></span>
- <span class="code-tag"><wsp:PolicyReference URI=<span class="code-quote">"classpath:/saml.policy"</span>/></span>
- <span class="code-tag"></p:policies></span>
- <span class="code-tag"></jaxws:features></span>
-<span class="code-tag"></jaxws:client></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<jaxws:client id="CRMServiceClient" name="{http://services.talend.org/CRMService}CRMServiceProvider"
+ xmlns:serviceNamespace="http://services.talend.org/CRMService"
+ serviceClass="org.talend.services.crmservice.CRMService"
+ serviceName="serviceNamespace:CRMServiceProvider"
+ endpointName="serviceNamespace:CRMServicePort"
+ address="${endpoint.prefix}/CRMServiceProvider">
+ <jaxws:features>
+ <p:policies>
+ <wsp:PolicyReference URI="classpath:/saml.policy"/>
+ </p:policies>
+ </jaxws:features>
+</jaxws:client>
+]]></script>
</div></div>
<p>Service:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<jaxws:endpoint id=<span class="code-quote">"CRMService"</span>
- <span class="code-keyword">xmlns:serviceNamespace</span>=<span class="code-quote">"http://services.talend.org/CRMService"</span>
- serviceName=<span class="code-quote">"serviceNamespace:CRMServiceProvider"</span>
- endpointName=<span class="code-quote">"serviceNamespace:CRMServicePort"</span>
- implementor=<span class="code-quote">"#CRMServiceBean"</span>
- address=<span class="code-quote">"/CRMServiceProvider"</span>>
- <span class="code-tag"><jaxws:features></span>
- <span class="code-tag"><p:policies></span>
- <span class="code-tag"><wsp:PolicyReference URI=<span class="code-quote">"classpath:/saml.policy"</span>/></span>
- <span class="code-tag"></p:policies></span>
- <span class="code-tag"></jaxws:features></span>
-<span class="code-tag"></jaxws:endpoint></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<jaxws:endpoint id="CRMService"
+ xmlns:serviceNamespace="http://services.talend.org/CRMService"
+ serviceName="serviceNamespace:CRMServiceProvider"
+ endpointName="serviceNamespace:CRMServicePort"
+ implementor="#CRMServiceBean"
+ address="/CRMServiceProvider">
+ <jaxws:features>
+ <p:policies>
+ <wsp:PolicyReference URI="classpath:/saml.policy"/>
+ </p:policies>
+ </jaxws:features>
+</jaxws:endpoint>
+]]></script>
</div></div>
<h4><a shape="rect" name="HowtoDefinePolicies-Dynamicallyviamessageproperty"></a>Dynamically via message property</h4>
Modified: websites/production/cxf/content/docs/how-tos.html
==============================================================================
--- websites/production/cxf/content/docs/how-tos.html (original)
+++ websites/production/cxf/content/docs/how-tos.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 - How-Tos">
+
+
<title>
Apache CXF -- How-Tos
</title>
@@ -42,19 +44,15 @@ Apache CXF -- How-Tos
<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 -- How-Tos
<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/http-binding.html
==============================================================================
--- websites/production/cxf/content/docs/http-binding.html (original)
+++ websites/production/cxf/content/docs/http-binding.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 - HTTP Binding">
+
+ <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 -- HTTP Binding
</title>
@@ -42,19 +54,15 @@ Apache CXF -- HTTP Binding
<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 -- HTTP Binding
<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>
@@ -128,18 +136,18 @@ Apache CXF -- HTTP Binding
<h1><a shape="rect" name="HTTPBinding-Conventionbasedservices"></a>Convention based services</h1>
<p>If you have a simple CRUD based Java class, CXF can try to build up a set of resources automatically for you with no annotations or configuration. This is best explained through an example. Lets take a look at a typical CRUD class:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">import</span> javax.jws.WebService;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+import javax.jws.WebService;
@WebService
-<span class="code-keyword">public</span> <span class="code-keyword">interface</span> PeopleService {
+public interface PeopleService {
Collection<Person> getPeople();
- Person getPerson(<span class="code-object">long</span> id);
+ Person getPerson(long id);
void addPerson(Person person);
- void updatePerson(<span class="code-object">long</span> id, Person person);
- void deletePerson(<span class="code-object">long</span> id);
+ void updatePerson(long id, Person person);
+ void deletePerson(long id);
}
-</pre>
+]]></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"><b>WebService Annotation</b><br clear="none">The <tt>@WebService</tt> annotation is required.</td></tr></table></div>
@@ -150,12 +158,12 @@ Apache CXF -- HTTP Binding
<p>That's straightforward enough. We see "get", we map it to a GET operation. Then people is extracted from the operation name and turned into a simple URI. Accessing <a shape="rect" class="external-link" href="http://server/people" rel="nofollow">http://server/people</a> would result in a document like so:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><getPeople></span>
-<span class="code-tag"><Person></span>...<span class="code-tag"></Person></span>
-<span class="code-tag"><Person></span>...<span class="code-tag"></Person></span>
-<span class="code-tag"></getPeople></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<getPeople>
+<Person>...</Person>
+<Person>...</Person>
+</getPeople>
+]]></script>
</div></div>
<p><b>2: Person getPerson(id)</b> is mapped to an HTTP GET on /people/{id}.</p>
@@ -179,18 +187,18 @@ Apache CXF -- HTTP Binding
<h2><a shape="rect" name="HTTPBinding-Configuringtheservice"></a>Configuring the service</h2>
<p>You can create a service which uses the HTTP binding by using JaxWsFactoryBean:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-JaxWsServerFactoryBean sf = <span class="code-keyword">new</span> JaxWsServerFactoryBean();
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+JaxWsServerFactoryBean sf = new JaxWsServerFactoryBean();
sf.setServiceClass(PeopleService.class);
-sf.getServiceFactory().setWrapped(<span class="code-keyword">true</span>);
+sf.getServiceFactory().setWrapped(true);
sf.setBindingId(HttpBindingFactory.HTTP_BINDING_ID);
-sf.setAddress(<span class="code-quote">"http:<span class="code-comment">//localhost:9001/"</span>);
-</span>
-PeopleService peopleService = <span class="code-keyword">new</span> PeopleServiceImpl();
-sf.getServiceFactory().setInvoker(<span class="code-keyword">new</span> BeanInvoker(peopleService));
+sf.setAddress("http://localhost:9001/");
+
+PeopleService peopleService = new PeopleServiceImpl();
+sf.getServiceFactory().setInvoker(new BeanInvoker(peopleService));
Server svr = sf.create();
-</pre>
+]]></script>
</div></div>
<p>A couple things to note:</p>
@@ -203,11 +211,11 @@ Server svr = sf.create();
<p>Lets say I want to build an HTTP service that shares and manipulates customer data. The first thing I might want to do is create a URI that returns a document of all the customers in my database. With the JRA annotations this would be done like so:</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[
@Get
-@HttpResource(location=<span class="code-quote">"/customers"</span>)
+@HttpResource(location="/customers")
Collection<Customer> getCustomers();
-</pre>
+]]></script>
</div></div>
<p>The @Get annotation maps the operation to the GET verb and the @HttpResource maps it to the URI "/customers". The List gets sent off the databinding implementation you're using and will be serialized as a document. So far very simple!</p>
@@ -215,37 +223,37 @@ Collection<Customer> getCustomers(
<p>Now lets say I want to pull down a specific customer, from /customers/ID:</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[
@Get
-@HttpResource(location=<span class="code-quote">"/customers/{id}"</span>)
+@HttpResource(location="/customers/{id}")
Customer getCustomers(GetCustomer getCustomer);
-</pre>
+]]></script>
</div></div>
<p>The major new concept in this example is URI templates. The GetCustomer object has a single property named "id":</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">public</span> class GetCustomer {
- <span class="code-object">String</span> getId() { .. }
- void setId(<span class="code-object">String</span> id) { .. }
-</pre>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+public class GetCustomer {
+ String getId() { .. }
+ void setId(String id) { .. }
+]]></script>
</div></div>
<p>The URI parameters get mapped to the XML document according to its schema and the WSDL 2 rules. So if you access the URL /customers/123 CXF will actually synthesize an incoming XML document like this:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><getCustomer></span><span class="code-tag"><id></span>123<span class="code-tag"></id></span><span class="code-tag"></getCustomer></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<getCustomer><id>123</id></getCustomer>
+]]></script>
</div></div>
<p>The databinding layer will then convert this into the GetCustomer object. Lets move on to a more complex example - a PUT operation which updates the customer:</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[
@Put
-@HttpResource(location=<span class="code-quote">"/customers/{id}"</span>)
+@HttpResource(location="/customers/{id}")
Customer updateCustomer(Customer customer);
-</pre>
+]]></script>
</div></div>
<p>Instead of synthesizing a document this time, we're actually merging the URI parameters into the incoming document. This means {id} will get mapped to the /customer/id of the incoming customer document. Since the document will most likely already have the customer ID in it, the {id} is primarily there to create nice looking URI.</p>
@@ -253,11 +261,11 @@ Customer updateCustomer(Customer custome
<p>For a final example, lets look at adding a customer:</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[
@Post
-@HttpResource(location=<span class="code-quote">"/customers"</span>)
+@HttpResource(location="/customers")
void addCustomer(Customer customer);
-</pre>
+]]></script>
</div></div>
<p>This will allow users to do a POST to the /customers URI with their document and add it to the collection of customers contained there.</p>
@@ -266,127 +274,127 @@ void addCustomer(Customer customer);
<p>To use multiple arguments, the @WebParam annotation has to be used to map the parameters of the url to the service parameters.<br clear="none">
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[
@Get
-@HttpResource(location=<span class="code-quote">"/customers/{first}/{last}"</span>)
-void findCustomer(@WebParam(name=<span class="code-quote">"first"</span>) <span class="code-object">String</span> firstName, @WebParam(name=<span class="code-quote">"last"</span>) <span class="code-object">String</span> lastName);
-</pre>
+@HttpResource(location="/customers/{first}/{last}")
+void findCustomer(@WebParam(name="first") String firstName, @WebParam(name="last") String lastName);
+]]></script>
</div></div>
<h2><a shape="rect" name="HTTPBinding-ConfiguringtheService"></a>Configuring the Service</h2>
<p>Configuration for JRA style services is exactly the same as the convention based services. However, in this example, the service is not in "wrapped" mode. So the configuration is slightly different as we don't need to explicitly set the wrapped setting:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-JaxWsServerFactoryBean sf = <span class="code-keyword">new</span> JaxWsServerFactoryBean();
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+JaxWsServerFactoryBean sf = new JaxWsServerFactoryBean();
sf.setServiceClass(CustomerService.class);
-sf.setBindingFactory(<span class="code-keyword">new</span> HttpBindingInfoFactoryBean());
-sf.setAddress(<span class="code-quote">"http:<span class="code-comment">//localhost:9001/"</span>);
-</span>
-CustomerService customerService = <span class="code-keyword">new</span> CustomerServiceImpl();
-sf.getServiceFactory().setInvoker(<span class="code-keyword">new</span> BeanInvoker(customerService));
+sf.setBindingFactory(new HttpBindingInfoFactoryBean());
+sf.setAddress("http://localhost:9001/");
+
+CustomerService customerService = new CustomerServiceImpl();
+sf.getServiceFactory().setInvoker(new BeanInvoker(customerService));
Server svr = sf.create();
-</pre>
+]]></script>
</div></div>
<h2><a shape="rect" name="HTTPBinding-ConfiguringtheserviceincontainerwithSpringconfigurationfile."></a>Configuring the service in container with Spring configuration file.</h2>
<h3><a shape="rect" name="HTTPBinding-web.xml"></a>web.xml</h3>
<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">"ISO-8859-1"</span>?></span>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE web-app
- PUBLIC <span class="code-quote">"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"</span>
- <span class="code-quote">"http://java.sun.com/dtd/web-app_2_3.dtd"</span>>
-<span class="code-tag"><web-app></span>
- <span class="code-tag"><context-param></span>
- <span class="code-tag"><param-name></span>contextConfigLocation<span class="code-tag"></param-name></span>
- <span class="code-tag"><param-value></span>WEB-INF/beans.xml<span class="code-tag"></param-value></span>
- <span class="code-tag"></context-param></span>
+ PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
+ "http://java.sun.com/dtd/web-app_2_3.dtd">
+<web-app>
+ <context-param>
+ <param-name>contextConfigLocation</param-name>
+ <param-value>WEB-INF/beans.xml</param-value>
+ </context-param>
- <span class="code-tag"><listener></span>
- <span class="code-tag"><listener-class></span>
+ <listener>
+ <listener-class>
org.springframework.web.context.ContextLoaderListener
- <span class="code-tag"></listener-class></span>
- <span class="code-tag"></listener></span>
+ </listener-class>
+ </listener>
- <span class="code-tag"><servlet></span>
- <span class="code-tag"><servlet-name></span>CXFServlet<span class="code-tag"></servlet-name></span>
- <span class="code-tag"><display-name></span>CXF Servlet<span class="code-tag"></display-name></span>
- <span class="code-tag"><servlet-class></span>
+ <servlet>
+ <servlet-name>CXFServlet</servlet-name>
+ <display-name>CXF Servlet</display-name>
+ <servlet-class>
org.apache.cxf.transport.servlet.CXFServlet
- <span class="code-tag"></servlet-class></span>
- <span class="code-tag"><load-on-startup></span>1<span class="code-tag"></load-on-startup></span>
- <span class="code-tag"></servlet></span>
-
- <span class="code-tag"><servlet-mapping></span>
- <span class="code-tag"><servlet-name></span>CXFServlet<span class="code-tag"></servlet-name></span>
- <span class="code-tag"><url-pattern></span>/*<span class="code-tag"></url-pattern></span>
- <span class="code-tag"></servlet-mapping></span>
-<span class="code-tag"></web-app></span>
-</pre>
+ </servlet-class>
+ <load-on-startup>1</load-on-startup>
+ </servlet>
+
+ <servlet-mapping>
+ <servlet-name>CXFServlet</servlet-name>
+ <url-pattern>/*</url-pattern>
+ </servlet-mapping>
+</web-app>
+]]></script>
</div></div>
<h3><a shape="rect" name="HTTPBinding-beans.xml"></a>beans.xml</h3>
<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: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[
+<?xml version="1.0" encoding="UTF-8"?>
+<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.xsd
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-http-binding.xml"</span>/></span>
- <span class="code-tag"><import resource=<span class="code-quote">"classpath:META-INF/cxf/cxf-servlet.xml"</span>/></span>
+ <import resource="classpath:META-INF/cxf/cxf.xml"/>
+ <import resource="classpath:META-INF/cxf/cxf-extension-http-binding.xml"/>
+ <import resource="classpath:META-INF/cxf/cxf-servlet.xml"/>
- <jaxws:endpoint id=<span class="code-quote">"userService"</span>
- implementor=<span class="code-quote">"org.apache.cxf.CustomerServiceImpl"</span>
- address=<span class="code-quote">"/customerService"</span>
- bindingUri=<span class="code-quote">"http://apache.org/cxf/binding/http"</span>>
- <span class="code-tag"><jaxws:serviceFactory></span>
- <span class="code-tag"><bean class=<span class="code-quote">"org.apache.cxf.jaxws.support.JaxWsServiceFactoryBean"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"wrapped"</span> value=<span class="code-quote">"true"</span> /></span>
- <span class="code-tag"></bean></span>
- <span class="code-tag"></jaxws:serviceFactory></span>
- <span class="code-tag"></jaxws:endpoint></span>
+ <jaxws:endpoint id="userService"
+ implementor="org.apache.cxf.CustomerServiceImpl"
+ address="/customerService"
+ bindingUri="http://apache.org/cxf/binding/http">
+ <jaxws:serviceFactory>
+ <bean class="org.apache.cxf.jaxws.support.JaxWsServiceFactoryBean">
+ <property name="wrapped" value="true" />
+ </bean>
+ </jaxws:serviceFactory>
+ </jaxws:endpoint>
-<span class="code-tag"></beans></span>
-</pre>
+</beans>
+]]></script>
</div></div>
<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"><b>Useful Information</b><br clear="none">The JaxWsServiceFactoryBean is not resusable across various services.</td></tr></table></div>
<h1><a shape="rect" name="HTTPBinding-Wrappedvs.UnwrappedMode"></a>Wrapped vs. Unwrapped Mode</h1>
<p>In REST style services we can only send and receive one XML element. Wrapping is the process of wrapping the XML requests/responses with the operation names to allow multiple parameters to your operation. For instance, say we had an operation "Customer findCustomer(String name, String company)". It would not be valid to create an XML POST request like this:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><name></span>Dan<span class="code-tag"></name></span>
-<span class="code-tag"><company></span>Acme Inc<span class="code-tag"></company></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<name>Dan</name>
+<company>Acme Inc</company>
+]]></script>
</div></div>
<p>That has two root XML elements, which isn't allowed. Instead we would have to "wrap" the POST with the operation name:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><findCustomers></span>
-<span class="code-tag"><name></span>Dan<span class="code-tag"></name></span>
-<span class="code-tag"><company></span>Acme Inc<span class="code-tag"></company></span>
-<span class="code-tag"></findCustomers></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<findCustomers>
+<name>Dan</name>
+<company>Acme Inc</company>
+</findCustomers>
+]]></script>
</div></div>
<p>You may be wondering why don't we always turn on wrapping? Well wrapping creates uglier XML. Take this operation for instance: Collection<Customer> getCustomers(). The resulting XML would be:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><getCustomersResponse></span>
-<span class="code-tag"><Customers></span>
-<span class="code-tag"><Customer></span>..<span class="code-tag"></Customer></span>
-<span class="code-tag"><Customer></span>..<span class="code-tag"></Customer></span>
-<span class="code-tag"></Customers></span>
-<span class="code-tag"></getCustomersResponse></span>
-</pre>
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
+<getCustomersResponse>
+<Customers>
+<Customer>..</Customer>
+<Customer>..</Customer>
+</Customers>
+</getCustomersResponse>
+]]></script>
</div></div>
<p>The getCustomersResponse element is not needed and makes the response uglier. CXF allows you to chose which style you desire. In Wrapped mode you can write your service interface however you desire. </p>
Modified: websites/production/cxf/content/docs/http-transport.html
==============================================================================
--- websites/production/cxf/content/docs/http-transport.html (original)
+++ websites/production/cxf/content/docs/http-transport.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 - HTTP Transport">
+
+
<title>
Apache CXF -- HTTP Transport
</title>
@@ -42,19 +44,15 @@ Apache CXF -- HTTP Transport
<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 -- HTTP Transport
<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/idea-for-new-index.html
==============================================================================
--- websites/production/cxf/content/docs/idea-for-new-index.html (original)
+++ websites/production/cxf/content/docs/idea-for-new-index.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 - Idea for new Index">
+
+
<title>
Apache CXF -- Idea for new Index
</title>
@@ -42,19 +44,15 @@ Apache CXF -- Idea for new Index
<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 -- Idea for new Index
<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/idl-to-wsdl.html
==============================================================================
--- websites/production/cxf/content/docs/idl-to-wsdl.html (original)
+++ websites/production/cxf/content/docs/idl-to-wsdl.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 - IDL to WSDL">
+
+
<title>
Apache CXF -- IDL to WSDL
</title>
@@ -42,19 +44,15 @@ Apache CXF -- IDL to WSDL
<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 -- IDL to WSDL
<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/index.html
==============================================================================
--- websites/production/cxf/content/docs/index.html (original)
+++ websites/production/cxf/content/docs/index.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 - Index">
+
+
<title>
Apache CXF -- Index
</title>
@@ -42,19 +44,15 @@ Apache CXF -- Index
<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 -- Index
<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>
@@ -135,8 +133,8 @@ Apache CXF -- Index
<p>Search:</p>
-
-<div style="padding: 5px 5px 0px 25px;">
+<p>
+</p><div style="padding: 5px 5px 0px 25px;">
<form enctype="application/x-www-form-urlencoded" method="get" action="http://cwiki.apache.org/confluence/dosearchsite.action" style="font-size: 10px;">
<input type="hidden" name="where" value="CXF20DOC">
<input maxlength="255" type="text" name="queryString" size="15" value="value">
Modified: websites/production/cxf/content/docs/interceptors.html
==============================================================================
--- websites/production/cxf/content/docs/interceptors.html (original)
+++ websites/production/cxf/content/docs/interceptors.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 - Interceptors">
+
+ <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 -- Interceptors
</title>
@@ -42,19 +54,15 @@ Apache CXF -- Interceptors
<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 -- Interceptors
<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>
@@ -154,8 +162,8 @@ Apache CXF -- Interceptors
<p>Several different components inside CXF may provide interceptors to an InterceptorChain. These implement the InterceptorProvider interface:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">public</span> <span class="code-keyword">interface</span> InterceptorProvider {
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+public interface InterceptorProvider {
List<Interceptor> getInInterceptors();
@@ -165,14 +173,14 @@ Apache CXF -- Interceptors
List<Interceptor> getInFaultInterceptors();
}
-</pre>
+]]></script>
</div></div>
<p>To add an interceptor to an interceptor chain, you'll want to add it to one of the Interceptor Providers.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-MyInterceptor interceptor = <span class="code-keyword">new</span> MyInterceptor();
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+MyInterceptor interceptor = new MyInterceptor();
provider.getInInterceptors().add(interceptor);
-</pre>
+]]></script>
</div></div>
<p>Some InterceptorProviders inside CXF are:</p>
<ul><li>Client</li><li>Endpoint</li><li>Service</li><li>Bus</li><li>Binding</li></ul>
@@ -187,139 +195,139 @@ provider.getInInterceptors().add(interce
<p>Writing an interceptor is relatively simple. Your interceptor needs to extend from either the AbstractPhaseInterceptor or one of its <a shape="rect" class="external-link" href="http://tinyurl.com/3bkho8" rel="nofollow">many subclasses</a> such as AbstractSoapInterceptor. Extending from AbstractPhaseInterceptor allows your interceptor to access the methods of the <a shape="rect" class="external-link" href="http://tinyurl.com/24gj28" rel="nofollow">Message</a> interface. For example, AttachmentInInterceptor is used in CXF to turn a multipart/related message into a series of attachments. It looks like below:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">import</span> java.io.IOException;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+import java.io.IOException;
-<span class="code-keyword">import</span> org.apache.cxf.attachment.AttachmentDeserializer;
-<span class="code-keyword">import</span> org.apache.cxf.message.Message;
-<span class="code-keyword">import</span> org.apache.cxf.phase.AbstractPhaseInterceptor;
-<span class="code-keyword">import</span> org.apache.cxf.phase.Phase;
-
-<span class="code-keyword">public</span> class AttachmentInInterceptor <span class="code-keyword">extends</span> AbstractPhaseInterceptor<Message> {
- <span class="code-keyword">public</span> AttachmentInInterceptor() {
- <span class="code-keyword">super</span>(Phase.RECEIVE);
+import org.apache.cxf.attachment.AttachmentDeserializer;
+import org.apache.cxf.message.Message;
+import org.apache.cxf.phase.AbstractPhaseInterceptor;
+import org.apache.cxf.phase.Phase;
+
+public class AttachmentInInterceptor extends AbstractPhaseInterceptor<Message> {
+ public AttachmentInInterceptor() {
+ super(Phase.RECEIVE);
}
- <span class="code-keyword">public</span> void handleMessage(Message message) {
- <span class="code-object">String</span> contentType = (<span class="code-object">String</span>) message.get(Message.CONTENT_TYPE);
- <span class="code-keyword">if</span> (contentType != <span class="code-keyword">null</span> && contentType.toLowerCase().indexOf(<span class="code-quote">"multipart/related"</span>) != -1) {
- AttachmentDeserializer ad = <span class="code-keyword">new</span> AttachmentDeserializer(message);
- <span class="code-keyword">try</span> {
+ public void handleMessage(Message message) {
+ String contentType = (String) message.get(Message.CONTENT_TYPE);
+ if (contentType != null && contentType.toLowerCase().indexOf("multipart/related") != -1) {
+ AttachmentDeserializer ad = new AttachmentDeserializer(message);
+ try {
ad.initializeAttachments();
- } <span class="code-keyword">catch</span> (IOException e) {
- <span class="code-keyword">throw</span> <span class="code-keyword">new</span> Fault(e);
+ } catch (IOException e) {
+ throw new Fault(e);
}
}
}
- <span class="code-keyword">public</span> void handleFault(Message messageParam) {
+ public void handleFault(Message messageParam) {
}
}
-</pre>
+]]></script>
</div></div>
<p>Extending from sub-classes of AbstractPhaseInterceptor allows your interceptor to access more specific information than those in the Message interface. One of the sub-classes of AbstractPhaseInterceptor is <a shape="rect" class="external-link" href="http://tinyurl.com/2xqyg6" rel="nofollow">AbstractSoapInterceptor</a>. Extending from this class allows your interceptor to access the SOAP header and version information of the <a shape="rect" class="external-link" href="http://tinyurl.com/2gxj2c" rel="nofollow">SoapMessage class</a>. For example, SoapActionInInterceptor is used in CXF to parse the SOAP action, as a simplified version of it shows below:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">import</span> java.util.Collection;
-<span class="code-keyword">import</span> java.util.List;
-<span class="code-keyword">import</span> java.util.Map;
-
-<span class="code-keyword">import</span> org.apache.cxf.binding.soap.Soap11;
-<span class="code-keyword">import</span> org.apache.cxf.binding.soap.Soap12;
-<span class="code-keyword">import</span> org.apache.cxf.binding.soap.SoapMessage;
-<span class="code-keyword">import</span> org.apache.cxf.binding.soap.model.SoapOperationInfo;
-<span class="code-keyword">import</span> org.apache.cxf.endpoint.Endpoint;
-<span class="code-keyword">import</span> org.apache.cxf.helpers.CastUtils;
-<span class="code-keyword">import</span> org.apache.cxf.interceptor.Fault;
-<span class="code-keyword">import</span> org.apache.cxf.message.Exchange;
-<span class="code-keyword">import</span> org.apache.cxf.message.Message;
-<span class="code-keyword">import</span> org.apache.cxf.phase.Phase;
-<span class="code-keyword">import</span> org.apache.cxf.service.model.BindingOperationInfo;
-<span class="code-keyword">import</span> org.apache.cxf.service.model.OperationInfo;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+
+import org.apache.cxf.binding.soap.Soap11;
+import org.apache.cxf.binding.soap.Soap12;
+import org.apache.cxf.binding.soap.SoapMessage;
+import org.apache.cxf.binding.soap.model.SoapOperationInfo;
+import org.apache.cxf.endpoint.Endpoint;
+import org.apache.cxf.helpers.CastUtils;
+import org.apache.cxf.interceptor.Fault;
+import org.apache.cxf.message.Exchange;
+import org.apache.cxf.message.Message;
+import org.apache.cxf.phase.Phase;
+import org.apache.cxf.service.model.BindingOperationInfo;
+import org.apache.cxf.service.model.OperationInfo;
-<span class="code-keyword">public</span> class SoapActionInInterceptor <span class="code-keyword">extends</span> AbstractSoapInterceptor {
+public class SoapActionInInterceptor extends AbstractSoapInterceptor {
- <span class="code-keyword">public</span> SoapActionInInterceptor() {
- <span class="code-keyword">super</span>(Phase.READ);
+ public SoapActionInInterceptor() {
+ super(Phase.READ);
addAfter(ReadHeadersInterceptor.class.getName());
addAfter(EndpointSelectionInterceptor.class.getName());
}
- <span class="code-keyword">public</span> void handleMessage(SoapMessage message) <span class="code-keyword">throws</span> Fault {
- <span class="code-keyword">if</span> (message.getVersion() <span class="code-keyword">instanceof</span> Soap11) {
- Map<<span class="code-object">String</span>, List<<span class="code-object">String</span>>> headers = CastUtils.<span class="code-keyword">cast</span>((Map)message.get(Message.PROTOCOL_HEADERS));
- <span class="code-keyword">if</span> (headers != <span class="code-keyword">null</span>) {
- List<<span class="code-object">String</span>> sa = headers.get(<span class="code-quote">"SOAPAction"</span>);
- <span class="code-keyword">if</span> (sa != <span class="code-keyword">null</span> && sa.size() > 0) {
- <span class="code-object">String</span> action = sa.get(0);
- <span class="code-keyword">if</span> (action.startsWith(<span class="code-quote">"\"</span>")) {
+ public void handleMessage(SoapMessage message) throws Fault {
+ if (message.getVersion() instanceof Soap11) {
+ Map<String, List<String>> headers = CastUtils.cast((Map)message.get(Message.PROTOCOL_HEADERS));
+ if (headers != null) {
+ List<String> sa = headers.get("SOAPAction");
+ if (sa != null && sa.size() > 0) {
+ String action = sa.get(0);
+ if (action.startsWith("\"")) {
action = action.substring(1, action.length() - 1);
}
getAndSetOperation(message, action);
}
}
- } <span class="code-keyword">else</span> <span class="code-keyword">if</span> (message.getVersion() <span class="code-keyword">instanceof</span> Soap12) {
+ } else if (message.getVersion() instanceof Soap12) {
...........
}
}
- <span class="code-keyword">private</span> void getAndSetOperation(SoapMessage message, <span class="code-object">String</span> action) {
- <span class="code-keyword">if</span> ("".equals(action)) {
- <span class="code-keyword">return</span>;
+ private void getAndSetOperation(SoapMessage message, String action) {
+ if ("".equals(action)) {
+ return;
}
Exchange ex = message.getExchange();
Endpoint ep = ex.get(Endpoint.class);
- BindingOperationInfo bindingOp = <span class="code-keyword">null</span>;
+ BindingOperationInfo bindingOp = null;
Collection<BindingOperationInfo> bops = ep.getBinding().getBindingInfo().getOperations();
- <span class="code-keyword">for</span> (BindingOperationInfo boi : bops) {
+ for (BindingOperationInfo boi : bops) {
SoapOperationInfo soi = (SoapOperationInfo) boi.getExtensor(SoapOperationInfo.class);
- <span class="code-keyword">if</span> (soi != <span class="code-keyword">null</span> && soi.getAction().equals(action)) {
- <span class="code-keyword">if</span> (bindingOp != <span class="code-keyword">null</span>) {
- <span class="code-comment">//more than one op with the same action, will need to parse normally
-</span> <span class="code-keyword">return</span>;
+ if (soi != null && soi.getAction().equals(action)) {
+ if (bindingOp != null) {
+ //more than one op with the same action, will need to parse normally
+ return;
}
bindingOp = boi;
}
}
- <span class="code-keyword">if</span> (bindingOp != <span class="code-keyword">null</span>) {
+ if (bindingOp != null) {
ex.put(BindingOperationInfo.class, bindingOp);
ex.put(OperationInfo.class, bindingOp.getOperationInfo());
}
}
}
-</pre>
+]]></script>
</div></div>
<p>Note that you will need to specify the phase that the interceptor will be included in. This is done in the interceptor's constructor:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">public</span> class MyInterceptor <span class="code-keyword">extends</span> AbstractSoapInterceptor {
- <span class="code-keyword">public</span> MyInterceptor() {
- <span class="code-keyword">super</span>(Phase.USER_PROTOCOL);
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+public class MyInterceptor extends AbstractSoapInterceptor {
+ public MyInterceptor() {
+ super(Phase.USER_PROTOCOL);
}
...
}
-</pre>
+]]></script>
</div></div>
<p>You can also express that you would like the interceptor to run before/after certain other interceptors defined in the same phase:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">public</span> class MyInterceptor <span class="code-keyword">extends</span> AbstractSoapInterceptor {
- <span class="code-keyword">public</span> MyInterceptor() {
- <span class="code-keyword">super</span>(Phase.USER_PROTOCOL);
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+public class MyInterceptor extends AbstractSoapInterceptor {
+ public MyInterceptor() {
+ super(Phase.USER_PROTOCOL);
- <span class="code-comment">// MyInterceptor needs to run after SomeOtherInterceptor
-</span> getAfter().add(SomeOtherInterceptor.class.getName());
+ // MyInterceptor needs to run after SomeOtherInterceptor
+ getAfter().add(SomeOtherInterceptor.class.getName());
- <span class="code-comment">// MyInterceptor needs to run before YetAnotherInterceptor
-</span> getBefore().add(YetAnotherInterceptor.class.getName());
+ // MyInterceptor needs to run before YetAnotherInterceptor
+ getBefore().add(YetAnotherInterceptor.class.getName());
}
...
}
-</pre>
+]]></script>
</div></div>
<p>You can add your interceptors into the interceptor chain either programmatically or through configuration.</p>
@@ -327,54 +335,54 @@ provider.getInInterceptors().add(interce
<p>To add this to your server, you'll want to get access to the Server object (see <a shape="rect" href="server-service-and-client-factorybeans.html" title="Server, Service, and Client FactoryBeans">here</a> for more info):</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.Server;
-<span class="code-keyword">import</span> org.apache.cxf.frontend.ServerFactoryBean;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+import org.apache.cxf.endpoint.Server;
+import org.apache.cxf.frontend.ServerFactoryBean;
...
-MyInterceptor myInterceptor = <span class="code-keyword">new</span> MyInterceptor();
+MyInterceptor myInterceptor = new MyInterceptor();
Server server = serverFactoryBean.create();
server.getEndpoint().getInInterceptor().add(myInterceptor);
-</pre>
+]]></script>
</div></div>
<p>On the Client side the process is very similar:</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;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+import org.apache.cxf.endpoint.Client;
+import org.apache.cxf.frontend.ClientProxy;
...
-MyInterceptor myInterceptor = <span class="code-keyword">new</span> MyInterceptor();
-FooService client = ... ; <span class="code-comment">// created from ClientProxyFactoryBean or generated JAX-WS client
-</span>
-<span class="code-comment">//You could also call clientProxyFactroyBean.getInInterceptor().add(myInterceptor) to add the interceptor
-</span>
+MyInterceptor myInterceptor = new MyInterceptor();
+FooService client = ... ; // created from ClientProxyFactoryBean or generated JAX-WS client
+
+//You could also call clientProxyFactroyBean.getInInterceptor().add(myInterceptor) to add the interceptor
+
Client cxfClient = ClientProxy.getClient(client);
cxfClient.getInInterceptors().add(myInterceptor);
-<span class="code-comment">// then you can call the service
-</span>client.doSomething();
-</pre>
+// then you can call the service
+client.doSomething();
+]]></script>
</div></div>
<p>You can also use annotation to add the interceptors from the SEI or service class. When CXF create the server or client, CXF will add the interceptor according with the annotation.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-@org.apache.cxf.interceptor.InInterceptors (interceptors = {<span class="code-quote">"com.example.Test1Interceptor"</span> })
-@org.apache.cxf.interceptor.InFaultInterceptors (interceptors = {<span class="code-quote">"com.example.Test2Interceptor"</span> })
-@org.apache.cxf.interceptor.OutInterceptors (interceptors = {<span class="code-quote">"com.example.Test1Interceptor"</span> })
-@org.apache.cxf.interceptor.InFaultInterceptors (interceptors = {<span class="code-quote">"com.example.Test2Interceptor"</span>,<span class="code-quote">"com.example.Test3Intercetpor"</span> })
-@WebService(endpointInterface = <span class="code-quote">"org.apache.cxf.javascript.fortest.SimpleDocLitBare"</span>,
- targetNamespace = <span class="code-quote">"uri:org.apache.cxf.javascript.fortest"</span>)
-<span class="code-keyword">public</span> class SayHiImplementation <span class="code-keyword">implements</span> SayHi {
- <span class="code-keyword">public</span> <span class="code-object">long</span> sayHi(<span class="code-object">long</span> arg) {
- <span class="code-keyword">return</span> arg;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+@org.apache.cxf.interceptor.InInterceptors (interceptors = {"com.example.Test1Interceptor" })
+@org.apache.cxf.interceptor.InFaultInterceptors (interceptors = {"com.example.Test2Interceptor" })
+@org.apache.cxf.interceptor.OutInterceptors (interceptors = {"com.example.Test1Interceptor" })
+@org.apache.cxf.interceptor.InFaultInterceptors (interceptors = {"com.example.Test2Interceptor","com.example.Test3Intercetpor" })
+@WebService(endpointInterface = "org.apache.cxf.javascript.fortest.SimpleDocLitBare",
+ targetNamespace = "uri:org.apache.cxf.javascript.fortest")
+public class SayHiImplementation implements SayHi {
+ public long sayHi(long arg) {
+ return arg;
}
...
}
-</pre>
+]]></script>
</div></div>
<h2><a shape="rect" name="Interceptors-Addinginterceptorsthroughconfiguration"></a>Adding interceptors through configuration</h2>
@@ -383,60 +391,60 @@ cxfClient.getInInterceptors().add(myInte
<p>Adding MyInterceptor to the bus:</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:cxf</span>=<span class="code-quote">"http://cxf.apache.org/core"</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:cxf="http://cxf.apache.org/core"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://cxf.apache.org/core http://cxf.apache.org/schemas/core.xsd">
- <span class="code-tag"><bean id=<span class="code-quote">"MyInterceptor"</span> class=<span class="code-quote">"demo.interceptor.MyInterceptor"</span>/></span>
+ <bean id="MyInterceptor" class="demo.interceptor.MyInterceptor"/>
- <span class="code-tag"><span class="code-comment"><!-- We are adding the interceptors to the bus as we will have only one endpoint/service/bus. --></span></span>
+ <!-- We are adding the interceptors to the bus as we will have only one endpoint/service/bus. -->
- <span class="code-tag"><cxf:bus></span>
- <span class="code-tag"><cxf:inInterceptors></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"MyInterceptor"</span>/></span>
- <span class="code-tag"></cxf:inInterceptors></span>
- <span class="code-tag"><cxf:outInterceptors></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"MyInterceptor"</span>/></span>
- <span class="code-tag"></cxf:outInterceptors></span>
- <span class="code-tag"></cxf:bus></span>
-<span class="code-tag"></beans></span>
+ <cxf:bus>
+ <cxf:inInterceptors>
+ <ref bean="MyInterceptor"/>
+ </cxf:inInterceptors>
+ <cxf:outInterceptors>
+ <ref bean="MyInterceptor"/>
+ </cxf:outInterceptors>
+ </cxf:bus>
+</beans>
-</pre>
+]]></script>
</div></div>
<p>For embedded Jetty-based web services, the configuration file can be declared by starting the service with the -Dcxf.config.file=server.xml option. See the <a shape="rect" class="external-link" href="http://tinyurl.com/2c9fuf" rel="nofollow">server configuration</a> section on the configuration file page for information on specifying the file for servlet WAR file-based web service implementations.</p>
<p>Adding MyInterceptor to your client:</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:http</span>=<span class="code-quote">"http://cxf.apache.org/transports/http/configuration"</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:http="http://cxf.apache.org/transports/http/configuration"
xsi:schemaLocation="http://cxf.apache.org/transports/http/configuration http://cxf.apache.org/schemas/configuration/http-conf.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
- <span class="code-tag"><http:conduit name=<span class="code-quote">"{http://apache.org/hello_world_soap_http}SoapPort9001.http-conduit"</span>></span>
- <span class="code-tag"><http:client DecoupledEndpoint=<span class="code-quote">"http://localhost:9990/decoupled_endpoint"</span>/></span>
- <span class="code-tag"></http:conduit></span>
-
- <span class="code-tag"><bean id=<span class="code-quote">"MyInterceptor"</span> class=<span class="code-quote">"demo.interceptor.MyInterceptor"</span>/></span>
-
- <span class="code-tag"><span class="code-comment"><!-- We are adding the interceptors to the bus as we will have only one endpoint/service/bus. --></span></span>
-
- <span class="code-tag"><bean id=<span class="code-quote">"cxf"</span> class=<span class="code-quote">"org.apache.cxf.bus.CXFBusImpl"</span>></span>
- <span class="code-tag"><property name=<span class="code-quote">"inInterceptors"</span>></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"MyInterceptor"</span>/></span>
- <span class="code-tag"></property></span>
- <span class="code-tag"><property name=<span class="code-quote">"outInterceptors"</span>></span>
- <span class="code-tag"><ref bean=<span class="code-quote">"MyInterceptor"</span>/></span>
- <span class="code-tag"></property></span>
- <span class="code-tag"></bean></span>
-<span class="code-tag"></beans></span>
-</pre>
+ <http:conduit name="{http://apache.org/hello_world_soap_http}SoapPort9001.http-conduit">
+ <http:client DecoupledEndpoint="http://localhost:9990/decoupled_endpoint"/>
+ </http:conduit>
+
+ <bean id="MyInterceptor" class="demo.interceptor.MyInterceptor"/>
+
+ <!-- We are adding the interceptors to the bus as we will have only one endpoint/service/bus. -->
+
+ <bean id="cxf" class="org.apache.cxf.bus.CXFBusImpl">
+ <property name="inInterceptors">
+ <ref bean="MyInterceptor"/>
+ </property>
+ <property name="outInterceptors">
+ <ref bean="MyInterceptor"/>
+ </property>
+ </bean>
+</beans>
+]]></script>
</div></div>
<p>To specify the client-side configuration file, start your client using the -Dcxf.config.file=client.xml option.</p>
Modified: websites/production/cxf/content/docs/invokers.html
==============================================================================
--- websites/production/cxf/content/docs/invokers.html (original)
+++ websites/production/cxf/content/docs/invokers.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 - Invokers">
+
+ <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 -- Invokers
</title>
@@ -42,19 +53,15 @@ Apache CXF -- Invokers
<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 -- Invokers
<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>
@@ -125,97 +132,97 @@ Apache CXF -- Invokers
<p>CXF does provide a number of bundled invokers to handle simple cases. One of these simple cases is when it is desirable to have a singleton for the service object. In this case, you would like to provide a single object instance that should be used for all service invocations. The provided BeanInvoker covers this functionality, and would be used as follows:</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[
Service service = ...;
-service.setInvoker(<span class="code-keyword">new</span> BeanInvoker(<span class="code-keyword">new</span> MyCustomBean(someParams)));
-</pre>
+service.setInvoker(new BeanInvoker(new MyCustomBean(someParams)));
+]]></script>
</div></div>
<p>You can access the underlying Service object in two ways. If you've created your service using a ServerFactoryBean, this will yield a Server object which can be used to gain access to the Service:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-ServerFactoryBean factory = <span class="code-keyword">new</span> ServerFactoryBean();
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+ServerFactoryBean factory = new ServerFactoryBean();
....
Server server = factory.create()
Service service = server.getEndpoint().getService();
-</pre>
+]]></script>
</div></div>
<p>If you've created a JAX-WS Endpoint object, you can access the Service like this:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-EndpointImpl endpoint = (EndpointImpl) Endpoint.publish(<span class="code-quote">"http:<span class="code-comment">//host/service"</span>, <span class="code-keyword">new</span> MyService());
-</span>....
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+EndpointImpl endpoint = (EndpointImpl) Endpoint.publish("http://host/service", new MyService());
+....
Server server = endpoint.getServer();
Service service = server.getEndpoint().getService();
-</pre>
+]]></script>
</div></div>
<p>The following example illustrates how an invoker can be used to allow CXF to expose remote stateless session beans as a webservice. Given the method to invoke, this invoker will create a stateless session bean instance to invoke the method on. The same technique can be used to enable service calls to any object that requires custom creation/lookup.</p>
<p>The invoker implementation is as follows:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">public</span> class EJBInvoker <span class="code-keyword">extends</span> AbstractInvoker
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+public class EJBInvoker extends AbstractInvoker
{
- <span class="code-keyword">private</span> EJBHome home;
- <span class="code-keyword">private</span> Method createMethod;
- <span class="code-keyword">private</span> <span class="code-keyword">static</span> <span class="code-keyword">final</span> <span class="code-object">Object</span>[] EMPTY_OBJECT = <span class="code-keyword">new</span> <span class="code-object">Object</span>[0];
+ private EJBHome home;
+ private Method createMethod;
+ private static final Object[] EMPTY_OBJECT = new Object[0];
- <span class="code-keyword">public</span> EJBInvoker(EJBHome home)
+ public EJBInvoker(EJBHome home)
{
- <span class="code-keyword">this</span>.home = home;
- <span class="code-keyword">try</span>
+ this.home = home;
+ try
{
- <span class="code-keyword">if</span>(!home.getEJBMetaData().isSession() || !home.getEJBMetaData().isStatelessSession())
+ if(!home.getEJBMetaData().isSession() || !home.getEJBMetaData().isStatelessSession())
{
- <span class="code-keyword">throw</span> <span class="code-keyword">new</span> IllegalArgumentException(<span class="code-quote">"home must be <span class="code-keyword">for</span> a stateless session bean"</span>);
+ throw new IllegalArgumentException("home must be for a stateless session bean");
}
- createMethod = home.getClass().getMethod(<span class="code-quote">"create"</span>, <span class="code-keyword">new</span> <span class="code-object">Class</span>[0]);
+ createMethod = home.getClass().getMethod("create", new Class[0]);
}
- <span class="code-keyword">catch</span>(Exception ex)
+ catch(Exception ex)
{
- <span class="code-keyword">throw</span> <span class="code-keyword">new</span> IllegalArgumentException(<span class="code-quote">"Unable to initialize invoker: "</span> + ex);
+ throw new IllegalArgumentException("Unable to initialize invoker: " + ex);
}
}
- <span class="code-keyword">public</span> <span class="code-object">Object</span> getServiceObject(<span class="code-keyword">final</span> Exchange context)
+ public Object getServiceObject(final Exchange context)
{
- <span class="code-keyword">return</span> createMethod.invoke(home, EMPTY_OBJECT);
+ return createMethod.invoke(home, EMPTY_OBJECT);
}
}
-</pre>
+]]></script>
</div></div>
<p>Invokers, once defined, need to be registered with the Service. Once a handle onto a Service object has been obtained, the example invoker above can be registered on the binding like this:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
Service ejbService = ....;
-ejbService.setInvoker(<span class="code-keyword">new</span> EJBInvoker(ejbHome));
-</pre>
+ejbService.setInvoker(new EJBInvoker(ejbHome));
+]]></script>
</div></div>
<p>If you are using an EJB3 container you can use the following invoker, which is just a simplified version of the above:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">public</span> class EJB3Invoker <span class="code-keyword">extends</span> AbstractInvoker {
- <span class="code-keyword">private</span> <span class="code-object">Object</span> ejb;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+public class EJB3Invoker extends AbstractInvoker {
+ private Object ejb;
- <span class="code-keyword">public</span> EJB3Invoker(<span class="code-object">String</span> jndiName) <span class="code-keyword">throws</span> NamingException {
- ejb = <span class="code-keyword">new</span> InitialContext().lookup(jndiName);
+ public EJB3Invoker(String jndiName) throws NamingException {
+ ejb = new InitialContext().lookup(jndiName);
}
- <span class="code-keyword">public</span> <span class="code-object">Object</span> getServiceObject(<span class="code-keyword">final</span> Exchange context) {
- <span class="code-keyword">return</span> ejb;
+ public Object getServiceObject(final Exchange context) {
+ return ejb;
}
}
-</pre>
+]]></script>
</div></div>
<h2><a shape="rect" name="Invokers-Executors"></a>Executors</h2>
<p>In addition to providing your own Invokers, you can also supply Executors for your service. Executors are a way to control scheduling for your service. To supply your own executor for a service just do:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-Service service = ....; <span class="code-comment">// look up the service from CXF, or create it
-</span>service.setExecutor(<span class="code-keyword">new</span> MyExecutor());
-</pre>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+Service service = ....; // look up the service from CXF, or create it
+service.setExecutor(new MyExecutor());
+]]></script>
</div></div></div>
</div>
<!-- Content -->
Modified: websites/production/cxf/content/docs/java-to-javascript.html
==============================================================================
--- websites/production/cxf/content/docs/java-to-javascript.html (original)
+++ websites/production/cxf/content/docs/java-to-javascript.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 - Java to Javascript">
+
+
<title>
Apache CXF -- Java to Javascript
</title>
@@ -42,19 +44,15 @@ Apache CXF -- Java to Javascript
<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 -- Java to Javascript
<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>