cxf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r887672 - in /websites/production/cxf/content: cache/docs.pageCache docs/jax-rs-basics.html docs/jax-rs.html
Date Fri, 22 Nov 2013 11:48:17 GMT
Author: buildbot
Date: Fri Nov 22 11:48:17 2013
New Revision: 887672

Log:
Production update by buildbot for cxf

Modified:
    websites/production/cxf/content/cache/docs.pageCache
    websites/production/cxf/content/docs/jax-rs-basics.html
    websites/production/cxf/content/docs/jax-rs.html

Modified: websites/production/cxf/content/cache/docs.pageCache
==============================================================================
Binary files - no diff available.

Modified: websites/production/cxf/content/docs/jax-rs-basics.html
==============================================================================
--- websites/production/cxf/content/docs/jax-rs-basics.html (original)
+++ websites/production/cxf/content/docs/jax-rs-basics.html Fri Nov 22 11:48:17 2013
@@ -133,7 +133,7 @@ Apache CXF -- JAX-RS Basics
 <div id="ConfluenceContent"><p><span style="font-size:2em;font-weight:bold">
JAX-RS : Understanding the Basics </span></p>
 
 <div>
-<ul><li><a shape="rect" href="#JAX-RSBasics-WhatisNewinJAXRS2.0">What is
New in JAX-RS 2.0</a></li><ul><li><a shape="rect" href="#JAX-RSBasics-Filters">Filters</a></li><ul><li><a
shape="rect" href="#JAX-RSBasics-Server">Server</a></li><li><a shape="rect"
href="#JAX-RSBasics-Client">Client</a></li></ul><li><a shape="rect"
href="#JAX-RSBasics-Interceptors">Interceptors</a></li><li><a shape="rect"
href="#JAX-RSBasics-DynamicFeatures">Dynamic Features</a></li><li><a
shape="rect" href="#JAX-RSBasics-Exceptions">Exceptions</a></li><li><a
shape="rect" href="#JAX-RSBasics-Suspendedinvocations">Suspended invocations</a></li><li><a
shape="rect" href="#JAX-RSBasics-Parameterconverters">Parameter converters</a></li><li><a
shape="rect" href="#JAX-RSBasics-Beanparameters">Bean parameters</a></li><li><a
shape="rect" href="#JAX-RSBasics-ResourceInfo">ResourceInfo</a></li><li><a
shape="rect" href="#JAX-RSBasics-Injectionintosubresources">Injection into subresources</a></li><li><a
shape="rect" href="
 #JAX-RSBasics-Updatestothematchingalgorithm">Updates to the matching algorithm</a></li><li><a
shape="rect" href="#JAX-RSBasics-ClientAPI">Client API</a></li></ul><li><a
shape="rect" href="#JAX-RSBasics-Resourceclass">Resource class</a></li><li><a
shape="rect" href="#JAX-RSBasics-@Path">@Path</a></li><li><a shape="rect"
href="#JAX-RSBasics-HTTPMethod">HTTP Method</a></li><li><a shape="rect"
href="#JAX-RSBasics-Returntypes">Return types</a></li><li><a shape="rect"
href="#JAX-RSBasics-Exceptionhandling">Exception handling</a></li><ul><li><a
shape="rect" href="#JAX-RSBasics-MappingexceptionsthrownfromCXFinterceptors">Mapping exceptions
thrown from CXF interceptors</a></li><li><a shape="rect" href="#JAX-RSBasics-CustomizingdefaultWebApplicationExceptionmapper">Customizing
default WebApplicationException mapper</a></li></ul><li><a shape="rect"
href="#JAX-RSBasics-DealingwithParameters">Dealing with Parameters</a></li><ul><li><a
shape="rect" href="#JAX-RSBasics-Parameterbeans">Parameter be
 ans</a></li></ul><li><a shape="rect" href="#JAX-RSBasics-Resourcelifecycles">Resource
