cxf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [CONF] Apache CXF Documentation > JAX-RS Advanced Features
Date Wed, 22 Dec 2010 12:06:00 GMT
    <base href="">
            <link rel="stylesheet" href="/confluence/s/1810/9/1/_/styles/combined.css?spaceKey=CXF20DOC&amp;forWysiwyg=true"
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
    <h2><a href="">JAX-RS
Advanced Features</a></h2>
    <h4>Page  <b>added</b> by             <a href="">Sergey
    <div class="notificationGreySide">
         <span style="font-size:2em;font-weight:bold">JAX-RS : Advanced Features</span>

    <li><a href='#JAX-RSAdvancedFeatures-JMSSupport'>JMS Support</a></li>
    <li><a href='#JAX-RSAdvancedFeatures-Onewayinvocations'>Oneway invocations</a></li>
    <li><a href='#JAX-RSAdvancedFeatures-RESTfulserviceswithoutannotations'>RESTful
services without annotations</a></li>
    <li><a href='#JAX-RSAdvancedFeatures-Configuration'>Configuration</a></li>

<h1><a name="JAX-RSAdvancedFeatures-JMSSupport"></a>JMS Support</h1>

<p>CXF has been designed such that multiple transports can be supported for a given
endpoint. If you would like your JAXRS endpoint be capable of serving not only HTTP but also
JMS requests then you need to specify a JMS transportId, example :</p>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-xml">
<span class="code-tag">&lt;jaxrs:server serviceName=<span class="code-quote">"s:BookService"</span>
transportId=<span class="code-quote">""</span>
address=<span class="code-quote">"/"</span>&gt;</span>
 <span class="code-tag">&lt;jaxrs:serviceBeans&gt;</span>
   <span class="code-tag">&lt;bean class=<span class="code-quote">"org.apache.cxf.systest.jaxrs.JMSBookStore"</span>/&gt;</span>
 <span class="code-tag">&lt;/jaxrs:serviceBeans&gt;</span>
<span class="code-tag">&lt;/jaxrs:server&gt;</span>

<p>Additionally, JMS queue or topic <a href=""
class="external-link" rel="nofollow">configuration</a> needs to be done, for example,
please see this <a href=""
class="external-link" rel="nofollow">beans.xml</a>. Please note how a serviceName
attribute is used to specify a service QName for a jaxrs endpoint (default is {<a href=""
class="external-link" rel="nofollow"></a>}ServiceClassName),
this service name is <br/>
used to configure a jms destination.</p>

<p>Here is the actual <a href=""
class="external-link" rel="nofollow">test</a>. </p>

<p>Here are JMS properties which can help with matching a required method on the JAXRS
endpoint :</p>
<ul class="alternate" type="square">
	<li>"Content-Type" : default is "text/xml"</li>
	<li>"Accept" : default is "<b>/</b>"</li>
	<li>"OnewayMessage" : default is "false"</li>
	<li>"org.apache.cxf.message.Message.REQUEST_URI" : default is "/"</li>
	<li>"org.apache.cxf.message.Message.HTTP_REQUEST_METHOD" : default is "POST"</li>

<p>If JMS messages are sent to topic destinations then one has to either set a "OnewayMessage"
property or ensure that target JAXRS methods are annotated with org.apache.cxf.jaxrs.ext.Oneway.

<p>As far as REQUEST_URI is concerned, it is initially matched against a jaxrs:server/@address.
So if REQUEST_URI is not set or set to "/" then jaxrs:server/@address has to be set to "/".
If REQUEST_URI is set to "/bar/foo" and<br/>
jaxrs:server/@address is set to "/bar" then it will be '/foo' which will be used to find a
root resource class and its method.</p>

<p>By referencing a bean such as 'org.apache.cxf.systest.jaxrs.JMSBookStore' from multiple
jaxrs endpoints you can ensure that both HTTP and JMS requests are handled by the same service
bean. In such cases you may want to use a CXF JAXRS specific <a href=""
class="external-link" rel="nofollow">ProtocolHeaders</a> context which will let you
get either HTTP or JMS headers. </p>

