JTR 5.0 API Documentation

jtr.ws.jaxws
Class JaxWsHelper

java.lang.Object
  extended by jtr.ws.jaxws.JaxWsHelper
All Implemented Interfaces:
IWsHelper

public class JaxWsHelper
extends java.lang.Object
implements IWsHelper

Implementation of the IWsHelper contract, based on the JAX-WS 2.1 API and the JAXB 2.1 API. This implementation is stateless, thus it can be profitably used by the JTR runtime as a shared-helper class for all those concrete runners requiring web-services support.
Please, also note that this implementation imposes that only JAXB-based objects are used as input and output parameters.

Since:
4.0
Version:
5.0
Author:
Francesco Russo

Field Summary
protected  org.apache.log4j.Logger logger
           
 
Constructor Summary
JaxWsHelper()
          Creates a new instance of JaxWsHelper
 
Method Summary
 void generateRuntimeConfig(WebServiceConfig wsCfg)
           
 java.lang.Object invoke(IRunnerWs runner, Binding binding, java.lang.Object input)
          This method performs a request/response synchronous webservice invocation.
 IWsResponse invokeAsync(IRunnerWs runner, Binding binding, java.lang.Object input)
          This method performs an asynchronous invocation of the webservice described by the binding parameter.
 java.util.concurrent.Future<?> invokeAsync(IRunnerWs runner, Binding binding, java.lang.Object input, IWsResponseListener rl)
          This method performs an asynchronous invocation of the webservice described by the binding parameter.
 void invokeOneWay(IRunnerWs runner, Binding binding, java.lang.Object input)
          This method performs a request only webservice invocation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logger

protected final org.apache.log4j.Logger logger
Constructor Detail

JaxWsHelper

public JaxWsHelper()
Creates a new instance of JaxWsHelper

Method Detail

generateRuntimeConfig

public void generateRuntimeConfig(WebServiceConfig wsCfg)
                           throws WsProviderException
Throws:
WsProviderException

invoke

public java.lang.Object invoke(IRunnerWs runner,
                               Binding binding,
                               java.lang.Object input)
                        throws WsProviderException
Description copied from interface: IWsHelper
This method performs a request/response synchronous webservice invocation. The input parameter is the invocation argument, while the returned Object instance is the result of the invocation.

Specified by:
invoke in interface IWsHelper
Parameters:
runner - The runner on whose behalf the service is invoked
binding - The JTR description of the webservice that must be invoked
input - The input message
Returns:
The output of the invoked webservice
Throws:
WsProviderException

invokeOneWay

public void invokeOneWay(IRunnerWs runner,
                         Binding binding,
                         java.lang.Object input)
                  throws WsProviderException
Description copied from interface: IWsHelper
This method performs a request only webservice invocation. The input parameter is the invocation argument.

Specified by:
invokeOneWay in interface IWsHelper
Parameters:
runner - The runner on whose behalf the service is invoked
binding - The JTR description of the webservice that must be invoked
input - The input message
Throws:
WsProviderException

invokeAsync

public java.util.concurrent.Future<?> invokeAsync(IRunnerWs runner,
                                                  Binding binding,
                                                  java.lang.Object input,
                                                  IWsResponseListener rl)
                                           throws WsProviderException
Description copied from interface: IWsHelper
This method performs an asynchronous invocation of the webservice described by the binding parameter. The returned Future instance can be used to check whether the response message has been received or not. Once the response message has been received the provided IWsResponseListener will be notified and will be able to inspect the response.

Specified by:
invokeAsync in interface IWsHelper
Parameters:
runner - The runner on whose behalf the service is invoked
binding - The JTR description of the webservice that must be invoked
input - The input message
rl - The listener to be notified upon response reception
Returns:
The Future required to check for response availability
Throws:
WsProviderException

invokeAsync

public IWsResponse invokeAsync(IRunnerWs runner,
                               Binding binding,
                               java.lang.Object input)
                        throws WsProviderException
Description copied from interface: IWsHelper
This method performs an asynchronous invocation of the webservice described by the binding parameter. The returned IWsResponse instance is required to check for response mesage availability and to inspect the response itself.

Specified by:
invokeAsync in interface IWsHelper
Parameters:
runner - The runner on whose behalf the service is invoked
binding - The JTR description of the webservice that must be invoked
input - The input message
Returns:
The IWsResponse instance required to check for response mesage availability and to inspect the response itself
Throws:
WsProviderException

The JTR Project is licensed under GPL version 2