|
|||||||||||||||||||
| Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
| IRunnerWs.java | - | - | - | - |
|
||||||||||||||
| 1 | /** | |
| 2 | * JTRunner is free software; you can redistribute it and/or modify it under the | |
| 3 | * terms of the GNU General Public License as published by the Free Software | |
| 4 | * Foundation; either version 2, or (at your option) any later version. | |
| 5 | */ | |
| 6 | ||
| 7 | package jtr.runners; | |
| 8 | ||
| 9 | import java.util.concurrent.Future; | |
| 10 | import jtr.config.ws.Binding; | |
| 11 | import jtr.config.ws.WebServiceConfig; | |
| 12 | import jtr.ws.IWsResponse; | |
| 13 | import jtr.ws.IWsResponseListener; | |
| 14 | import jtr.ws.WsProviderException; | |
| 15 | ||
| 16 | /** | |
| 17 | * This interface defines those methods required to inject into | |
| 18 | * an <code>IRunner</code> concrete implementation the configuration | |
| 19 | * required to access and invoke a webservice. | |
| 20 | * | |
| 21 | * @author Francesco Russo (frusso@dev.java.net) | |
| 22 | * @version 4.0 | |
| 23 | * @since 3.0 | |
| 24 | */ | |
| 25 | public interface IRunnerWs extends IRunner { | |
| 26 | /** | |
| 27 | * Retrieve the webservice configuration associated with the | |
| 28 | * runner according to what specified by the <code>jtr.xml</code> | |
| 29 | * configuration file. | |
| 30 | * | |
| 31 | * @return WebServiceConfig | |
| 32 | */ | |
| 33 | public WebServiceConfig getWsConfig(); | |
| 34 | ||
| 35 | /** | |
| 36 | * Set the webservice configuration associated with the | |
| 37 | * runner according to what specified by the <code>jtr.xml</code> | |
| 38 | * configuration file. | |
| 39 | * | |
| 40 | * @param wsConfig | |
| 41 | */ | |
| 42 | public void setWsConfig(WebServiceConfig wsConfig); | |
| 43 | ||
| 44 | /** | |
| 45 | * This method returns the set of configured webservice bindings. | |
| 46 | * @param binding | |
| 47 | */ | |
| 48 | public void setBinding(Binding binding); | |
| 49 | ||
| 50 | /** | |
| 51 | * This method returns the set of configured webservice bindings. | |
| 52 | * @return Binding | |
| 53 | */ | |
| 54 | public Binding getBinding(); | |
| 55 | ||
| 56 | /** | |
| 57 | * Performs a synchronous invocation. | |
| 58 | * | |
| 59 | * @param binding The actual binding describing the web-services to invoke | |
| 60 | * @param input The message | |
| 61 | * @return The response | |
| 62 | * @throws jtr.ws.WsProviderException | |
| 63 | */ | |
| 64 | public Object invoke(Binding binding, Object input) throws WsProviderException; | |
| 65 | ||
| 66 | /** | |
| 67 | * Performs a one-way webservice invocation. | |
| 68 | * | |
| 69 | * @param binding The actual binding describing the web-services to invoke | |
| 70 | * @param input The message | |
| 71 | * @throws jtr.ws.WsProviderException | |
| 72 | */ | |
| 73 | public void invokeOneWay(Binding binding, Object input) throws WsProviderException; | |
| 74 | ||
| 75 | /** | |
| 76 | * Performs an asynchronous invocation. | |
| 77 | * | |
| 78 | * @param binding The actual binding describing the web-service to invoke | |
| 79 | * @param input The message | |
| 80 | * @param rl The response listener to be notified when a response becomes available | |
| 81 | * @return A reference to the <code>Future</code> instance representin the pending task | |
| 82 | * @throws jtr.ws.WsProviderException | |
| 83 | */ | |
| 84 | public Future<?> invokeAsync(Binding binding, Object input, IWsResponseListener rl) throws WsProviderException; | |
| 85 | ||
| 86 | /** | |
| 87 | * Performs an asynchronous invocation. | |
| 88 | * | |
| 89 | * @param binding The actual binding describing the web-service to invoke | |
| 90 | * @param input The message | |
| 91 | * @return A reference to the response one should poll on | |
| 92 | * @throws jtr.ws.WsProviderException | |
| 93 | */ | |
| 94 | public IWsResponse invokeAsync(Binding binding, Object input) throws WsProviderException; | |
| 95 | } |
|
||||||||||