<h1><a name="JAX-RSAdvancedFeatures-Onewayinvocations"></a>Oneway invocations</h1>

<p>Resource methods with an org.apache.cxf.jaxrs.ext.Oneway annotation will be invoked
oneway with the original request returning 202 HTTP status. HTTP or JMS clients can also add
a "OnewayRequest" header if adding Oneway annotations is not an option.</p>

<h1><a name="JAX-RSAdvancedFeatures-RESTfulserviceswithoutannotations"></a>RESTful
services without annotations </h1>

<p>One of the latest CXF JAX-RS extensions allows users to provide external models with
the information which the runtime typically gets from JAX-RS annotations like @Path, @PathParam,
@Consumes, @Produces, etc.<br/>
There might be a number of cases when it can be advantageous to describe how a given resource
can be exposed as a RESTful service without actually modifying this resource. For example,
when new dynamic interface implementations are registered, when no source code can be modified,
when the cost of future updates (for ex, modifying the value of @Path annotations) is considered
to be expensive, etc.</p>

<p>User model schema type is described in the <a href=""
class="external-link" rel="nofollow">jaxrs.xsd</a>. </p>

<p>The top-level 'model' element can have 'resource' children elements. A 'resource'
element describes a resource class which can be either a root resource class or a sub-resource
one and it can have attributes describing 'path', 'produces' and 'consumes' values and it
has a 'name' attribute which identifies a fully-qualified resource class. <br/>
A 'resource' element can have a number of 'operation' elements pointing to resource methods
(with its 'name' attribute) and can have 'path', 'produces', 'consumes' and 'verb' (HTTP method)
values. An 'operation' element which has no 'verb' attribute is treated as a sub-resource
locator - a corresponding resource class has to be available in the model with its 'name'
attribute matching the return type's name of this operation.<br/>
Every operation can have a number of 'param' elements. A 'param' element should have its 'name'
attribute matching a corresponding parameter name in the class resource method. Its 'type'
can have the following values : 'PATH', 'QUERY', 'CONTEXT', 'HEADER', 'MATRIX', 'COOKIE',
'FORM' or 'REQUEST_BODY'. Parameters corresponding to response types do not have to be described.
It can also have 'defaultValue' and 'encoded' values being set.</p>

<p>Starting from CXF 2.3.2-SNAPSHOT a "oneway" attribute can also be applied to individual

<p>Here is an example :</p>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-xml">
<span class="code-tag">&lt;model xmlns=<span class="code-quote">""</span>&gt;</span>
  &lt;resource name=<span class="code-quote">"org.apache.cxf.systest.jaxrs.BookStoreNoAnnotations"</span>
path=<span class="code-quote">"bookstore"</span>
    produces=<span class="code-quote">"application/json"</span> consumes=<span
    <span class="code-tag">&lt;operation name=<span class="code-quote">"getBook"</span>
verb=<span class="code-quote">"GET"</span> path=<span class="code-quote">"/books/{id}"</span>
produces=<span class="code-quote">"application/xml"</span>&gt;</span>
       <span class="code-tag">&lt;param name=<span class="code-quote">"id"</span>
type=<span class="code-quote">"PATH"</span>/&gt;</span>
    <span class="code-tag">&lt;/operation&gt;</span>
    <span class="code-tag">&lt;operation name=<span class="code-quote">"getBookChapter"</span>
path=<span class="code-quote">"/books/{id}/chapter"</span>&gt;</span>
       <span class="code-tag">&lt;param name=<span class="code-quote">"id"</span>
type=<span class="code-quote">"PATH"</span>/&gt;</span>
    <span class="code-tag">&lt;/operation&gt;</span>
    <span class="code-tag">&lt;operation name=<span class="code-quote">"updateBook"</span>
verb=<span class="code-quote">"PUT"</span>&gt;</span>
       <span class="code-tag">&lt;param name=<span class="code-quote">"book"</span>
