java.lang.Object
com.sun.xml.ws.client.Stub
com.sun.xml.ws.client.dispatch.DispatchImpl<T>
- All Implemented Interfaces:
Component
,ComponentRegistry
,ResponseContextReceiver
,WSBindingProvider
,jakarta.xml.ws.BindingProvider
,jakarta.xml.ws.Dispatch<T>
,Closeable
,AutoCloseable
- Direct Known Subclasses:
DataSourceDispatch
,JAXBDispatch
,MessageDispatch
,PacketDispatch
,SOAPMessageDispatch
The
DispatchImpl
abstract class provides support
for the dynamic invocation of a service endpoint operation using XML
constructs, JAXB objects or SOAPMessage
. The jakarta.xml.ws.Service
interface acts as a factory for the creation of DispatchImpl
instances.- Version:
- 1.0
- Author:
- WS Development Team
-
Field Summary
Fields inherited from class com.sun.xml.ws.client.Stub
addrVersion, binding, endpointReference, operationDispatcher, owner, portInfo, portname, PREVENT_SYNC_START_FOR_ASYNC_INVOKE, requestContext, wsdlPort
Fields inherited from interface jakarta.xml.ws.BindingProvider
ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, SOAPACTION_URI_PROPERTY, SOAPACTION_USE_PROPERTY, USERNAME_PROPERTY
-
Constructor Summary
ModifierConstructorDescriptionprotected
DispatchImpl
(WSPortInfo portInfo, jakarta.xml.ws.Service.Mode mode, Tube pipe, BindingImpl binding, WSEndpointReference epr, boolean allowFaultResponseMsg) protected
DispatchImpl
(WSPortInfo portInfo, jakarta.xml.ws.Service.Mode mode, BindingImpl binding, WSEndpointReference epr) protected
DispatchImpl
(WSPortInfo portInfo, jakarta.xml.ws.Service.Mode mode, BindingImpl binding, WSEndpointReference epr, boolean allowFaultResponseMsg) protected
DispatchImpl
(WSPortInfo portInfo, jakarta.xml.ws.Service.Mode mode, BindingImpl binding, Tube pipe, WSEndpointReference epr, boolean allowFaultResponseMsg) protected
DispatchImpl
(QName port, jakarta.xml.ws.Service.Mode mode, WSServiceDelegate owner, Tube pipe, BindingImpl binding, WSEndpointReference epr) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionstatic void
checkValidDataSourceDispatch
(WSBinding binding, jakarta.xml.ws.Service.Mode mode) static void
checkValidSOAPMessageDispatch
(WSBinding binding, jakarta.xml.ws.Service.Mode mode) static jakarta.xml.ws.Dispatch<Source>
createSourceDispatch
(WSPortInfo portInfo, jakarta.xml.ws.Service.Mode mode, BindingImpl binding, WSEndpointReference epr) static jakarta.xml.ws.Dispatch<Source>
createSourceDispatch
(QName port, jakarta.xml.ws.Service.Mode mode, WSServiceDelegate owner, Tube pipe, BindingImpl binding, WSEndpointReference epr) Deprecated.final T
doInvoke
(T in, RequestContext rc, ResponseContextReceiver receiver) Synchronously invokes a service.final QName
Gets the port name that this stub is configured to talk to.final T
final jakarta.xml.ws.Response<T>
invokeAsync
(T param) final Future<?>
invokeAsync
(T param, jakarta.xml.ws.AsyncHandler<T> asyncHandler) final void
invokeOneWay
(T in) protected String
resolveURI
(URI endpointURI, String pathInfo, String queryString) protected AttachmentSet
void
setOutboundHeaders
(Object... headers) Sets the out-bound headers to be added to messages sent from thisBindingProvider
.Methods inherited from class com.sun.xml.ws.client.Stub
close, configureFiber, getBinding, getComponents, getEndpointReference, getEndpointReference, getExecutor, getInboundHeaders, getManagedObjectManager, getOperationDispatcher, getPortInfo, getRequestContext, getResponseContext, getService, getServiceName, getSPI, getTubes, getWSDLPort, getWSEndpointReference, process, processAsync, resetRequestContext, setAddress, setOutboundHeaders, setOutboundHeaders, setResponseContext, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface jakarta.xml.ws.BindingProvider
getBinding, getEndpointReference, getEndpointReference, getRequestContext, getResponseContext
-
Constructor Details
-
DispatchImpl
@Deprecated protected DispatchImpl(QName port, jakarta.xml.ws.Service.Mode mode, WSServiceDelegate owner, Tube pipe, BindingImpl binding, @Nullable WSEndpointReference epr) Deprecated.- Parameters:
port
- dispatch instance is associated with this wsdl port qNamemode
- Service.mode associated with this Dispatch instance - Service.mode.MESSAGE or Service.mode.PAYLOADowner
- Service that created the Dispatchpipe
- Master pipe for the pipelinebinding
- Binding of this Dispatch instance, current one of SOAP/HTTP or XML/HTTP
-
DispatchImpl
protected DispatchImpl(WSPortInfo portInfo, jakarta.xml.ws.Service.Mode mode, BindingImpl binding, @Nullable WSEndpointReference epr) - Parameters:
portInfo
- dispatch instance is associated with this portInfomode
- Service.mode associated with this Dispatch instance - Service.mode.MESSAGE or Service.mode.PAYLOADbinding
- Binding of this Dispatch instance, current one of SOAP/HTTP or XML/HTTP
-
DispatchImpl
protected DispatchImpl(WSPortInfo portInfo, jakarta.xml.ws.Service.Mode mode, BindingImpl binding, @Nullable WSEndpointReference epr, boolean allowFaultResponseMsg) - Parameters:
portInfo
- dispatch instance is associated with this portInfomode
- Service.mode associated with this Dispatch instance - Service.mode.MESSAGE or Service.mode.PAYLOADbinding
- Binding of this Dispatch instance, current one of SOAP/HTTP or XML/HTTPallowFaultResponseMsg
- A packet containing a SOAP fault message is allowed as the response to a request on this dispatch instance.
-
DispatchImpl
protected DispatchImpl(WSPortInfo portInfo, jakarta.xml.ws.Service.Mode mode, BindingImpl binding, Tube pipe, @Nullable WSEndpointReference epr, boolean allowFaultResponseMsg) - Parameters:
portInfo
- dispatch instance is associated with this portInfomode
- Service.mode associated with this Dispatch instance - Service.mode.MESSAGE or Service.mode.PAYLOADbinding
- Binding of this Dispatch instance, current one of SOAP/HTTP or XML/HTTPpipe
- Master pipe for the pipelineallowFaultResponseMsg
- A packet containing a SOAP fault message is allowed as the response to a request on this dispatch instance.
-
DispatchImpl
protected DispatchImpl(WSPortInfo portInfo, jakarta.xml.ws.Service.Mode mode, Tube pipe, BindingImpl binding, @Nullable WSEndpointReference epr, boolean allowFaultResponseMsg) - Parameters:
portInfo
- dispatch instance is associated with this wsdl port qNamemode
- Service.mode associated with this Dispatch instance - Service.mode.MESSAGE or Service.mode.PAYLOADpipe
- Master pipe for the pipelinebinding
- Binding of this Dispatch instance, current one of SOAP/HTTP or XML/HTTPallowFaultResponseMsg
- A packet containing a SOAP fault message is allowed as the response to a request on this dispatch instance.
-
-
Method Details
-
invokeAsync
- Specified by:
invokeAsync
in interfacejakarta.xml.ws.Dispatch<T>
-
invokeAsync
- Specified by:
invokeAsync
in interfacejakarta.xml.ws.Dispatch<T>
-
doInvoke
Synchronously invokes a service. SeeStub.process(Packet, RequestContext, ResponseContextReceiver)
on why it takes aRequestContext
andResponseContextReceiver
as a parameter. -
invoke
- Specified by:
invoke
in interfacejakarta.xml.ws.Dispatch<T>
-
invokeOneWay
- Specified by:
invokeOneWay
in interfacejakarta.xml.ws.Dispatch<T>
-
checkValidSOAPMessageDispatch
public static void checkValidSOAPMessageDispatch(WSBinding binding, jakarta.xml.ws.Service.Mode mode) -
checkValidDataSourceDispatch
public static void checkValidDataSourceDispatch(WSBinding binding, jakarta.xml.ws.Service.Mode mode) -
getPortName
Description copied from class:Stub
Gets the port name that this stub is configured to talk to.When
Stub.wsdlPort
is non-null, the port name is always the same asWSDLPort.getName()
, but this method returns a port name even if no WSDL is available for this stub.- Specified by:
getPortName
in classStub
-
resolveURI
-
setOutboundAttachments
-
setOutboundHeaders
Description copied from interface:WSBindingProvider
Sets the out-bound headers to be added to messages sent from thisBindingProvider
.Each object must be a JAXB-bound object that is understood by the
JAXBContext
object known by thisWSBindingProvider
(that is, if this is aDispatch
with JAXB, thenJAXBContext
given toService.createDispatch(QName,JAXBContext,Mode)
and if this is a typed proxy, thenJAXBContext
implicitly created by the JAX-WS RI.)- Specified by:
setOutboundHeaders
in interfaceWSBindingProvider
- Parameters:
headers
- Can be null or empty.
-
createSourceDispatch
@Deprecated public static jakarta.xml.ws.Dispatch<Source> createSourceDispatch(QName port, jakarta.xml.ws.Service.Mode mode, WSServiceDelegate owner, Tube pipe, BindingImpl binding, WSEndpointReference epr) Deprecated. -
createSourceDispatch
public static jakarta.xml.ws.Dispatch<Source> createSourceDispatch(WSPortInfo portInfo, jakarta.xml.ws.Service.Mode mode, BindingImpl binding, WSEndpointReference epr)
-