public interface Dispatch<T> extends BindingProvider
Dispatch
interface provides support
for the dynamic invocation of a service endpoint operations. The
javax.xml.ws.Service
class acts as a factory for the creation of Dispatch
instances.ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, SOAPACTION_URI_PROPERTY, SOAPACTION_USE_PROPERTY, USERNAME_PROPERTY
Modifier and Type | Method and Description |
---|---|
T |
invoke(T msg)
Invoke a service operation synchronously.
|
Response<T> |
invokeAsync(T msg)
Invoke a service operation asynchronously.
|
Future<?> |
invokeAsync(T msg,
AsyncHandler<T> handler)
Invoke a service operation asynchronously.
|
void |
invokeOneWay(T msg)
Invokes a service operation using the one-way
interaction mode.
|
getBinding, getEndpointReference, getEndpointReference, getRequestContext, getResponseContext
T invoke(T msg)
msg
object
when marshalled is formed according to the requirements of the protocol
binding in use.msg
- An object that will form the message or payload of
the message used to invoke the operation.WebServiceException
- If a fault occurs during communication with
the serviceWebServiceException
- If there is any error in the configuration of
the Dispatch
instanceResponse<T> invokeAsync(T msg)
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.
msg
- An object that will form the message or payload of
the message used to invoke the operation.WebServiceException
- If there is any error in the configuration of
the Dispatch
instanceFuture<?> invokeAsync(T msg, AsyncHandler<T> handler)
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.
msg
- An object that will form the message or payload of
the message used to invoke the operation.handler
- The handler object that will receive the
response to the operation invocation.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.WebServiceException
- If there is any error in the configuration of
the Dispatch
instancevoid invokeOneWay(T msg)
The client is responsible for ensuring that the msg
object
when marshalled is formed according to the requirements of the protocol
binding in use.
msg
- An object that will form the message or payload of
the message used to invoke the operation.WebServiceException
- If there is any error in the configuration of
the Dispatch
instance or if an error occurs during the
invocation. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.