JTR 4.0 API Documentation

jtr.ws
Interface IWsHelper

All Known Implementing Classes:
JaxWsHelper, WsifHelper

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.

Since:
3.0
Version:
4.0
Author:
Francesco Russo (frusso@dev.java.net)
See Also:
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

invoke

java.lang.Object invoke(IRunnerWs runner,
                        Binding binding,
                        java.lang.Object input)
                        throws WsProviderException
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.

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

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

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

java.util.concurrent.Future<?> invokeAsync(IRunnerWs runner,
                                           Binding binding,
                                           java.lang.Object input,
                                           IWsResponseListener rl)
                                           throws WsProviderException
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.

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

IWsResponse invokeAsync(IRunnerWs runner,
                        Binding binding,
                        java.lang.Object input)
                        throws WsProviderException
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.

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

generateRuntimeConfig

@Deprecated
void generateRuntimeConfig(WebServiceConfig wsCfg)
                           throws WsProviderException
Deprecated. 

This method "translates" the provided webservice configuration derived from the jtr.xml configuration file, into an object-oriented representation tailored for the underlying webservice invocation API in use.

Parameters:
wsCfg - The static webservice configuration
Throws:
WsProviderException

synchronousInvoke

@Deprecated
boolean synchronousInvoke(Binding binding)
                          throws WsProviderException
Deprecated. 

This method performs a synchronous invocation of the webservice, following a request/response pattern.

Parameters:
binding - The webservice binding to be used
Returns:
boolean The outcome of the invocation
Throws:
WsProviderException

asynchronousInputOnlyInvoke

@Deprecated
void asynchronousInputOnlyInvoke(Binding binding)
                                 throws WsProviderException
Deprecated. 

This method performs an asynchronous invocation of the webservice, following a one-way messaging pattern.

Parameters:
binding - The webservice binding to be used
Throws:
WsProviderException

setMessageObjectPart

@Deprecated
void setMessageObjectPart(Binding binding,
                                     java.lang.String partName,
                                     java.lang.Object part,
                                     WsMsgType msgType)
                          throws WsProviderException
Deprecated. 

This method sets the Object content of a specific message part.

Parameters:
binding - The webservice binding to be used
partName - The name of the message part
part - The actual value of the part
msgType - The message type (input, output, fault)
Throws:
WsProviderException
See Also:
WsMsgType

setMessageIntPart

@Deprecated
void setMessageIntPart(Binding binding,
                                  java.lang.String partName,
                                  int part,
                                  WsMsgType msgType)
Deprecated. 

This method sets the int content of a specific message part.

Parameters:
binding - The webservice binding to be used
partName - The name of the message part
part - The actual value of the part
msgType - The message type (input, output, fault)
See Also:
WsMsgType

setMessageBooleanPart

@Deprecated
void setMessageBooleanPart(Binding binding,
                                      java.lang.String partName,
                                      boolean part,
                                      WsMsgType msgType)
Deprecated. 

This method sets the boolean content of a specific message part.

Parameters:
binding - The webservice binding to be used
partName - The name of the message part
part - The actual value of the part
msgType - The message type (input, output, fault)
See Also:
WsMsgType

setMessageBytePart

@Deprecated
void setMessageBytePart(Binding binding,
                                   java.lang.String partName,
                                   byte part,
                                   WsMsgType msgType)
Deprecated. 

This method sets the byte content of a specific message part.

Parameters:
binding - The webservice binding to be used
partName - The name of the message part
part - The actual value of the part
msgType - The message type (input, output, fault)
See Also:
WsMsgType

setMessageCharPart

@Deprecated
void setMessageCharPart(Binding binding,
                                   java.lang.String partName,
                                   char part,
                                   WsMsgType msgType)
Deprecated. 

This method sets the char content of a specific message part.

Parameters:
binding - The webservice binding to be used
partName - The name of the message part
part - The actual value of the part
msgType - The message type (input, output, fault)
See Also:
WsMsgType

setMessageDoublePart

@Deprecated
void setMessageDoublePart(Binding binding,
                                     java.lang.String partName,
                                     double part,
                                     WsMsgType msgType)
Deprecated. 

This method sets the double content of a specific message part.

Parameters:
binding - The webservice binding to be used
partName - The name of the message part
part - The actual value of the part
msgType - The message type (input, output, fault)
See Also:
WsMsgType

setMessageFloatPart

@Deprecated
void setMessageFloatPart(Binding binding,
                                    java.lang.String partName,
                                    float part,
                                    WsMsgType msgType)
Deprecated. 

This method sets the float content of a specific message part.