type=<span class="code-quote">"REQUEST_BODY"</span>/&gt;</span>
    <span class="code-tag">&lt;/operation&gt;</span>
  <span class="code-tag">&lt;/resource&gt;</span>
  <span class="code-tag">&lt;resource name=<span class="code-quote">"org.apache.cxf.systest.jaxrs.ChapterNoAnnotations"</span>&gt;</span>
    <span class="code-tag">&lt;operation name=<span class="code-quote">"getItself"</span>
verb=<span class="code-quote">"GET"</span>/&gt;</span>
    <span class="code-tag">&lt;operation name=<span class="code-quote">"updateChapter"</span>
verb=<span class="code-quote">"PUT"</span> consumes=<span class="code-quote">"application/xml"</span>&gt;</span>
        <span class="code-tag">&lt;param name=<span class="code-quote">"content"</span>
type=<span class="code-quote">"REQUEST_BODY"</span>/&gt;</span>
    <span class="code-tag">&lt;/operation&gt;</span>
  <span class="code-tag">&lt;/resource&gt;</span>
<span class="code-tag">&lt;/model&gt;</span>

<p>This model describes two resources, BookStoreNoAnnotations and ChapterNoAnnotations.
The BookStoreNoAnnotations resource has three resource operations, 'getBook', 'getBookChapter'
and 'updateBook'. Note that the 'getBookChapter' operation element (described in the model)
has no 'verb' attribute so runtime will identify it as a subresource locator.<br/>
The runtime will introspect the <a href=""
class="external-link" rel="nofollow">org.apache.cxf.systest.jaxrs.BookStoreNoAnnotations</a>
class and check the return types for both 'getBook' and 'getBookChapter' methods.  BookStoreNoAnnotations.getBookChapter()
method's return type is <a href=""
class="external-link" rel="nofollow">org.apache.cxf.systest.jaxrs.ChapterNoAnnotations</a>
so the model will be checked if it contains the resource element with the 'name' attribute
equal to 'org.apache.cxf.systest.jaxrs.ChapterNoAnnotations'. After this resource has been
found, the  ChapterNoAnnotations class is recognized as a sub-resource and then its 'getItself'
method is checked.  </p>

<p>Additionally the BookStoreNoAnnotations resource declares that all its resource methods
produce 'application/json' mediaTypes, while its 'getBook' method overrides its with its own
'produces' value. BookStoreNoAnnotations resource also has a 'consumes' attribute which requires
all of the resource methods (such as 'updateBook') to consume "application/json" formats.
The ChapterNoAnnotations 'updateChapter' resource operation requires 'application/xml' formats.</p>

<p>You can use a comma-seperated list of media type values if needed, for example, produces("application/xml;charset=utf-8,application/json")
or consumes("application/xml;charset=utf-8,application/json").</p>

<p>Please also see this <a href=""
class="external-link" rel="nofollow">model file</a> for an example. Providing this
file will let all implementations of the interface described in this model instance be exposed
as RESTful services supported by the JAX-RS runtime. </p>

<h2><a name="JAX-RSAdvancedFeatures-Configuration"></a>Configuration </h2>

<p>A user model can be referenced in a number of ways. It can be embedded in a jaxrs:server
endpoint definition or linked to through a jaxrs:server modelRef attribute as a classpath
resource. </p>

<p>Please see this <a href=""
class="external-link" rel="nofollow">bean</a> Spring configuration file, look at
jaxrs server beans with 'bookservice6' and 'bookservice7' names.</p>

<p>Note that when registering a model from Spring you do not need to declare a jaxrs
server serviceBeans section - the runtime will instantiate the beans itself. If you do need
to inject certain properties into your service bean from Spring then you do need to declare
a service bean too. In this case this bean will be instantiated twice - once by the runtime
during the model introspection and once by Spring, however in the end it will be the bean
created by Spring that will be used, the one created by the runtime will be removed.<br/>
You can avoid this double instantiation by having your model describing the interfaces which
the actual root resource beans will implement. In this case only Spring will create a bean
and the runtime will apply the model description to this injected bean. Note that if Spring
proxifies your bean (for example by applying transaction aspects to it) then the model does
have to describe an interface for a match between the model and the injected bean proxy to

