| <!DOCTYPE html> |
| <html lang="en"> |
| |
| <head> |
| <meta charset="UTF-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <title>Apache TomEE</title> |
| <meta name="description" |
| content="Apache TomEE is a lightweight, yet powerful, JavaEE Application server with feature rich tooling." /> |
| <meta name="keywords" content="tomee,asf,apache,javaee,jee,shade,embedded,test,junit,applicationcomposer,maven,arquillian" /> |
| <meta name="author" content="Luka Cvetinovic for Codrops" /> |
| <link rel="icon" href="../../../../favicon.ico"> |
| <link rel="icon" type="image/png" href="../../../../favicon.png"> |
| <meta name="msapplication-TileColor" content="#80287a"> |
| <meta name="theme-color" content="#80287a"> |
| <link rel="stylesheet" type="text/css" href="../../../../css/normalize.css"> |
| <link rel="stylesheet" type="text/css" href="../../../../css/bootstrap.css"> |
| <link rel="stylesheet" type="text/css" href="../../../../css/owl.css"> |
| <link rel="stylesheet" type="text/css" href="../../../../css/animate.css"> |
| <link rel="stylesheet" type="text/css" href="../../../../fonts/font-awesome-4.1.0/css/font-awesome.min.css"> |
| <link rel="stylesheet" type="text/css" href="../../../../fonts/eleganticons/et-icons.css"> |
| <link rel="stylesheet" type="text/css" href="../../../../css/jqtree.css"> |
| <link rel="stylesheet" type="text/css" href="../../../../css/idea.css"> |
| <link rel="stylesheet" type="text/css" href="../../../../css/cardio.css"> |
| |
| <script type="text/javascript"> |
| |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-2717626-1']); |
| _gaq.push(['_setDomainName', 'apache.org']); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| |
| </script> |
| </head> |
| |
| <body> |
| <div class="preloader"> |
| <img src="../../../../img/loader.gif" alt="Preloader image"> |
| </div> |
| <nav class="navbar"> |
| <div class="container"> |
| <div class="row"> <div class="col-md-12"> |
| |
| <!-- Brand and toggle get grouped for better mobile display --> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a class="navbar-brand" href="/"> |
| <span> |
| |
| |
| <img src="../../../../img/logo-active.png"> |
| |
| |
| </span> |
| Apache TomEE |
| </a> |
| </div> |
| <!-- Collect the nav links, forms, and other content for toggling --> |
| <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> |
| <ul class="nav navbar-nav navbar-right main-nav"> |
| <li><a href="../../../../docs.html">Documentation</a></li> |
| <li><a href="../../../../community/index.html">Community</a></li> |
| <li><a href="../../../../security/security.html">Security</a></li> |
| <li><a href="../../../../download-ng.html">Downloads</a></li> |
| </ul> |
| </div> |
| <!-- /.navbar-collapse --> |
| </div></div> |
| </div> |
| <!-- /.container-fluid --> |
| </nav> |
| |
| |
| <div id="main-block" class="container main-block"> |
| <div class="row title"> |
| <div class="col-md-12"> |
| <div class='page-header'> |
| |
| <div class='btn-toolbar pull-right' style="z-index: 2000;"> |
| <div class='btn-group'> |
| <a class="btn" href="../../../../tomee-9.0/docs/developer/configuration/cxf.pdf"><i class="fa fa-file-pdf-o"></i> Download as PDF</a> |
| </div> |
| </div> |
| |
| <h1>CXF Configuration - JAX-RS (RESTful Services) and JAX-WS (Web Services)</h1> |
| </div> |
| </div> |
| </div> |
| <div class="row"> |
| |
| <div class="col-md-12"> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>TomEE relies on Apache CXF for JAX-RS (RESTful Services) and JAX-WS (Web Services). It does not provide all CXF modules, but the most common ones for both specifications (JAX-RS is part of all distributions but JAX-WS is only part of plus one).</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_configuration">Configuration</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>CXF API is reusable but you can also configure the interceptors through <code>openejb-jar.xml</code> (located in WEB-INF).</p> |
| </div> |
| <div class="paragraph"> |
| <p>If you want to configure JAX-RS you will use the prefix <code>cxf.jaxrs</code> and if you configure JAX-WS you use <code>cxf.jaxws</code> prefix.</p> |
| </div> |
| <div class="admonitionblock tip"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-tip" title="Tip"></i> |
| </td> |
| <td class="content"> |
| to configure directly the bus use <code>org.apache.openejb.cxf.bus.</code> prefix and configure it in <code>conf/system.properties</code>. |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div class="paragraph"> |
| <p>To configure JAX-RS you need to add in <code>openejb-jar.xml</code> a <code>pojo-deployment</code>:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-xml" data-lang="xml"><?xml version="1.0" encoding="UTF-8"?> |
| <openejb-jar> |
| <pojo-deployment class-name="jaxrs-application"> |
| <properties> |
| # here will go the config |
| </properties> |
| </pojo-deployment> |
| </openejb-jar></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For JAX-WS you will use a <code>pojo-deployment</code> matching the webservice class name for POJO webservices |
| or an <code>ejb-deployment</code> instead of a <code>pojo-deployment</code> for EJB webservices:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-xml" data-lang="xml"><?xml version="1.0" encoding="UTF-8"?> |
| <openejb-jar> |
| <ejb-deployment ejb-name="MyEJBWebService"> |
| <properties> |
| # here will go the config |
| </properties> |
| </ejb-deployment> |
| </openejb-jar></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Then once you selected your prefix and know where to write the config just use the following entries:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>properties: server factory properties</p> |
| </li> |
| <li> |
| <p>features: CXF features</p> |
| </li> |
| <li> |
| <p>in-interceptors: CXF in interceptors</p> |
| </li> |
| <li> |
| <p>out-interceptors: CXF out interceptors</p> |
| </li> |
| <li> |
| <p>in-fault-interceptors: CXF in interceptors for fault handling</p> |
| </li> |
| <li> |
| <p>out-fault-interceptors: CXF out interceptors for fault handling</p> |
| </li> |
| <li> |
| <p>databinding: server databinding</p> |
| </li> |
| <li> |
| <p>providers (only for JAX-RS endpoint): list of JAX-RS providers</p> |
| </li> |
| <li> |
| <p>skip-provider-scanning (only for JAX-RS): is provider scanning on or not (default true)</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For features and interceptors the rule is the same: value is a list comma separated. Each value of the list is either a qualified class name or an id of a service in resources.xml.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Databinding is simply either a qualified name or a service id in resources.xml (located in WEB-INF).</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_sample_for_jax_ws">Sample for JAX-WS</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>To configure WSS4J on the EJB <code>CalculatorBean</code> for instance add in openejb-jar.xml:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-xml" data-lang="xml"><openejb-jar xmlns="http://www.openejb.org/openejb-jar/1.1"> |
| <ejb-deployment ejb-name="CalculatorBean"> |
| <properties> |
| cxf.jaxws.in-interceptors = wss4j |
| </properties> |
| </ejb-deployment> |
| </openejb-jar></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>With associated resources.xml which will define precisely the <code>wss4j</code> configuration:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-xml" data-lang="xml"><resources> |
| <Service id="wss4j" class-name="org.apache.openejb.server.cxf.config.WSS4JInInterceptorFactory" factory-name="create"> |
| action = UsernameToken |
| passwordType = PasswordText |
| passwordCallbackClass = org.superbiz.ws.security.PasswordCallbackHandler |
| </Service> |
| </resources></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_sample_for_jax_rs">Sample for JAX-RS</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p><a href="../json/index.html">JAX-RS JSON</a> page shows a sample dedicated to JAX-RS.</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| </div> |
| </div> |
| <footer> |
| <div class="container"> |
| <div class="row"> |
| <div class="col-sm-6 text-center-mobile"> |
| <h3 class="white">Be simple. Be certified. Be Tomcat.</h3> |
| <h5 class="light regular light-white">"A good application in a good server"</h5> |
| <ul class="social-footer"> |
| <li><a href="https://www.facebook.com/ApacheTomEE/"><i class="fa fa-facebook"></i></a></li> |
| <li><a href="https://twitter.com/apachetomee"><i class="fa fa-twitter"></i></a></li> |
| <li><a href="https://plus.google.com/communities/105208241852045684449"><i class="fa fa-google-plus"></i></a></li> |
| </ul> |
| </div> |
| <div class="col-sm-6 text-center-mobile"> |
| <div class="row opening-hours"> |
| <div class="col-sm-3 text-center-mobile"> |
| <h5><a href="../../../../latest/docs/" class="white">Documentation</a></h5> |
| <ul class="list-unstyled"> |
| <li><a href="../../../../latest/docs/admin/configuration/index.html" class="regular light-white">How to configure</a></li> |
| <li><a href="../../../../latest/docs/admin/file-layout.html" class="regular light-white">Dir. Structure</a></li> |
| <li><a href="../../../../latest/docs/developer/testing/index.html" class="regular light-white">Testing</a></li> |
| <li><a href="../../../../latest/docs/admin/cluster/index.html" class="regular light-white">Clustering</a></li> |
| </ul> |
| </div> |
| <div class="col-sm-3 text-center-mobile"> |
| <h5><a href="../../../../latest/examples/" class="white">Examples</a></h5> |
| <ul class="list-unstyled"> |
| <li><a href="../../../../latest/examples/simple-cdi-interceptor.html" class="regular light-white">CDI Interceptor</a></li> |
| <li><a href="../../../../latest/examples/rest-cdi.html" class="regular light-white">REST with CDI</a></li> |
| <li><a href="../../../../latest/examples/ejb-examples.html" class="regular light-white">EJB</a></li> |
| <li><a href="../../../../latest/examples/jsf-managedBean-and-ejb.html" class="regular light-white">JSF</a></li> |
| </ul> |
| </div> |
| <div class="col-sm-3 text-center-mobile"> |
| <h5><a href="../../../../community/index.html" class="white">Community</a></h5> |
| <ul class="list-unstyled"> |
| <li><a href="../../../../community/contributors.html" class="regular light-white">Contributors</a></li> |
| <li><a href="../../../../community/social.html" class="regular light-white">Social</a></li> |
| <li><a href="../../../../community/sources.html" class="regular light-white">Sources</a></li> |
| </ul> |
| </div> |
| <div class="col-sm-3 text-center-mobile"> |
| <h5><a href="../../../../security/index.html" class="white">Security</a></h5> |
| <ul class="list-unstyled"> |
| <li><a href="http://apache.org/security" target="_blank" class="regular light-white">Apache Security</a></li> |
| <li><a href="http://apache.org/security/projects.html" target="_blank" class="regular light-white">Security Projects</a></li> |
| <li><a href="http://cve.mitre.org" target="_blank" class="regular light-white">CVE</a></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="row bottom-footer text-center-mobile"> |
| <div class="col-sm-12 light-white"> |
| <p>Copyright © 1999-2016 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache TomEE, TomEE, Apache, the Apache feather logo, and the Apache TomEE project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p> |
| </div> |
| </div> |
| </div> |
| </footer> |
| <!-- Holder for mobile navigation --> |
| <div class="mobile-nav"> |
| <ul> |
| <li><a hef="../../../../latest/docs/admin/index.html">Administrators</a> |
| <li><a hef="../../../../latest/docs/developer/index.html">Developers</a> |
| <li><a hef="../../../../latest/docs/advanced/index.html">Advanced</a> |
| <li><a hef="../../../../community/index.html">Community</a> |
| </ul> |
| <a href="#" class="close-link"><i class="arrow_up"></i></a> |
| </div> |
| <!-- Scripts --> |
| <script src="../../../../js/jquery-1.11.1.min.js"></script> |
| <script src="../../../../js/owl.carousel.min.js"></script> |
| <script src="../../../../js/bootstrap.min.js"></script> |
| <script src="../../../../js/wow.min.js"></script> |
| <script src="../../../../js/typewriter.js"></script> |
| <script src="../../../../js/jquery.onepagenav.js"></script> |
| <script src="../../../../js/tree.jquery.js"></script> |
| <script src="../../../../js/highlight.pack.js"></script> |
| <script src="../../../../js/main.js"></script> |
| </body> |
| |
| </html> |
| |