lifecycles</a></li><li><a shape="rect" href="#JAX-RSBasics-Overviewoftheselectionalgorithm.">Overview
of the selection algorithm.</a></li><ul><li><a shape="rect" href="#JAX-RSBasics-Selectingbetweenmultipleresourceclasses">Selecting
between multiple resource classes</a></li><li><a shape="rect" href="#JAX-RSBasics-Selectingbetweenmultipleresourcemethods">Selecting
between multiple resource methods</a></li><li><a shape="rect" href="#JAX-RSBasics-Resourcemethodsandmediatypes">Resource
methods and media types</a></li><li><a shape="rect" href="#JAX-RSBasics-Customselectionbetweenmultipleresources">Custom
selection between multiple resources</a></li></ul><li><a shape="rect"
href="#JAX-RSBasics-Contextannotations">Context annotations</a></li><ul><li><a
shape="rect" href="#JAX-RSBasics-CustomContexts">Custom Contexts</a></li></ul><li><a
shape="rect" href="#JAX-RSBasics-URIcalculationusingUriInfoandUriBuild
 er">URI calculation using UriInfo and UriBuilder</a></li><li><a shape="rect"
href="#JAX-RSBasics-Annotationinheritance">Annotation inheritance</a></li><li><a
shape="rect" href="#JAX-RSBasics-Subresourcelocators.">Sub-resource locators.</a></li><ul><li><a
shape="rect" href="#JAX-RSBasics-Staticresolutionofsubresources">Static resolution of subresources</a></li></ul><li><a
shape="rect" href="#JAX-RSBasics-MessageBodyProviders">Message Body Providers</a></li><ul><li><a
shape="rect" href="#JAX-RSBasics-CustomMessageBodyProviders">Custom Message Body Providers</a></li><li><a
shape="rect" href="#JAX-RSBasics-Registeringcustomproviders">Registering custom providers</a></li></ul><li><a
shape="rect" href="#JAX-RSBasics-Customizingmediatypesformessagebodyproviders">Customizing
media types for message body providers</a></li><li><a shape="rect" href="#JAX-RSBasics-AdvancedHTTP">Advanced
HTTP</a></li></ul></div>
+<ul><li><a shape="rect" href="#JAX-RSBasics-WhatisNewinJAXRS2.0">What is
New in JAX-RS 2.0</a></li><ul><li><a shape="rect" href="#JAX-RSBasics-Filters">Filters</a></li><ul><li><a
shape="rect" href="#JAX-RSBasics-Server">Server</a></li><li><a shape="rect"
href="#JAX-RSBasics-Client">Client</a></li></ul><li><a shape="rect"
href="#JAX-RSBasics-Interceptors">Interceptors</a></li><li><a shape="rect"
href="#JAX-RSBasics-DynamicFeatures">Dynamic Features</a></li><li><a
shape="rect" href="#JAX-RSBasics-Exceptions">Exceptions</a></li><li><a
shape="rect" href="#JAX-RSBasics-Suspendedinvocations">Suspended invocations</a></li><li><a
shape="rect" href="#JAX-RSBasics-Parameterconverters">Parameter converters</a></li><li><a
shape="rect" href="#JAX-RSBasics-Beanparameters">Bean parameters</a></li><li><a
shape="rect" href="#JAX-RSBasics-ResourceInfo">ResourceInfo</a></li><li><a
shape="rect" href="#JAX-RSBasics-Injectionintosubresources">Injection into subresources</a></li><li><a
shape="rect" href="
 #JAX-RSBasics-Updatestothematchingalgorithm">Updates to the matching algorithm</a></li><li><a
shape="rect" href="#JAX-RSBasics-Link">Link</a></li><li><a shape="rect"
href="#JAX-RSBasics-ClientAPI">Client API</a></li></ul><li><a
shape="rect" href="#JAX-RSBasics-Resourceclass">Resource class</a></li><li><a
shape="rect" href="#JAX-RSBasics-@Path">@Path</a></li><li><a shape="rect"
href="#JAX-RSBasics-HTTPMethod">HTTP Method</a></li><li><a shape="rect"
href="#JAX-RSBasics-Returntypes">Return types</a></li><li><a shape="rect"
href="#JAX-RSBasics-Exceptionhandling">Exception handling</a></li><ul><li><a
shape="rect" href="#JAX-RSBasics-MappingexceptionsthrownfromCXFinterceptors">Mapping exceptions
thrown from CXF interceptors</a></li><li><a shape="rect" href="#JAX-RSBasics-CustomizingdefaultWebApplicationExceptionmapper">Customizing
default WebApplicationException mapper</a></li></ul><li><a shape="rect"
href="#JAX-RSBasics-DealingwithParameters">Dealing with Parameters</a></li><ul><li><a
sh
 ape="rect" href="#JAX-RSBasics-Parameterbeans">Parameter beans</a></li></ul><li><a
