|
JTR 4.0 API Documentation | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjtr.ws.jaxws.JaxWsHelper
public class JaxWsHelper
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.
Field Summary | |
---|---|
protected org.apache.log4j.Logger |
logger
|
Constructor Summary | |
---|---|
JaxWsHelper()
Creates a new instance of JaxWsHelper |
Method Summary | |
---|---|
void |
asynchronousInputOnlyInvoke(Binding binding)
Deprecated. |
void |
generateRuntimeConfig(WebServiceConfig wsCfg)
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. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final org.apache.log4j.Logger logger
Constructor Detail |
---|
public JaxWsHelper()
Method Detail |
---|
public void generateRuntimeConfig(WebServiceConfig wsCfg) throws WsProviderException
IWsHelper
jtr.xml
configuration file, into an object-oriented representation
tailored for the underlying webservice invocation API in use.
generateRuntimeConfig
in interface IWsHelper
wsCfg
- The static webservice configuration
WsProviderException
public java.lang.Object invoke(IRunnerWs runner, Binding binding, java.lang.Object input) throws WsProviderException
IWsHelper
input
parameter is the invocation argument, while the
returned Object
instance is the result of the invocation.
invoke
in interface IWsHelper
runner
- The runner on whose behalf the service is invokedbinding
- The JTR description of the webservice that must be invokedinput
- The input message
WsProviderException
public void invokeOneWay(IRunnerWs runner, Binding binding, java.lang.Object input) throws WsProviderException
IWsHelper
input
parameter is the invocation argument.
invokeOneWay
in interface IWsHelper
runner
- The runner on whose behalf the service is invokedbinding
- The JTR description of the webservice that must be invokedinput
- The input message
WsProviderException
public java.util.concurrent.Future<?> invokeAsync(IRunnerWs runner, Binding binding, java.lang.Object input, IWsResponseListener rl) throws WsProviderException
IWsHelper
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.
invokeAsync
in interface IWsHelper
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
public IWsResponse invokeAsync(IRunnerWs runner, Binding binding, java.lang.Object input) throws WsProviderException
IWsHelper
binding
parameter. The returned IWsResponse
instance is
required to check for response mesage availability and to inspect the response itself.
invokeAsync
in interface IWsHelper
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 public boolean synchronousInvoke(Binding binding) throws WsProviderException
IWsHelper
synchronousInvoke
in interface IWsHelper
binding
- The webservice binding to be used
WsProviderException
@Deprecated public void asynchronousInputOnlyInvoke(Binding binding) throws WsProviderException
IWsHelper
asynchronousInputOnlyInvoke
in interface IWsHelper
binding
- The webservice binding to be used
WsProviderException
@Deprecated public void setMessageObjectPart(Binding binding, java.lang.String partName, java.lang.Object part, WsMsgType msgType) throws WsProviderException
IWsHelper
Object
content of a specific message part.
setMessageObjectPart
in interface IWsHelper
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 public void setMessageIntPart(Binding binding, java.lang.String partName, int part, WsMsgType msgType)
IWsHelper
int
content of a specific message part.
setMessageIntPart
in interface IWsHelper
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 public void setMessageBooleanPart(Binding binding, java.lang.String partName, boolean part, WsMsgType msgType)
IWsHelper
boolean
content of a specific message part.
setMessageBooleanPart
in interface IWsHelper
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 public void setMessageBytePart(Binding binding, java.lang.String partName, byte part, WsMsgType msgType)
IWsHelper
byte
content of a specific message part.
setMessageBytePart
in interface IWsHelper
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 public void setMessageCharPart(Binding binding, java.lang.String partName, char part, WsMsgType msgType)
IWsHelper
char
content of a specific message part.
setMessageCharPart
in interface IWsHelper
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 public void setMessageDoublePart(Binding binding, java.lang.String partName, double part, WsMsgType msgType)
IWsHelper
double
content of a specific message part.
setMessageDoublePart
in interface IWsHelper
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 public void setMessageFloatPart(Binding binding, java.lang.String partName, float part, WsMsgType msgType)
IWsHelper
float
content of a specific message part.
setMessageFloatPart
in interface IWsHelper
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 public void setMessageLongPart(Binding binding, java.lang.String partName, long part, WsMsgType msgType)
IWsHelper
long
content of a specific message part.
setMessageLongPart
in interface IWsHelper
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 public java.lang.Object getMessageObjectPart(Binding binding, java.lang.String partName, WsMsgType msgType) throws WsProviderException
IWsHelper
Object
content of a specific message part.
getMessageObjectPart
in interface IWsHelper
binding
- The webservice binding to be usedpartName
- The name of the message partmsgType
- The message type (input, output, fault)
WsProviderException
@Deprecated public int getMessageIntPart(Binding binding, java.lang.String partName, WsMsgType msgType) throws WsProviderException
IWsHelper
int
content of a specific message part.
getMessageIntPart
in interface IWsHelper
binding
- The webservice binding to be usedpartName
- The name of the message partmsgType
- The message type (input, output, fault)
WsProviderException
@Deprecated public boolean getMessageBooleanPart(Binding binding, java.lang.String partName, WsMsgType msgType) throws WsProviderException
IWsHelper
boolean
content of a specific message part.
getMessageBooleanPart
in interface IWsHelper
binding
- The webservice binding to be usedpartName
- The name of the message partmsgType
- The message type (input, output, fault)
WsProviderException
@Deprecated public byte getMessageBytePart(Binding binding, java.lang.String partName, WsMsgType msgType) throws WsProviderException
IWsHelper
byte
content of a specific message part.
getMessageBytePart
in interface IWsHelper
binding
- The webservice binding to be usedpartName
- The name of the message partmsgType
- The message type (input, output, fault)
WsProviderException
@Deprecated public char getMessageCharPart(Binding binding, java.lang.String partName, WsMsgType msgType) throws WsProviderException
IWsHelper
char
content of a specific message part.
getMessageCharPart
in interface IWsHelper
binding
- The webservice binding to be usedpartName
- The name of the message partmsgType
- The message type (input, output, fault)
WsProviderException
@Deprecated public double getMessageDoublePart(Binding binding, java.lang.String partName, WsMsgType msgType) throws WsProviderException
IWsHelper
double
content of a specific message part.
getMessageDoublePart
in interface IWsHelper
binding
- The webservice binding to be usedpartName
- The name of the message partmsgType
- The message type (input, output, fault)
WsProviderException
@Deprecated public float getMessageFloatPart(Binding binding, java.lang.String partName, WsMsgType msgType) throws WsProviderException
IWsHelper
float
content of a specific message part.
getMessageFloatPart
in interface IWsHelper
binding
- The webservice binding to be usedpartName
- The name of the message partmsgType
- The message type (input, output, fault)
WsProviderException
@Deprecated public long getMessageLongPart(Binding binding, java.lang.String partName, WsMsgType msgType) throws WsProviderException
IWsHelper
long
content of a specific message part.
getMessageLongPart
in interface IWsHelper
binding
- The webservice binding to be usedpartName
- The name of the message partmsgType
- The message type (input, output, fault)
WsProviderException
@Deprecated public java.lang.String[] getMessageParts(Binding binding, WsMsgType msgType)
IWsHelper
String[]
of the part names of the given message.
getMessageParts
in interface IWsHelper
@Deprecated public java.lang.String getFaultMessageAsString(Binding binding)
IWsHelper
String
representation of the fault message associated
with the given webservice operation.
getFaultMessageAsString
in interface IWsHelper
binding
- The webservice binding to be used
@Deprecated public java.lang.Throwable getFaultCause(Binding binding)
IWsHelper
WsProviderException
instance.
getFaultCause
in interface IWsHelper
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 |