JAX-WS API 2.3.1 · javax.xml.ws.Dispatch

Method Summary

Modifier and Type	Method and Description
public T	Returns: The response message or message payload to the operation invocation. invoke(T An object that will form the message or payload of the message used to invoke the operation. msg) Invoke a service operation synchronously.
public Response<T>	Returns: The response message or message payload to the operation invocation. invokeAsync(T An object that will form the message or payload of the message used to invoke the operation. msg) Invoke a service operation asynchronously.
public Future<?>	Returns: 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. invokeAsync(T An object that will form the message or payload of the message used to invoke the operation. msg, AsyncHandler<T> The handler object that will receive the response to the operation invocation. handler) Invoke a service operation asynchronously.
public void	invokeOneWay(T An object that will form the message or payload of the message used to invoke the operation. msg) Invokes a service operation using the one-way interaction mode.

Inherited from javax.xml.ws.BindingProvider:: getBinding getEndpointReference getEndpointReference getRequestContext getResponseContext

Method Detail

invoke back to summary

invoke	back to summary
public T invoke(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. Parameters msg:T An object that will form the message or payload of the message used to invoke the operation. Returns:T The response message or message payload to the operation invocation. Exceptions WebServiceException: If a fault occurs during communication with the service If there is any error in the configuration of the `Dispatch` instance

public T invoke(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.

Parameters

msg:T: An object that will form the message or payload of the message used to invoke the operation.

Returns:T

The response message or message payload to the operation invocation.

Exceptions

WebServiceException:

If a fault occurs during communication with the service
If there is any error in the configuration of the Dispatch instance

invokeAsync back to summary

invokeAsync	back to summary
public Response<T> invokeAsync(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. Parameters msg:T An object that will form the message or payload of the message used to invoke the operation. Returns:Response<T> The response message or message payload to the operation invocation. Exceptions WebServiceException: If there is any error in the configuration of the `Dispatch` instance

public Response<T> invokeAsync(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.

Parameters

msg:T: An object that will form the message or payload of the message used to invoke the operation.

Returns:Response<T>

The response message or message payload to the operation invocation.

Exceptions

WebServiceException:: If there is any error in the configuration of the Dispatch instance

invokeAsync back to summary

invokeAsync	back to summary
public Future<?> invokeAsync(T msg, AsyncHandler<T> 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. Parameters msg:T An object that will form the message or payload of the message used to invoke the operation. handler:AsyncHandler<T> The handler object that will receive the response to the operation invocation. Returns:Future<?> 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. Exceptions WebServiceException: If there is any error in the configuration of the `Dispatch` instance

public Future<?> invokeAsync(T msg, AsyncHandler<T> 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.

Parameters

msg:T: An object that will form the message or payload of the message used to invoke the operation.
handler:AsyncHandler<T>: The handler object that will receive the response to the operation invocation.

Returns:Future<?>

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.

Exceptions

WebServiceException:: If there is any error in the configuration of the Dispatch instance

invokeOneWay back to summary

invokeOneWay	back to summary
public void invokeOneWay(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. Parameters msg:T An object that will form the message or payload of the message used to invoke the operation. Exceptions WebServiceException: If there is any error in the configuration of the `Dispatch` instance or if an error occurs during the invocation.

public void invokeOneWay(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.

Parameters

msg:T: An object that will form the message or payload of the message used to invoke the operation.

Exceptions

WebServiceException:: If there is any error in the configuration of the Dispatch instance or if an error occurs during the invocation.

public Interface Dispatch<T>

Field Summary

Method Summary

Method Detail