JAX-WS Client Asynchronous API for a Synchronous Service

11.1JAX-WS Client Asynchronous API for a Synchronous Service

For SCA service interfaces defined using interface.java, the Java interface MUST NOT contain the additional client-side asynchronous polling and callback methods defined by JAX-WS. [JCA100006] For SCA reference interfaces defined using interface.java, the SCA runtime MUST support a Java interface which contains the additional client-side asynchronous polling and callback methods defined by JAX-WS. [JCA100007] If the additional client-side asynchronous polling and callback methods defined by JAX-WS are present in the interface which declares the type of a reference in the implementation, SCA Runtimes MUST NOT include these methods in the SCA reference interface in the component type of the implementation. [JCA100008]

For each method M in the interface, if another method P in the interface has

1. 
   a method name that is M's method name with the characters "Async" appended, and
   
2. 
   the same parameter signature as M, and
   
3. 
   a return type of Response where R is the return type of M
   

For each method M in the interface, if another method C in the interface has

1. 
   a method name that is M's method name with the characters "Async" appended, and
   
2. 
   a parameter signature that is M's parameter signature with an additional final parameter of type AsyncHandler where R is the return type of M, and
   
3. 
   a return type of Future
   

As an example, an interface can be defined in WSDL as follows:

// asynchronous mapping

@WebService

public interface StockQuote {

float getPrice(String ticker);

Response getPriceAsync(String ticker);

Future getPriceAsync(String ticker, AsyncHandler);

}

For SCA interface definition purposes, this is treated as equivalent to the following:

@WebService

public interface StockQuote {

float getPrice(String ticker);

}

SCA runtimes MUST support the use of the JAX-WS client asynchronous model. [JCA100009] In the above example, if the client implementation uses the asynchronous form of the interface, the two additional getPriceAsync() methods can be used for polling and callbacks as defined by the JAX-WS specification.