FileDocCategorySizeDatePackage
Dispatch.javaAPI DocJava SE 6 API4297Tue Jun 10 00:27:14 BST 2008javax.xml.ws

Dispatch

public interface Dispatch implements BindingProvider
The Dispatch interface provides support for the dynamic invocation of a service endpoint operations. The javax.xml.ws.Service interface acts as a factory for the creation of Dispatch instances.
since
JAX-WS 2.0

Fields Summary
Constructors Summary
Methods Summary
public Tinvoke(T msg)
Invoke a service operation synchronously. The client is responsible for ensuring that the msg object when marshalled is formed according to the requirements of the protocol binding in use.

param
msg An object that will form the message or payload of the message used to invoke the operation.
return
The response message or message payload to the operation invocation.
throws
WebServiceException If a fault occurs during communication with the service
throws
WebServiceException If there is any error in the configuration of the Dispatch instance

public javax.xml.ws.ResponseinvokeAsync(T msg)
Invoke a service operation asynchronously. The method returns without waiting for the response to the operation invocation, the results of the operation are obtained by polling the returned Response.

The client is responsible for ensuring that the msg object when marshalled is formed according to the requirements of the protocol binding in use.

param
msg An object that will form the message or payload of the message used to invoke the operation.
return
The response message or message payload to the operation invocation.
throws
WebServiceException If there is any error in the configuration of the Dispatch instance

public java.util.concurrent.FutureinvokeAsync(T msg, javax.xml.ws.AsyncHandler handler)
Invoke a service operation asynchronously. The method returns without waiting for the response to the operation invocation, the results of the operation are communicated to the client via the passed in handler.

The client is responsible for ensuring that the msg object when marshalled is formed according to the requirements of the protocol binding in use.

param
msg An object that will form the message or payload of the message used to invoke the operation.
param
handler The handler object that will receive the response to the operation invocation.
return
A Future object that may be used to check the status of the operation invocation. This object MUST NOT be used to try to obtain the results of the operation - the object returned from Future<?>.get() is implementation dependent and any use of it will result in non-portable behaviour.
throws
WebServiceException If there is any error in the configuration of the Dispatch instance

public voidinvokeOneWay(T msg)
Invokes a service operation using the one-way interaction mode. The operation invocation is logically non-blocking, subject to the capabilities of the underlying protocol, no results are returned. When the protocol in use is SOAP/HTTP, this method MUST block until an HTTP response code has been received or an error occurs.

The client is responsible for ensuring that the msg object when marshalled is formed according to the requirements of the protocol binding in use.

param
msg An object that will form the message or payload of the message used to invoke the operation.
throws
WebServiceException If there is any error in the configuration of the Dispatch instance or if an error occurs during the invocation.