shape="rect" href="#JAX-RSBasics-Resourcelifecycles">Resource lifecycles</a></li><li><a
shape="rect" href="#JAX-RSBasics-Overviewoftheselectionalgorithm.">Overview of the selection
algorithm.</a></li><ul><li><a shape="rect" href="#JAX-RSBasics-Selectingbetweenmultipleresourceclasses">Selecting
between multiple resource classes</a></li><li><a shape="rect" href="#JAX-RSBasics-Selectingbetweenmultipleresourcemethods">Selecting
between multiple resource methods</a></li><li><a shape="rect" href="#JAX-RSBasics-Resourcemethodsandmediatypes">Resource
methods and media types</a></li><li><a shape="rect" href="#JAX-RSBasics-Customselectionbetweenmultipleresources">Custom
selection between multiple resources</a></li></ul><li><a shape="rect"
href="#JAX-RSBasics-Contextannotations">Context annotations</a></li><ul><li><a
shape="rect" href="#JAX-RSBasics-CustomContexts">Custom Contexts</a></li></ul><li><a
shape="rect
 " href="#JAX-RSBasics-URIcalculationusingUriInfoandUriBuilder">URI calculation using UriInfo
and UriBuilder</a></li><li><a shape="rect" href="#JAX-RSBasics-Annotationinheritance">Annotation
inheritance</a></li><li><a shape="rect" href="#JAX-RSBasics-Subresourcelocators.">Sub-resource
locators.</a></li><ul><li><a shape="rect" href="#JAX-RSBasics-Staticresolutionofsubresources">Static
resolution of subresources</a></li></ul><li><a shape="rect" href="#JAX-RSBasics-MessageBodyProviders">Message
Body Providers</a></li><ul><li><a shape="rect" href="#JAX-RSBasics-CustomMessageBodyProviders">Custom
Message Body Providers</a></li><li><a shape="rect" href="#JAX-RSBasics-Registeringcustomproviders">Registering
custom providers</a></li></ul><li><a shape="rect" href="#JAX-RSBasics-Customizingmediatypesformessagebodyproviders">Customizing
media types for message body providers</a></li><li><a shape="rect" href="#JAX-RSBasics-AdvancedHTTP">Advanced
HTTP</a></li></ul></div>
 
 <h1><a shape="rect" name="JAX-RSBasics-WhatisNewinJAXRS2.0"></a>What is
New in JAX-RS 2.0</h1>
 