<p>Please have a look at <a href=""
class="external-link" rel="nofollow">this Spring bean</a>. The jaxrs endpoint with
id 'bookservice2' will have BookStoreWithNoAnnotations created twice but it will be the Spring
created BookStoreWithNoAnnotations bean that will serve as a resource class instance. The
jaxrs endpoint with id 'bookservice3' will have BookStoreWithNoAnnotationsImpl class instantiated
only by Spring, with the model describing BookStoreWithNoAnnotationsInterface only that this
class implements.</p>

<p>You can also register a model programmatically, for example :</p>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
JAXRSServerFactoryBean sf = <span class="code-keyword">new</span> JAXRSServerFactoryBean();
            sf.setAddress(<span class="code-quote">"http:<span class="code-comment">//localhost:9080/"</span>);
</span><span class="code-object">String</span> modelRef = <span class="code-quote">"classpath:/org/apache/cxf/systest/jaxrs/resources/resources2.xml"</span>;

<span class="code-comment">// or <span class="code-keyword">if</span> you
have <span class="code-keyword">interface</span> classes described in the model
already loaded, ex : OSGI
</span><span class="code-comment">// sf.setModelRefWithServiceClass(modelRef,
<span class="code-comment">// register an actual bean only <span class="code-keyword">if</span>
the model describes interfaces
</span>sf.setServiceBeans(<span class="code-keyword">new</span> BookStoreNoAnnotationsImpl());

<p>Please also see <a href=""
class="external-link" rel="nofollow">this system test</a> for the example of how
model beans like UserResource can be created and registered programmatically.</p>

<p>Similarly, you can register a user model on the client side, either from jaxrs:client
or programmatically, example :</p>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
JAXRSClientFactoryBean cf = <span class="code-keyword">new</span> JAXRSClientFactoryBean();
cf.setAddress(<span class="code-quote">"http:<span class="code-comment">//localhost:9080/"</span>);
</span><span class="code-object">String</span> modelRef = <span class="code-quote">"classpath:/org/apache/cxf/systest/jaxrs/resources/resources2.xml"</span>;
BookStoreNoAnnotations proxy = cf.create(BookStoreNoAnnotations.class);

<p>At the moment it is only possible to register a user model with CXFNonSpringJAXRSServlet
using the latest 2.2.3-SNAPSHOT like the way it is done in this <a href=""
class="external-link" rel="nofollow">web.xml</a>. See CXFServlet3 and CXFServlet4
servlet declarations. Note that CXFServlet4 registers a model containing interfaces so it
also registers a BookStoreNoAnnotationsImpl service class.</p>

<p>The workaround is to create a custom servlet :</p>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
<span class="code-keyword">public</span> class JAXRSUserModelServlet <span
class="code-keyword">extends</span> CXFNonSpringJaxrsServlet  {

<span class="code-keyword">public</span> void loadBus(ServletConfig servletConfig)
<span class="code-keyword">throws</span> ServletException {

<span class="code-keyword">super</span>.loadBus(servletConfig);

JAXRSServerFactoryBean sf = <span class="code-keyword">new</span> JAXRSServerFactoryBean();
<span class="code-object">String</span> address = servletConfig.getInitParameter(SERVICE_ADDRESS_PARAM);
<span class="code-comment">//jaxrs.address
</span><span class="code-keyword">if</span> (address == <span class="code-keyword">null</span>)
address = <span class="code-quote">"/"</span>;

<span class="code-comment">// modelRef needs to start from 'classpath:', ex 'classpath:/WEB-INF/models/model1.xml
</span><span class="code-object">String</span> modelRef = servletConfig.getInitParameter(<span
    <div id="commentsSection" class="wiki-content pageSection">
       <div style="float: right;">
            <a href=""
class="grey">Change Notification Preferences</a>
       <a href="">View
       <a href=";showCommentArea=true#addcomment">Add

View raw message