| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- |
| |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <html> |
| <head> |
| |
| <link type="text/css" rel="stylesheet" href="/resources/site.css"> |
| <script src='/resources/space.js'></script> |
| |
| <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-RS and JAX-WS"> |
| |
| |
| <link type="text/css" rel="stylesheet" href="/resources/highlighter/styles/shCoreCXF.css"> |
| <link type="text/css" rel="stylesheet" href="/resources/highlighter/styles/shThemeCXF.css"> |
| |
| <script src='/resources/highlighter/scripts/shCore.js'></script> |
| <script src='/resources/highlighter/scripts/shBrushXml.js'></script> |
| <script src='/resources/highlighter/scripts/shBrushJava.js'></script> |
| <script> |
| SyntaxHighlighter.defaults['toolbar'] = false; |
| SyntaxHighlighter.all(); |
| </script> |
| |
| |
| <title> |
| Apache CXF -- JAX-RS and JAX-WS |
| </title> |
| </head> |
| <body onload="init()"> |
| |
| |
| <table width="100%" cellpadding="0" cellspacing="0"> |
| <tr> |
| <td id="cell-0-0" colspan="2"> </td> |
| <td id="cell-0-1"> </td> |
| <td id="cell-0-2" colspan="2"> </td> |
| </tr> |
| <tr> |
| <td id="cell-1-0"> </td> |
| <td id="cell-1-1"> </td> |
| <td id="cell-1-2"> |
| <!-- Banner --> |
| <div class="banner" id="banner"><div><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></div> |
| <!-- Banner --> |
| <div id="top-menu"> |
| <table border="0" cellpadding="1" cellspacing="0" width="100%"> |
| <tr> |
| <td> |
| <div align="left"> |
| <!-- Breadcrumbs --> |
| <a href="index.html">Index</a> > <a href="restful-services.html">RESTful Services</a> > <a href="jax-rs.html">JAX-RS</a> > <a href="jax-rs-and-jax-ws.html">JAX-RS and JAX-WS</a> |
| <!-- Breadcrumbs --> |
| </div> |
| </td> |
| <td> |
| <div align="right"> |
| <!-- Quicklinks --> |
| <div id="quicklinks"><p><a shape="rect" href="http://cxf.apache.org/download.html">Download</a> | <a shape="rect" href="http://cxf.apache.org/docs/index.html">Documentation</a></p></div> |
| <!-- Quicklinks --> |
| </div> |
| </td> |
| </tr> |
| </table> |
| </div> |
| </td> |
| <td id="cell-1-3"> </td> |
| <td id="cell-1-4"> </td> |
| </tr> |
| <tr> |
| <td id="cell-2-0" colspan="2"> </td> |
| <td id="cell-2-1"> |
| <table> |
| <tr valign="top"> |
| <td height="100%"> |
| <div id="wrapper-menu-page-right"> |
| <div id="wrapper-menu-page-top"> |
| <div id="wrapper-menu-page-bottom"> |
| <div id="menu-page"> |
| <!-- NavigationBar --> |
| <div id="navigation"><ul class="alternate"><li><a shape="rect" href="overview.html">Overview</a></li><li><a shape="rect" href="how-tos.html">How-Tos</a></li><li><a shape="rect" href="frontends.html">Frontends</a></li><li><a shape="rect" href="databindings.html">DataBindings</a></li><li><a shape="rect" href="transports.html">Transports</a></li><li><a shape="rect" href="configuration.html">Configuration</a></li><li><a shape="rect" href="debugging-and-logging.html">Debugging and Logging</a></li><li><a shape="rect" href="tools.html">Tools</a></li><li><a shape="rect" href="restful-services.html">RESTful Services</a></li><li><a shape="rect" href="wsdl-bindings.html">WSDL Bindings</a></li><li><a shape="rect" href="service-routing.html">Service Routing</a></li><li><a shape="rect" href="dynamic-languages.html">Dynamic Languages</a></li><li><a shape="rect" href="ws-support.html">WS-* Support</a></li><li><a shape="rect" href="advanced-integration.html">Advanced Integration</a></li><li><a shape="rect" href="deployment.html">Deployment</a></li><li><a shape="rect" href="schemas-and-namespaces.html">Use of Schemas and Namespaces</a></li></ul><hr><ul class="alternate"><li><p>Search</p></li></ul><form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse"> |
| <div> |
| <input type="hidden" name="cx" value="002890367768291051730:o99qiwa09y4"> |
| <input type="hidden" name="ie" value="UTF-8"> |
| <input type="text" name="q" size="21"> |
| <input type="submit" name="sa" value="Search"> |
| </div> |
| </form> |
| <script type="text/javascript" src="http://www.google.com/cse/brand?form=cse-search-box&lang=en"></script><hr><ul class="alternate"><li><a shape="rect" href="http://cxf.apache.org/javadoc/latest/">API 3.2.x (Javadoc)</a></li><li><a shape="rect" href="http://cxf.apache.org/javadoc/latest-3.1.x/">API 3.1.x (Javadoc)</a></li><li><a shape="rect" href="http://cxf.apache.org/">CXF Website</a></li></ul><p> </p><p><a shape="rect" class="external-link" href="http://www.apache.org/events/current-event.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://www.apache.org/events/current-event-125x125.png" data-image-src="http://www.apache.org/events/current-event-125x125.png"></span></a></p></div> |
| <!-- NavigationBar --> |
| </div> |
| </div> |
| </div> |
| </div> |
| </td> |
| <td height="100%"> |
| <!-- Content --> |
| <div class="wiki-content"> |
| <div id="ConfluenceContent"><p> </p><p> </p><p> </p><p> </p><p><span style="font-size:2em;font-weight:bold"> JAX-RS and JAX-WS </span> |
| |
| |
| </p><p> </p><p> </p><p> </p><p> </p><p><style type="text/css">/*<![CDATA[*/ |
| div.rbtoc1636141626102 {padding: 0px;} |
| div.rbtoc1636141626102 ul {list-style: disc;margin-left: 0px;} |
| div.rbtoc1636141626102 li {margin-left: 0px;padding-left: 0px;} |
| |
| /*]]>*/</style></p><div class="toc-macro rbtoc1636141626102"> |
| <ul class="toc-indentation"><li><a shape="rect" href="#JAXRSandJAXWS-JAX-RSandJAX-WS">JAX-RS and JAX-WS</a></li><li><a shape="rect" href="#JAXRSandJAXWS-Dealingwithcontexts">Dealing with contexts</a></li><li><a shape="rect" href="#JAXRSandJAXWS-SharingCXFDataBindings">Sharing CXF DataBindings</a></li><li><a shape="rect" href="#JAXRSandJAXWS-SharingJAX-RSProviders">Sharing JAX-RS Providers</a></li><li><a shape="rect" href="#JAXRSandJAXWS-Applyingexternalusermodels">Applying external user models</a></li></ul> |
| </div><h1 id="JAXRSandJAXWS-JAX-RSandJAX-WS">JAX-RS and JAX-WS</h1><p>Here's a beans.xml showing how to have a single service class supporting both SOAP and REST-based invocations at the same time with the help of JAX-WS and JAX-RS :</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> |
| <pre class="brush: java; gutter: false; theme: Default"><?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:jaxrs="http://cxf.apache.org/jaxrs" |
| 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/jaxrs |
| http://cxf.apache.org/schemas/jaxrs.xsd |
| http://cxf.apache.org/jaxws |
| http://cxf.apache.org/schemas/jaxws.xsd"> |
| |
| <import resource="classpath:META-INF/cxf/cxf.xml" /> |
| <import resource="classpath:META-INF/cxf/cxf-extension-jaxrs-binding.xml" /> |
| <import resource="classpath:META-INF/cxf/cxf-servlet.xml" /> |
| |
| <!-- JAX-RS --> |
| <jaxrs:server id="customerService" address="/"> |
| <jaxrs:serviceBeans> |
| <ref bean="customerService" /> |
| </jaxrs:serviceBeans> |
| </jaxrs:server> |
| |
| <!-- JAX-WS --> |
| <jaxws:endpoint implementor="#customerService" |
| address="/CustomerWorld" wsdlLocation="..."/> |
| |
| <bean id="customerService" class="demo.jaxrs.server.CustomerService" /> |
| </beans> |
| </pre> |
| </div></div><p>Either contract-first or Java-first approach can be used for JAX-WS. JAX-RS annotations can be added to the existing service class. Some custom providers may need to be created, depending on the complexity of the method signatures.</p><p>When a WSDL-first approach is used then a document-literal-wrapped style may or may not be a good fit as the code generator unwraps all the types into a signature, for example :</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> |
| <pre class="brush: java; gutter: false; theme: Default">public class CustomerService { |
| public void doIt(String a, String b) {...}; |
| } |
| </pre> |
| </div></div><p>By default JAX-RS may not be able to handle such methods as it requires that only a single parameter can be available in a signature that is not annotated by one of the JAX-RS annotations like @PathParam. So if <br clear="none"> a 'String a' parameter can be mapped to a @Path template variable or one of the query segments then this signature won't need to be changed :</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> |
| <pre class="brush: java; gutter: false; theme: Default">@Path("/customers/{a}") |
| public class CustomerService { |
| public void doIt(@PathParam("a") String a, String b) {...}; |
| } |
| </pre> |
| </div></div><p>Note that CXF Continuations API is supported for both JAXWS and JAXRS services.</p><h1 id="JAXRSandJAXWS-Dealingwithcontexts">Dealing with contexts</h1><p>When combining JAXWS and JAXRS, one may need to access some context information as part of processing a given request. At the moment, CXF JAXRS does not offer a context implementation which can be used to access a request-specific information common for both JAXWS and JAXRS requests, in cases when the same methods are used to handle both JAXWS and JAXRS requests. Please use a JAXWS WebServiceContext and JAXRS contexts or CXF JAXRS composite MessageContext :</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> |
| <pre class="brush: java; gutter: false; theme: Default">@Path("/customers") |
| @WebService |
| public class CustomerService { |
| |
| @Context WebServiceContext jaxwsContext; |
| @Context MessageContext jaxrsContext; |
| |
| @WebMethod |
| @POST |
| public void doIt(String b) { |
| isUserInRole(); |
| }; |
| |
| private void isUserInRole() throws WebApplicationException { |
| if (jaxwsContext.getSecurityContext() != null) { |
| // soap invocation |
| jaxwsContext.getSecurityContext().isUserInRole(theRole); |
| } else { |
| // http-only jaxrs one |
| jaxrsContext.getSecurityContext().isUserInRole(theRole); |
| } |
| } |
| } |
| </pre> |
| </div></div><p>Note that injected context instances (jaxwsContext and jaxrsContext) are in fact thread-local proxies hence they will not be equal to null even if they do not represent a given request. For example, jaxrsContext will not be equal to null even if it's not a JAXWS invocation which is being processed at the moment.</p><p>However, if say a (JAXWS or JAXRS) SecurityContext needs to be accessed then it will be set in, say, jaxwsContext only if it's a JAXWS/SOAP invocation. For this reason it can be handy using a composite CXF JAXRS MessageContext when accessing a JAXRS-specific context information when combining JAXWS and JAXRS as one can easily check if it's actually a JAXRS request by simply checking an individual context like SecurityContext or UriInfo for null.</p><p>Using individual contexts like JAXRS SecurityContext might be less attractive :</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> |
| <pre class="brush: java; gutter: false; theme: Default">@WebService |
| public class CustomerService { |
| @Context WebServiceContext jaxwsContext; |
| // @Resource can be applied too |
| @Context SecurityContext jaxrsSecurityContext; |
| } |
| </pre> |
| </div></div><p>as some methods of SecurityContext return boolean values so only throwing a runtime exception can reliably indicate that this context is actually not in scope.</p><p>Note that if you do not share the same service methods between JAXRS and JAXWS invocations then you can directly access corresponding contexts :</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> |
| <pre class="brush: java; gutter: false; theme: Default">@Path("/customers") |
| @WebService |
| public class CustomerService |
| |
| @Context WebServiceContext jaxwsContext; |
| @Context MessageContext jaxrsContext; |
| |
| @WebMethod |
| public void doItSoap(String b) { |
| isUserInRole(jaxwsContext.getSecurityContext().getPrincipal()); |
| }; |
| |
| @POST |
| public void doItSoap(String b) { |
| isUserInRole(jaxwsContext.getSecurityContext().getPrincipal()); |
| } |
| |
| private void isUserInRole(Principal p) throws WebApplicationException { |
| ... |
| } |
| } |
| </pre> |
| </div></div><p>Another option is to avoid the use of contexts in the service code and deal with them in CXF interceptors or JAXRS filters. Sometimes it's possible to avoid the use of contexts altogether. For example, Spring Security can be used to secure a given service at an individual method level.</p><h1 id="JAXRSandJAXWS-SharingCXFDataBindings">Sharing CXF DataBindings</h1><p>JAX-WS and JAX-RS endpoints can be configured to share a single CXF DataBinding instance for reading/writing the data.<br clear="none"> Please see the <a shape="rect" href="jax-rs-data-bindings.html">CXF DataBindings</a> section for more information.</p><h1 id="JAXRSandJAXWS-SharingJAX-RSProviders">Sharing JAX-RS Providers</h1><p>JAX-WS and JAX-RS endpoints can be configured to share a single JAX-RS provider instance for reading/writing the data.<br clear="none"> Please see the <a shape="rect" href="jax-rs-data-bindings.html">JAX-RS DataBinding</a> section for more information.</p><h1 id="JAXRSandJAXWS-Applyingexternalusermodels">Applying external user models</h1><p>When using a WSDL-first approach toward developing the SOAP services you may not want or be able to add JAX-RS annotations to the generated service interface class. Indirectly applying an external user model to this service class via the jaxrs:server endpoint makes it possible to REST-ify the service without making the code changes.</p></div> |
| </div> |
| <!-- Content --> |
| </td> |
| </tr> |
| </table> |
| </td> |
| <td id="cell-2-2" colspan="2"> </td> |
| </tr> |
| <tr> |
| <td id="cell-3-0"> </td> |
| <td id="cell-3-1"> </td> |
| <td id="cell-3-2"> |
| <div id="footer"> |
| <!-- Footer --> |
| <div id="site-footer"> |
| <a href="http://cxf.apache.org/privacy-policy.html">Privacy Policy</a> - |
| (<a href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=24190959">edit page</a>) |
| (<a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=24190959&showComments=true&showCommentArea=true#addcomment">add comment</a>)<br> |
| Apache CXF, CXF, Apache, the Apache feather logo are trademarks of The Apache Software Foundation.<br> |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners. |
| </div> |
| <!-- Footer --> |
| </div> |
| </td> |
| <td id="cell-3-3"> </td> |
| <td id="cell-3-4"> </td> |
| </tr> |
| <tr> |
| <td id="cell-4-0" colspan="2"> </td> |
| <td id="cell-4-1"> </td> |
| <td id="cell-4-2" colspan="2"> </td> |
| </tr> |
| </table> |
| |
| <script type="text/javascript"> |
| var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); |
| document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); |
| </script> |
| <script type="text/javascript"> |
| try { |
| var pageTracker = _gat._getTracker("UA-4458903-1"); |
| pageTracker._trackPageview(); |
| } catch(err) {}</script> |
| |
| </body> |
| </html> |
| |