@@ -239,6 +239,12 @@ public class Root2 {
 
 <p>In JAX-RS 1.1 a request with URI such as "/1" is not guaranteed to be matched and
in CXF 2.7.x or earlier the use of CXF specific ResourceComparator is required to ensure Root1
and its get() method gets selected. In CXF 3.0.0 Root1 get() will always be correctly selected.
Note ResourceComparator may still be of help in some cases even in CXF 3.0.0. </p>
 
+<h2><a shape="rect" name="JAX-RSBasics-Link"></a>Link</h2>
+
+<p><a shape="rect" class="external-link" href="https://jax-rs-spec.java.net/nonav/2.0/apidocs/javax/ws/rs/core/Link.html"
rel="nofollow">Link</a> is a utility class for building HTTP links as HTTP Link headers
or application data links. <br clear="none">
+UriInfo, UriBuilder, Response and ResponseBuilder classes have been enhanced to support Link.</p>
+
+
 <h2><a shape="rect" name="JAX-RSBasics-ClientAPI"></a>Client API</h2>
 <p>JAX-RS 2.0 Client API has been completely implemented in CXF 3.0.0, please see the
<a shape="rect" href="http://cxf.apache.org/docs/jax-rs-client-api.html#JAX-RSClientAPI-JAXRS2.0ClientAPI">Client
API page</a> for more information.</p>
 

Modified: websites/production/cxf/content/docs/jax-rs.html
==============================================================================
--- websites/production/cxf/content/docs/jax-rs.html (original)
+++ websites/production/cxf/content/docs/jax-rs.html Fri Nov 22 11:48:17 2013
@@ -173,7 +173,80 @@ in CXF 3.0.0. Here are more details on t
 
 <p>Note, CXF filters had org.apache.cxf.message.Message available in the signature.
If CXF Message is used in the existing CXF RequestHandler or ResponseHandler then use "org.apache.cxf.phase.PhaseInterceptorChain.getCurrentMessage()"
or "org.apache.cxf.jaxrs.util.JAXRSUtils.getCurrentMessage()" to get a Message which has all
the contextual information available.  </p>
 
-<p>2. CXF org.apache.cxf.jaxrs.ext.form.Form has been dropped, please use JAX-RS 2.0
<a shape="rect" class="external-link" href="https://jax-rs-spec.java.net/nonav/2.0/apidocs/javax/ws/rs/core/Form.html"
rel="nofollow">Form</a> instead. </p>
+<p>For example, instead of</p>
+
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+
+public class CustomRequestHandler implements RequestHandler {
+    public Response handleRequest(Message message, ClassResourceInfo cri) {
+    }
+}
+
+public class CustomResponseHandler implements ResponseHandler {
+    public Response handleResponse(Message message, OperationResourceInfo ori, Response response)
{
+    }
+}
+
+]]></script>
+</div></div>
+
+<p>do</p>
+
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+
+public class CustomRequestFilter implements ContainerRequestHandler {
+    public void filter(ContainerRequestContext context) {
+        Message message = JAXRSUtils.getCurrentMessage();
+        ClassResourceInfo cri = message.getExchange().get(OperationResourceInfo.class).getResourceClass();
+
+        // or consider using JAX-RS 2.0 ResourceInfo context
+
+        // finally use context.abortWith(Response) if you need to block the request 
+    }
+}
+
+public class CustomResponseFilter implements ContainerResponseFilter {
+    public void filter(Message message, OperationResourceInfo ori, Response response) {
+        public class CustomRequestFilter implements ContainerRequestHandler {
+    public void filter(ContainerRequestContext inContext, ContainerResponseContext outContext)
{
+        Message message = JAXRSUtils.getCurrentMessage();
+        OperationResourceInfo cri = message.getExchange().get(OperationResourceInfo.class);
+
+        // or consider using JAX-RS 2.0 ResourceInfo context 
+        
+        // finally, work with ContainerResponseContext to modify specific Response properties
+    }
+}
+
+]]></script>
+</div></div>
+
+<p>The above is only needed to ease the migration of the existing RequestHandler or
ResponseHandler implementations. Prefer writing portable JAX-RS 2.0 filter implementations
if possible. CXF interceptors can be used to do the CXF specific code if needed.</p>
+
+
+<p>2. CXF org.apache.cxf.jaxrs.ext.form.Form has been dropped, please use JAX-RS 2.0
<a shape="rect" class="external-link" href="https://jax-rs-spec.java.net/nonav/2.0/apidocs/javax/ws/rs/core/Form.html"
rel="nofollow">Form</a> instead. For example, use:</p>
+
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+import javax.ws.rs.core.Form;
+
+Form form = new Form().param("a", "b");
+]]></script>
+</div></div> 
+
+<p>instead of </p>
+
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+import org.apache.cxf.jaxrs.ext.form.Form;
+
+Form form = new Form().set("a", "b");
+]]></script>
+</div></div> 
+
+
 
 <p>3. CXF ParameterHandler has been dropped. Please use <a shape="rect" class="external-link"
href="https://jax-rs-spec.java.net/nonav/2.0/apidocs/javax/ws/rs/ext/ParamConverterProvider.html"
rel="nofollow">ParameterConverterProvider</a> instead, it can be used both on the
server and client sides.</p>
 