Parameters:
binding - The webservice binding to be used
partName - The name of the message part
part - The actual value of the part
msgType - The message type (input, output, fault)
See Also:
WsMsgType

setMessageLongPart

@Deprecated
void setMessageLongPart(Binding binding,
                                   java.lang.String partName,
                                   long part,
                                   WsMsgType msgType)
Deprecated. 

This method sets the long content of a specific message part.

Parameters:
binding - The webservice binding to be used
partName - The name of the message part
part - The actual value of the part
msgType - The message type (input, output, fault)
See Also:
WsMsgType

getMessageObjectPart

@Deprecated
java.lang.Object getMessageObjectPart(Binding binding,
                                                 java.lang.String partName,
                                                 WsMsgType msgType)
                                      throws WsProviderException
Deprecated. 

This method gets the Object content of a specific message part.

Parameters:
binding - The webservice binding to be used
partName - The name of the message part
msgType - The message type (input, output, fault)
Returns:
Object The content
Throws:
WsProviderException

getMessageIntPart

@Deprecated
int getMessageIntPart(Binding binding,
                                 java.lang.String partName,
                                 WsMsgType msgType)
                      throws WsProviderException
Deprecated. 

This method gets the int content of a specific message part.

Parameters:
binding - The webservice binding to be used
partName - The name of the message part
msgType - The message type (input, output, fault)
Returns:
int The content
Throws:
WsProviderException

getMessageBooleanPart

@Deprecated
boolean getMessageBooleanPart(Binding binding,
                                         java.lang.String partName,
                                         WsMsgType msgType)
                              throws WsProviderException
Deprecated. 

This method gets the boolean content of a specific message part.

Parameters:
binding - The webservice binding to be used
partName - The name of the message part
msgType - The message type (input, output, fault)
Returns:
boolean The content
Throws:
WsProviderException

getMessageBytePart

@Deprecated
byte getMessageBytePart(Binding binding,
                                   java.lang.String partName,
                                   WsMsgType msgType)
                        throws WsProviderException
Deprecated. 

This method gets the byte content of a specific message part.

Parameters:
binding - The webservice binding to be used
partName - The name of the message part
msgType - The message type (input, output, fault)
Returns:
byte The content
Throws:
WsProviderException

getMessageCharPart

@Deprecated
char getMessageCharPart(Binding binding,
                                   java.lang.String partName,
                                   WsMsgType msgType)
                        throws WsProviderException
Deprecated. 

This method gets the char content of a specific message part.

Parameters:
binding - The webservice binding to be used
partName - The name of the message part
msgType - The message type (input, output, fault)
Returns:
char The content
Throws:
WsProviderException

getMessageDoublePart

@Deprecated
double getMessageDoublePart(Binding binding,
                                       java.lang.String partName,
                                       WsMsgType msgType)
                            throws WsProviderException
Deprecated. 

This method gets the double content of a specific message part.

Parameters:
binding - The webservice binding to be used
partName - The name of the message part
msgType - The message type (input, output, fault)
Returns:
double The content
Throws:
WsProviderException

getMessageFloatPart

@Deprecated
float getMessageFloatPart(Binding binding,
                                     java.lang.String partName,
                                     WsMsgType msgType)
                          throws WsProviderException
Deprecated. 

This method gets the float content of a specific message part.

Parameters:
binding - The webservice binding to be used
partName - The name of the message part
msgType - The message type (input, output, fault)
Returns:
float The content
Throws:
WsProviderException

getMessageLongPart

@Deprecated
long getMessageLongPart(Binding binding,
                                   java.lang.String partName,
                                   WsMsgType msgType)
                        throws WsProviderException
Deprecated. 

This method gets the long content of a specific message part.

Parameters:
binding - The webservice binding to be used
partName - The name of the message part
msgType - The message type (input, output, fault)
Returns:
long The content
Throws:
WsProviderException

getMessageParts

@Deprecated
java.lang.String[] getMessageParts(Binding binding,
                                              WsMsgType msgType)
Deprecated. 

Returns the String[] of the part names of the given message.

Parameters:
binding -
msgType -
Returns:
String[] The part names

getFaultMessageAsString

@Deprecated
java.lang.String getFaultMessageAsString(Binding binding)
Deprecated. 

This method returns the String representation of the fault message associated with the given webservice operation.

Parameters:
binding - The webservice binding to be used
Returns:
String The fault message in a human-readable format

getFaultCause

@Deprecated
java.lang.Throwable getFaultCause(Binding binding)
Deprecated. 

This method returns the cause of the webservice failure as a WsProviderException instance.

Parameters:
binding - The webservice binding to be used
Returns:
Throwable The cause of the fault

The JTR Project is licensed under GPL version 2