|
JTR 4.0 API Documentation | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IWsHelper
This interface defines the methods every webservice helper class should
expose in the JTR framework.
A webservice helper class is meant for shielding the AbstractWsRunner
and its subclasses from the API actually used to access and invoke webservices.
Thus a webservice-enabled runner should not contain code related to a particular
webservice invocation API, but should only (as far as possible at least!) rely on the
configured IWsHelper
concrete implementation.
Note: this interface is not meant for direct use by user-defined runners. These
AbstractWsRunner
subclasses can leverage on their super-class' methods to
perform web-services invocation.
AbstractWsRunner
,
IWsHelperFactory
,
RegisteredFactories
Method Summary | |
---|---|
void |
asynchronousInputOnlyInvoke(Binding binding)
Deprecated. |
void |
generateRuntimeConfig(WebServiceConfig wsCfg)
Deprecated. |
java.lang.Throwable |
getFaultCause(Binding binding)
Deprecated. |
java.lang.String |
getFaultMessageAsString(Binding binding)
Deprecated. |
boolean |
getMessageBooleanPart(Binding binding,
java.lang.String partName,
WsMsgType msgType)
Deprecated. |
byte |
getMessageBytePart(Binding binding,
java.lang.String partName,
WsMsgType msgType)
Deprecated. |
char |
getMessageCharPart(Binding binding,
java.lang.String partName,
WsMsgType msgType)
Deprecated. |
double |
getMessageDoublePart(Binding binding,
java.lang.String partName,
WsMsgType msgType)
Deprecated. |
float |
getMessageFloatPart(Binding binding,
java.lang.String partName,
WsMsgType msgType)
Deprecated. |
int |
getMessageIntPart(Binding binding,
java.lang.String partName,
WsMsgType msgType)
Deprecated. |
long |
getMessageLongPart(Binding binding,
java.lang.String partName,
WsMsgType msgType)
Deprecated. |
java.lang.Object |
getMessageObjectPart(Binding binding,
java.lang.String partName,
WsMsgType msgType)
Deprecated. |
java.lang.String[] |
getMessageParts(Binding binding,
WsMsgType msgType)
Deprecated. |
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. |
void |
setMessageBooleanPart(Binding binding,
java.lang.String partName,
boolean part,
WsMsgType msgType)
Deprecated. |
void |
setMessageBytePart(Binding binding,
java.lang.String partName,
byte part,
WsMsgType msgType)
Deprecated. |
void |
setMessageCharPart(Binding binding,
java.lang.String partName,
char part,
WsMsgType msgType)
Deprecated. |
void |
setMessageDoublePart(Binding binding,
java.lang.String partName,
double part,
WsMsgType msgType)
Deprecated. |
void |
setMessageFloatPart(Binding binding,
java.lang.String partName,
float part,
WsMsgType msgType)
Deprecated. |
void |
setMessageIntPart(Binding binding,
java.lang.String partName,
int part,
WsMsgType msgType)
Deprecated. |
void |
setMessageLongPart(Binding binding,
java.lang.String partName,
long part,
WsMsgType msgType)
Deprecated. |
void |
setMessageObjectPart(Binding binding,
java.lang.String partName,
java.lang.Object part,
WsMsgType msgType)
Deprecated. |
boolean |
synchronousInvoke(Binding binding)
Deprecated. |
Method Detail |
---|
java.lang.Object invoke(IRunnerWs runner, Binding binding, java.lang.Object input) throws WsProviderException
input
parameter is the invocation argument, while the
returned Object
instance is the result of the invocation.
runner
- The runner on whose behalf the service is invokedbinding
- The JTR description of the webservice that must be invokedinput
- The input message
WsProviderException
void invokeOneWay(IRunnerWs runner, Binding binding, java.lang.Object input) throws WsProviderException
input
parameter is the invocation argument.
runner
- The runner on whose behalf the service is invokedbinding
- The JTR description of the webservice that must be invokedinput
- The input message
WsProviderException
java.util.concurrent.Future<?> invokeAsync(IRunnerWs runner, Binding binding, java.lang.Object input, IWsResponseListener rl) throws WsProviderException
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.
runner
- The runner on whose behalf the service is invokedbinding
- The JTR description of the webservice that must be invokedinput
- The input messagerl
- The listener to be notified upon response reception
Future
required to check for response availability
WsProviderException
IWsResponse invokeAsync(IRunnerWs runner, Binding binding, java.lang.Object input) throws WsProviderException
binding
parameter. The returned IWsResponse
instance is
required to check for response mesage availability and to inspect the response itself.
runner
- The runner on whose behalf the service is invokedbinding
- The JTR description of the webservice that must be invokedinput
- The input message
IWsResponse
instance required to check for response mesage
availability and to inspect the response itself
WsProviderException
@Deprecated void generateRuntimeConfig(WebServiceConfig wsCfg) throws WsProviderException
jtr.xml
configuration file, into an object-oriented representation
tailored for the underlying webservice invocation API in use.
wsCfg
- The static webservice configuration
WsProviderException
@Deprecated boolean synchronousInvoke(Binding binding) throws WsProviderException
binding
- The webservice binding to be used
WsProviderException
@Deprecated void asynchronousInputOnlyInvoke(Binding binding) throws WsProviderException
binding
- The webservice binding to be used
WsProviderException
@Deprecated void setMessageObjectPart(Binding binding, java.lang.String partName, java.lang.Object part, WsMsgType msgType) throws WsProviderException
Object
content of a specific message part.
binding
- The webservice binding to be usedpartName
- The name of the message partpart
- The actual value of the partmsgType
- The message type (input, output, fault)
WsProviderException
WsMsgType
@Deprecated void setMessageIntPart(Binding binding, java.lang.String partName, int part, WsMsgType msgType)
int
content of a specific message part.
binding
- The webservice binding to be usedpartName
- The name of the message partpart
- The actual value of the partmsgType
- The message type (input, output, fault)WsMsgType
@Deprecated void setMessageBooleanPart(Binding binding, java.lang.String partName, boolean part, WsMsgType msgType)
boolean
content of a specific message part.
binding
- The webservice binding to be usedpartName
- The name of the message partpart
- The actual value of the partmsgType
- The message type (input, output, fault)WsMsgType
@Deprecated void setMessageBytePart(Binding binding, java.lang.String partName, byte part, WsMsgType msgType)
byte
content of a specific message part.
binding
- The webservice binding to be usedpartName
- The name of the message partpart
- The actual value of the partmsgType
- The message type (input, output, fault)WsMsgType
@Deprecated void setMessageCharPart(Binding binding, java.lang.String partName, char part, WsMsgType msgType)
char
content of a specific message part.
binding
- The webservice binding to be usedpartName
- The name of the message partpart
- The actual value of the partmsgType
- The message type (input, output, fault)WsMsgType
@Deprecated void setMessageDoublePart(Binding binding, java.lang.String partName, double part, WsMsgType msgType)
double
content of a specific message part.
binding
- The webservice binding to be usedpartName
- The name of the message partpart
- The actual value of the partmsgType
- The message type (input, output, fault)WsMsgType
@Deprecated void setMessageFloatPart(Binding binding, java.lang.String partName, float part, WsMsgType msgType)
float
content of a specific message part.
binding
- The webservice binding to be usedpartName
- The name of the message partpart
- The actual value of the partmsgType
- The message type (input, output, fault)WsMsgType
@Deprecated void setMessageLongPart(Binding binding, java.lang.String partName, long part, WsMsgType msgType)
long
content of a specific message part.
binding
- The webservice binding to be usedpartName
- The name of the message partpart
- The actual value of the partmsgType
- The message type (input, output, fault)WsMsgType
@Deprecated java.lang.Object getMessageObjectPart(Binding binding, java.lang.String partName, WsMsgType msgType) throws WsProviderException
Object
content of a specific message part.
binding
- The webservice binding to be usedpartName
- The name of the message partmsgType
- The message type (input, output, fault)
WsProviderException
@Deprecated int getMessageIntPart(Binding binding, java.lang.String partName, WsMsgType msgType) throws WsProviderException
int
content of a specific message part.
binding
- The webservice binding to be usedpartName
- The name of the message partmsgType
- The message type (input, output, fault)
WsProviderException
@Deprecated boolean getMessageBooleanPart(Binding binding, java.lang.String partName, WsMsgType msgType) throws WsProviderException
boolean
content of a specific message part.
binding
- The webservice binding to be usedpartName
- The name of the message partmsgType
- The message type (input, output, fault)
WsProviderException
@Deprecated byte getMessageBytePart(Binding binding, java.lang.String partName, WsMsgType msgType) throws WsProviderException
byte
content of a specific message part.
binding
- The webservice binding to be usedpartName
- The name of the message partmsgType
- The message type (input, output, fault)
WsProviderException
@Deprecated char getMessageCharPart(Binding binding, java.lang.String partName, WsMsgType msgType) throws WsProviderException
char
content of a specific message part.
binding
- The webservice binding to be usedpartName
- The name of the message partmsgType
- The message type (input, output, fault)
WsProviderException
@Deprecated double getMessageDoublePart(Binding binding, java.lang.String partName, WsMsgType msgType) throws WsProviderException
double
content of a specific message part.
binding
- The webservice binding to be usedpartName
- The name of the message partmsgType
- The message type (input, output, fault)
WsProviderException
@Deprecated float getMessageFloatPart(Binding binding, java.lang.String partName, WsMsgType msgType) throws WsProviderException
float
content of a specific message part.
binding
- The webservice binding to be usedpartName
- The name of the message partmsgType
- The message type (input, output, fault)
WsProviderException
@Deprecated long getMessageLongPart(Binding binding, java.lang.String partName, WsMsgType msgType) throws WsProviderException
long
content of a specific message part.
binding
- The webservice binding to be usedpartName
- The name of the message partmsgType
- The message type (input, output, fault)
WsProviderException
@Deprecated java.lang.String[] getMessageParts(Binding binding, WsMsgType msgType)
String[]
of the part names of the given message.
binding
- msgType
-
@Deprecated java.lang.String getFaultMessageAsString(Binding binding)
String
representation of the fault message associated
with the given webservice operation.
binding
- The webservice binding to be used
@Deprecated java.lang.Throwable getFaultCause(Binding binding)
WsProviderException
instance.
binding
- The webservice binding to be used
|
The JTR Project is licensed under GPL version 2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |