New Features

-

New UDP transport
New optional HTTP transport based on Apache HTTP Components HttpAsyncClient.
Support for the SOAP over UDP specification

Support for WS-Discovery +

New UDP Transport
New optional HTTP transport based on Apache HTTP Components HttpAsyncClient.
Support for the SOAP over UDP.
Support for WS-Discovery
- Services can send Hello/Bye when started/stopped as well as respond to Probe requests
- API for sending probes and resolving to EndpointReferences

Initial support for parts of the JAX-RS 2.0 specification

Additional methods on WebClient to provide asynchronous invocations

Added: websites/production/cxf/content/docs/asynchronous-client-http-transport.html ============================================================================== --- websites/production/cxf/content/docs/asynchronous-client-http-transport.html (added) +++ websites/production/cxf/content/docs/asynchronous-client-http-transport.html Wed Sep 26 19:47:26 2012 @@ -0,0 +1,211 @@ + + + + + + + + + + + + +Apache CXF -- Asynchronous Client HTTP Transport + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+

+ +

+ + + + + +

+ +

+

Asynchronous Client HTTP Transport

+ +

By default, CXF uses a transport based on the in-JDK HttpURLConnection object to perform HTTP requests. The HttpURLConnection object uses a blocking model for all IO operations which requires a per-thread execution model. From a pure performance standpoint, this model generally performs very well, but it does have problems scaling when many requests need to be executed simultaneously.

+ +

Also, the JAX-WS specification allows for generation of asynchronous methods on generated proxies as well as using asynchronous methods on the Dispatch objects. These methods can take an AsyncHandler object and return a polling Future object so applications do not have to wait for the response. With the HttpURLConnection based transport, CXF was forced to consume a background thread for each outstanding request.

+ +

CXF also has an HTTP client transport that is based on the Apache HTTP Components HttpAsyncClient library. The HttpAsyncClient library uses a non-blocking IO model. This allows many more requests to be outstanding without consume extra background threads. It also allows greater control over things like Keep-Alive handling which is very difficult or impossible with the HttpURLConnection based transport. However, the non-blocking model does not perform quite as well as the blocking model for pure synchronous request/response transactions.

+ +

By default, if the cxf-rt-transports-http-hc module is found on the classpath, CXF will use the HttpAsyncClient based implementation for any Async calls, but will continue to use the HttpURLConnection based transport for synchronous calls. This allows a good balance of performance for the common synchronous cases with scalability for the asynchronous cases. However, using a contextual property of "use.async.http.conduit" and set to true/false, you can control whether the async or blocking version is used.

+ + +

Configuration

+

The Asynchronous HTTP Transport has several options that can set using Bus properties or via the OSGi configuration services to control various aspects of the underlying Apache HTTP Components HttpAsyncClient objects.

+ +

Settings related to the underlying TCP socket:

+ +

+

org.apache.cxf.transport.http.async.TCP_NODELAY	The TCP_NODELAY for the socket. Defaults to true.
org.apache.cxf.transport.http.async.SO_KEEPALIVE
org.apache.cxf.transport.http.async.SO_LINGER
org.apache.cxf.transport.http.async.SO_TIMEOUT

+

+ + +

Settings related to Keep-Alive connection management:

+ +

+

org.apache.cxf.transport.http.async.MAX_CONNECTIONS
org.apache.cxf.transport.http.async.MAX_PER_HOST_CONNECTIONS

+

+ + +

Settings related to Apache HttpAsyncClient threads and selectors:

+

org.apache.cxf.transport.http.async.ioThreadCount
org.apache.cxf.transport.http.async.interestOpQueued
org.apache.cxf.transport.http.async.selectInterval

+

+ + +

Setting to control which conduit is used

+

org.apache.cxf.transport.http.async.usePolicy

ALWAYS, ASYNC_ONLY, NEVER.

+

+ +

+

+ +

+

+ +

+ + + + + + + Modified: websites/production/cxf/content/docs/http-transport.html ============================================================================== --- websites/production/cxf/content/docs/http-transport.html (original) +++ websites/production/cxf/content/docs/http-transport.html Wed Sep 26 19:47:26 2012 @@ -123,7 +123,7 @@ Apache CXF -- HTTP Transport

CXF includes two HTTP options for building services. There is a Servlet transport for those who are deploying into a Servlet container. There is also a standalone HTTP server based on Jetty. The follow sections explain these in more detail as well as how to configure the client side HTTP transport.

-

+

