JTR 5.0 API Documentation

jtr.runners
Interface IRunnerWs

All Superinterfaces:
IRunner, IRunnerClean, IRunnerParameterized, IRunnerPooled, java.lang.Runnable
All Known Implementing Classes:
AbstractWsRunner

public interface IRunnerWs
extends IRunner

This interface defines those methods required to inject into an IRunner concrete implementation the configuration required to access and invoke a webservice.

Since:
3.0
Version:
5.0
Author:
Francesco Russo (frusso@dev.java.net)

Method Summary
 IRunnerClean clean()
          This method is invoked everytime an IRunner passes from its RUNNING state to the REQUIRES_NEW_PARAMETERS state.
The concrete IRunner implementation is responsible for its own clean-up.
 Binding getBinding()
          This method returns the set of configured webservice bindings.
 WebServiceConfig getWsConfig()
          Retrieve the webservice configuration associated with the runner according to what specified by the jtr.xml configuration file.
 java.lang.Object invoke(Binding binding, java.lang.Object input)
          Performs a synchronous invocation.
 IWsResponse invokeAsync(Binding binding, java.lang.Object input)
          Performs an asynchronous invocation.
 java.util.concurrent.Future<?> invokeAsync(Binding binding, java.lang.Object input, IWsResponseListener rl)
          Performs an asynchronous invocation.
 void invokeOneWay(Binding binding, java.lang.Object input)
          Performs a one-way webservice invocation.
 void setBinding(Binding binding)
          This method returns the set of configured webservice bindings.
 void setWsConfig(WebServiceConfig wsConfig)
          Set the webservice configuration associated with the runner according to what specified by the jtr.xml configuration file.
 
Methods inherited from interface jtr.runners.IRunner
getFailures, getSuccesses, receiveFailureNotification, test
 
Methods inherited from interface jtr.runners.IRunnerPooled
afterTest, beforeTest, cleanupResources, getPool, run
 
Methods inherited from interface jtr.runners.IRunnerParameterized
setPool
 
Methods inherited from interface jtr.runners.IRunnerClean
getCurrentRun, getDefaultName, getEnterprise, getEpoch, getFqn, getInstanceCount, getInstanceID, getName, getOutcomeFactory, getParameters, getParamsAssigner, getRuns, getSleepTime, getStatFunction, getTestOutcomeTable, setCurrentRun, setEnterprise, setEpoch, setFqn, setInstanceCount, setInstanceID, setName, setOutcomeFactory, setParameters, setParamsAssigner, setRuns, setSleepTime, setStatFunction, setTestCompletionListener, setTestOutcomeTable
 

Method Detail

getWsConfig

WebServiceConfig getWsConfig()
Retrieve the webservice configuration associated with the runner according to what specified by the jtr.xml configuration file.

Returns:
WebServiceConfig

setWsConfig

void setWsConfig(WebServiceConfig wsConfig)
Set the webservice configuration associated with the runner according to what specified by the jtr.xml configuration file.

Parameters:
wsConfig -

setBinding

void setBinding(Binding binding)
This method returns the set of configured webservice bindings.

Parameters:
binding -

getBinding

Binding getBinding()
This method returns the set of configured webservice bindings.

Returns:
Binding

invoke

java.lang.Object invoke(Binding binding,
                        java.lang.Object input)
                        throws WsProviderException
Performs a synchronous invocation.

Parameters:
binding - The actual binding describing the web-services to invoke
input - The message
Returns:
The response
Throws:
WsProviderException

invokeOneWay

void invokeOneWay(Binding binding,
                  java.lang.Object input)
                  throws WsProviderException
Performs a one-way webservice invocation.

Parameters:
binding - The actual binding describing the web-services to invoke
input - The message
Throws:
WsProviderException

invokeAsync

java.util.concurrent.Future<?> invokeAsync(Binding binding,
                                           java.lang.Object input,
                                           IWsResponseListener rl)
                                           throws WsProviderException
Performs an asynchronous invocation.

Parameters:
binding - The actual binding describing the web-service to invoke
input - The message
rl - The response listener to be notified when a response becomes available
Returns:
A reference to the Future instance representin the pending task
Throws:
WsProviderException

invokeAsync

IWsResponse invokeAsync(Binding binding,
                        java.lang.Object input)
                        throws WsProviderException
Performs an asynchronous invocation.

Parameters:
binding - The actual binding describing the web-service to invoke
input - The message
Returns:
A reference to the response one should poll on
Throws:
WsProviderException

clean

IRunnerClean clean()
This method is invoked everytime an IRunner passes from its RUNNING state to the REQUIRES_NEW_PARAMETERS state.
The concrete IRunner implementation is responsible for its own clean-up.

Returns:
IRunnerClean

The JTR Project is licensed under GPL version 2