@@ -239,10 +312,16 @@ Set CXF "support.wae.spec.optimization" 
 
 <p>This will in turn pull other <a shape="rect" href="http://cxf.apache.org/project-status.html">CXF
modules</a> such <tt>cxf-core</tt> and <tt>cxf-rt-transports-http</tt>,
check <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/rt/frontend/jaxrs/pom.xml">the
pom</a> for more information.</p>
 
+<p><tt>javax.ws.rs/javax.ws.rs-api/2.0</tt> dependency provides JAX-RS
2.0 Final API.</p>
+
+<p>Existing JAX-RS 1.1 applications can run in CXF 3.0.0.</p>
+
 <h3><a shape="rect" name="JAX-RS-CXF2.7.0"></a>CXF 2.7.0</h3>
 
 <p><tt>javax.ws.rs/javax.ws.rs-api/2.0-m10</tt> replaces <tt>javax.ws.rs/jsr311-api/1.1.1</tt>.
This is very close to JSR-339 Public Release API level. Users can expect very minor differences
in the Final Release of API.  </p>
 
+<p>Existing JAX-RS 1.1 applications can run in CXF 2.7.x.</p>
+
 <h3><a shape="rect" name="JAX-RS-CXF2.6.x"></a>CXF 2.6.x</h3>
 
 <p>Please check the <a shape="rect" href="http://cxf.apache.org/docs/26-migration-guide.html">CXF
2.6 Migration Guide</a> for the information about all the changes affecting the JAX-RS
users. Typically adding the frontend jaxrs dependency should be enough.</p>
@@ -348,7 +427,9 @@ A standalone <a shape="rect" class="exte
 
 <h2><a shape="rect" name="JAX-RS-ClientAPI"></a>Client API</h2>
 
-<p>JAX-RS 1.1 does not provide for a standard approach toward consuming pure HTTP-based
services thus CXF JAX-RS provides a comprehensive support for developing RESTful clients by
introducing 3 flavors of the client API: proxy-based, HTTP-centric and XML-centric.</p>
+<p>CXF 3.0.0 implements JAX-RS 2.0 Client API. </p>
+
+<p>CXF 2.7.x or earlier provides a comprehensive support for developing RESTful clients
by supporting 3 flavors of the client API: proxy-based, HTTP-centric and XML-centric. CXF-specific
client API is supported alongside new JAX-RS 2.0 Client API in CXF 3.0.0.</p>
 
 <p>Please see the <a shape="rect" href="jax-rs-client-api.html" title="JAX-RS Client
API">JAX-RS Client API</a> page for more information.</p>
 
@@ -358,9 +439,14 @@ A standalone <a shape="rect" class="exte
 
 <p>Please see the <a shape="rect" href="jax-rs-filters.html" title="JAX-RS Filters">JAX-RS
Filters</a> page for more information.</p>
 
+<p>Please see the <span class="error">[JAX-RS Basic]</span> page for more
information about new JAX-RS 2.0 filters and interceptors available in CXF 2.7.x and 3.0.0.
</p>
+
 <h2><a shape="rect" name="JAX-RS-ServicelistingsandWADLsupport"></a>Service
listings and WADL support</h2>
 
-<p>CXF JAX-RS supports <a shape="rect" class="external-link" href="http://www.w3.org/Submission/wadl"
rel="nofollow">WADL</a>. CXF JAX-RS service endpoints can be listed in the service
listings page and users can check the WADL documents.</p>
+<p><b>New</b>: Swagger feature has been introduced.</p>
+
+<p>CXF JAX-RS supports <a shape="rect" class="external-link" href="http://www.w3.org/Submission/wadl"
rel="nofollow">WADL</a>. CXF JAX-RS service endpoints can be listed in the service
listings page and users can check the WADL documents. </p>
+
 
 <p>Please see the <a shape="rect" href="jaxrs-services-description.html" title="JAXRS
Services Description">JAXRS Services Description</a> page for more information. </p>
 



Mime
View raw message