Modified: websites/production/cxf/content/docs/idea-for-new-index.html ============================================================================== --- websites/production/cxf/content/docs/idea-for-new-index.html (original) +++ websites/production/cxf/content/docs/idea-for-new-index.html Wed Sep 26 19:47:26 2012 @@ -182,7 +182,7 @@ Apache CXF -- Idea for new Index

Transports
+
JMS Transport
Local Transport
Configuration
Debugging and Logging - includes logging information
Tools

RESTful Services

Modified: websites/production/cxf/content/docs/index.html ============================================================================== --- websites/production/cxf/content/docs/index.html (original) +++ websites/production/cxf/content/docs/index.html Wed Sep 26 19:47:26 2012 @@ -147,7 +147,7 @@ Apache CXF -- Index -

Overview
- Why CXF?
- How do I integrate my application with CXF — A meta guide to integrating your application with CXF - including Bindings, Transports, Interceptors, etc
- How do I develop a service? — A meta guide to your options with CXF
- How do I develop a client? — A meta guide to your options with CXF
How-Tos

Frontends

+

Overview
- Why CXF?
- How do I integrate my application with CXF — A meta guide to integrating your application with CXF - including Bindings, Transports, Interceptors, etc
- How do I develop a service? — A meta guide to your options with CXF
- How do I develop a client? — A meta guide to your options with CXF
How-Tos

Frontends

SOAP over UDP

+ +

The CXF SOAP binding supports the use of the SOAP over UDP specification URL's for transporting SOAP messages over UDP. Just using "soap.udp" as the scheme part of the UDP URL (instead of just "udp") will enable the SOAP over UDP support.

+ +

The main difference between using the pure UDP CXF transport and the SOAP over UDP support is that SOAP over UDP requires the use of WS-Addressing headers whereas the pure CXF UDP transport does not. The WS-Addressing header can add significant size to the SOAP messages. With UDP limiting the size of the packets to under 64K, that can be significant.

+

+ +

+

+ +

+ + + + + + + Added: websites/production/cxf/content/docs/udp-transport.html ============================================================================== --- websites/production/cxf/content/docs/udp-transport.html (added) +++ websites/production/cxf/content/docs/udp-transport.html Wed Sep 26 19:47:26 2012 @@ -0,0 +1,212 @@ + + + + + + + + + + + + +Apache CXF -- UDP Transport + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+

+ +

+ + + + + +

+ +

+

UDP Transport

+ +

CXF provides a transport plugin to support transporting small (under about 60K) message payloads over UDP. It supports both unicast and multicast packet transfers.

+ + +

Creating a server on a UDP port

+

To use the UDP transport, you just need to include the cxf-rt-transports-udp module on the classpath and use a "udp://host:port" style URL for the address.

+ +

+

+        JaxWsServerFactoryBean factory = new JaxWsServerFactoryBean();
+        factory.setBus(getStaticBus());
+        factory.setAddress("udp://localhost:8888");
+        factory.setServiceBean(new GreeterImpl());
+        server = factory.create();
+

+

+ +

That will start the server on localhost UDP port 8888. You can also omit the hostname (udp://:8888) to bind to all the addresses or use one of the multicast addresses (example: udp://239.255.255.250:3702) to respond to the appropriate broadcasts.

+ +

Client configuration

+

Similar to the server side, you just need to use the appropriate UDP url in order for the client to use UDP.

+ +

If the hostname is specified in the URL, the Datagram will be sent directly to the host:port. If the hostname is not specified, the Datagram will be sent as a broadcast to the specific port. If the hostname is a multicast address, the Datagram will be sent Multicast to the given port.

+ +

Accepting multiple responses

+ +

UDP is different than the other CXF transports in that it allows multiple responses to be received for a single request. For example, if you send out a request via a multicast or broadcast, several servers could respond to that request. The basic JAX-WS generated interfaces only allow a single response to be returned to the application. However, if you use the JAX-WS Asynchronous methods, you can have CXF call the AsyncHandler for each response. To enable this, set the request property "udp.multi.response.timeout" to a timeout value greater than 0. CXF will wait that long for responses to come in before returning back to the application.

+ +

+

+//wait 3 seconds for responses
+((BindingProvider)proxy).getRequestContext().put("udp.multi.response.timeout", 3000);
+proxy.greetMeAsync("World", new AsyncHandler<String>() {
+    public void handleResponse(Response<Object> res) {
+            System.out.println(res.get());
+    }
+});
+

+

+ +

+

+ +

+ + + + + + +

New Features

Asynchronous Client HTTP Transport

Configuration

Other Sources of Documentation and Information

SOAP over UDP

UDP Transport

Creating a server on a UDP port

Client configuration

Accepting multiple responses