cxf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r888170 - in /websites/production/cxf/content: cache/docs.pageCache docs/continuations.html
Date Tue, 26 Nov 2013 17:48:12 GMT
Author: buildbot
Date: Tue Nov 26 17:48:11 2013
New Revision: 888170

Log:
Production update by buildbot for cxf

Modified:
    websites/production/cxf/content/cache/docs.pageCache
    websites/production/cxf/content/docs/continuations.html

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

Modified: websites/production/cxf/content/docs/continuations.html
==============================================================================
--- websites/production/cxf/content/docs/continuations.html (original)
+++ websites/production/cxf/content/docs/continuations.html Tue Nov 26 17:48:11 2013
@@ -28,6 +28,15 @@
 <meta name="description" content="Apache CXF, Services Framework - Continuations">
 
 
+<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/shBrushJava.js'></script>
+<script>
+  SyntaxHighlighter.defaults['toolbar'] = false;
+  SyntaxHighlighter.all();
+</script>
 
 
     <title>
@@ -122,10 +131,63 @@ Apache CXF -- Continuations
            <div class="wiki-content">
 <div id="ConfluenceContent"><p><span style="font-size:2em;font-weight:bold">
Continuations </span></p>
 
+<div>
+<ul><li><a shape="rect" href="#Continuations-ContinuationsAPI">Continuations
API</a></li><li><a shape="rect" href="#Continuations-UseAsyncMethod">UseAsyncMethod</a></li><li><a
shape="rect" href="#Continuations-JAXRS2.0AsyncResponse">JAX-RS 2.0 AsyncResponse</a></li><li><a
shape="rect" href="#Continuations-SuspendinginvocationsfromCXFinterceptors">Suspending
invocations from CXF interceptors</a></li></ul></div>
+
+<h1><a shape="rect" name="Continuations-ContinuationsAPI"></a>Continuations
API </h1>
+
+<p>CXF offers Continuations API to manage asynchronous (suspended) invocations.</p>
+
+<p><a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/core/src/main/java/org/apache/cxf/continuations/ContinuationProvider.java">ContinuationProvider</a>
represents a transport capable of suspending and resuming the invocations on request. </p>
+
+<p>CXF offers Servlet3 and legacy Jetty Continuations HTTP as well as JMS ContinuationProvider
implementations. <br clear="none">
+ContinuationProvider can be used to get <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/core/src/main/java/org/apache/cxf/continuations/Continuation.java">Continuation</a>
which represents a current active or suspended invocation. </p>
+
+<p>The provider and continuations can be obtained from the current CXF message like
this: </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.continuations.ContinuationProvider;
+import org.apache.cxf.continuations.Continuation;
+
+ContinuationProvider provider = (ContinuationProvider)message.get(ContinuationProvider.class.getName())
+Continuation continuation = provider.getContinuation();
+]]></script>
+</div></div> 
+
+<p>The continuation can be suspended and resumed. </p>
+
+<p>Calling Continuation.suspend() and returning from the current method/code is enough
to get CXF suspending the request. Additionally throwing <a shape="rect" class="external-link"
href="http://svn.apache.org/repos/asf/cxf/trunk/core/src/main/java/org/apache/cxf/continuations/SuspendedInvocationException.java">SuspendedInvocationException</a>
was required originally but is no longer required/recommended.</p>
+
+<p>Resuming the continuation will get the suspended thread returning, this is typically
done by a thread which has completed an asynchronous task. </p>
+
+<p>Advanced applications can register <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/core/src/main/java/org/apache/cxf/continuations/ContinuationCallback.java">ContinuationCallback</a>
with the current exchange in order to get the notifications that a given Continuation has
completed its work by returning the data to the client. </p>
+
+<p>The custom applications can interact directly with Continuations API. CXF also offers
higher-level support for asynchronous invocations built on top of Continuations API.</p>
+
+
+<h1><a shape="rect" name="Continuations-UseAsyncMethod"></a>UseAsyncMethod</h1>
+
+<p>JAX-WS frontend supports this annotation, please check the <a shape="rect" href="http://cxf.apache.org/docs/annotations.html">CXF
Annotations</a> page for more information.</p>
+
+<h1><a shape="rect" name="Continuations-JAXRS2.0AsyncResponse"></a>JAX-RS
2.0 AsyncResponse</h1>
+
+<p>JAX-RS 2.0 AsyncResponse is implemented in terms of Continuations API. Please see
<a shape="rect" href="http://cxf.apache.org/docs/jax-rs-basics.html#JAX-RSBasics-Suspendedinvocations">this
section</a> for more information. </p>
+
+<h1><a shape="rect" name="Continuations-SuspendinginvocationsfromCXFinterceptors"></a>Suspending
invocations from CXF interceptors</h1>
+
+<p>Advanced custom CXF interceptors can suspend the incoming requests and resume them
when needed. <br clear="none">
+Example:</p>
+
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+//TODO
+]]></script>
+</div></div>
+
+
 
 
-<p>CXF uses Continuations API to manage suspended invocations over HTTP and JMS Transports.<br
clear="none">
-// In progress  </p>
 
 </div>
            </div>



Mime
View raw message