Module com.sun.xml.ws.rt

Package com.sun.xml.ws.client.dispatch

Class DispatchImpl<T>

java.lang.Object

com.sun.xml.ws.client.Stub

com.sun.xml.ws.client.dispatch.DispatchImpl<T>

All Implemented Interfaces:

Component, ComponentRegistry, ResponseContextReceiver, WSBindingProvider, Closeable, AutoCloseable, javax.xml.ws.BindingProvider, javax.xml.ws.Dispatch<T>

Direct Known Subclasses:

DataSourceDispatch, JAXBDispatch, MessageDispatch, PacketDispatch, SOAPMessageDispatch

public abstract class DispatchImpl<T>
extends Stub
implements javax.xml.ws.Dispatch<T>

The DispatchImpl abstract class provides support for the dynamic invocation of a service endpoint operation using XML constructs, JAXB objects or SOAPMessage. The javax.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 javax.xml.ws.BindingProvider

ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, SOAPACTION_URI_PROPERTY, SOAPACTION_USE_PROPERTY, USERNAME_PROPERTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DispatchImpl(WSPortInfo portInfo, javax.xml.ws.Service.Mode mode, Tube pipe, BindingImpl binding, WSEndpointReference epr, boolean allowFaultResponseMsg)
protected	DispatchImpl(WSPortInfo portInfo, javax.xml.ws.Service.Mode mode, BindingImpl binding, WSEndpointReference epr)
protected	DispatchImpl(WSPortInfo portInfo, javax.xml.ws.Service.Mode mode, BindingImpl binding, WSEndpointReference epr, boolean allowFaultResponseMsg)
protected	DispatchImpl(WSPortInfo portInfo, javax.xml.ws.Service.Mode mode, BindingImpl binding, Tube pipe, WSEndpointReference epr, boolean allowFaultResponseMsg)
protected	DispatchImpl(QName port, javax.xml.ws.Service.Mode mode, WSServiceDelegate owner, Tube pipe, BindingImpl binding, WSEndpointReference epr)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static void	checkValidDataSourceDispatch(WSBinding binding, javax.xml.ws.Service.Mode mode)
static void	checkValidSOAPMessageDispatch(WSBinding binding, javax.xml.ws.Service.Mode mode)
static javax.xml.ws.Dispatch<Source>	createSourceDispatch(WSPortInfo portInfo, javax.xml.ws.Service.Mode mode, BindingImpl binding, WSEndpointReference epr)
static javax.xml.ws.Dispatch<Source>	createSourceDispatch(QName port, javax.xml.ws.Service.Mode mode, WSServiceDelegate owner, Tube pipe, BindingImpl binding, WSEndpointReference epr)	Deprecated.
T	doInvoke(T in, RequestContext rc, ResponseContextReceiver receiver)	Synchronously invokes a service.
QName	getPortName()	Gets the port name that this stub is configured to talk to.
T	invoke(T in)
javax.xml.ws.Response<T>	invokeAsync(T param)
Future<?>	invokeAsync(T param, javax.xml.ws.AsyncHandler<T> asyncHandler)
void	invokeOneWay(T in)
protected String	resolveURI(URI endpointURI, String pathInfo, String queryString)
protected AttachmentSet	setOutboundAttachments()
void	setOutboundHeaders(Object... headers)	Sets the out-bound headers to be added to messages sent from this BindingProvider.

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 javax.xml.ws.BindingProvider

getBinding, getEndpointReference, getEndpointReference, getRequestContext, getResponseContext

Constructor Detail

DispatchImpl

@Deprecated
protected DispatchImpl(QName port,
                       javax.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 qName

mode - Service.mode associated with this Dispatch instance - Service.mode.MESSAGE or Service.mode.PAYLOAD

owner - Service that created the Dispatch

pipe - Master pipe for the pipeline

binding - Binding of this Dispatch instance, current one of SOAP/HTTP or XML/HTTP

DispatchImpl

protected DispatchImpl(WSPortInfo portInfo,
                       javax.xml.ws.Service.Mode mode,
                       BindingImpl binding,
                       @Nullable
                       WSEndpointReference epr)

Parameters:

portInfo - dispatch instance is associated with this portInfo

mode - Service.mode associated with this Dispatch instance - Service.mode.MESSAGE or Service.mode.PAYLOAD

binding - Binding of this Dispatch instance, current one of SOAP/HTTP or XML/HTTP

DispatchImpl

protected DispatchImpl(WSPortInfo portInfo,
                       javax.xml.ws.Service.Mode mode,
                       BindingImpl binding,
                       @Nullable
                       WSEndpointReference epr,
                       boolean allowFaultResponseMsg)

Parameters:

portInfo - dispatch instance is associated with this portInfo

mode - Service.mode associated with this Dispatch instance - Service.mode.MESSAGE or Service.mode.PAYLOAD

binding - Binding of this Dispatch instance, current one of SOAP/HTTP or XML/HTTP

allowFaultResponseMsg - A packet containing a SOAP fault message is allowed as the response to a request on this dispatch instance.

DispatchImpl

protected DispatchImpl(WSPortInfo portInfo,
                       javax.xml.ws.Service.Mode mode,
                       BindingImpl binding,
                       Tube pipe,
                       @Nullable
                       WSEndpointReference epr,
                       boolean allowFaultResponseMsg)

Parameters:

portInfo - dispatch instance is associated with this portInfo

mode - Service.mode associated with this Dispatch instance - Service.mode.MESSAGE or Service.mode.PAYLOAD

binding - Binding of this Dispatch instance, current one of SOAP/HTTP or XML/HTTP

pipe - Master pipe for the pipeline

allowFaultResponseMsg - A packet containing a SOAP fault message is allowed as the response to a request on this dispatch instance.

DispatchImpl

protected DispatchImpl(WSPortInfo portInfo,
                       javax.xml.ws.Service.Mode mode,
                       Tube pipe,
                       BindingImpl binding,
                       @Nullable
                       WSEndpointReference epr,
                       boolean allowFaultResponseMsg)

Parameters:

portportInfo - dispatch instance is associated with this wsdl port qName

mode - Service.mode associated with this Dispatch instance - Service.mode.MESSAGE or Service.mode.PAYLOAD

pipe - Master pipe for the pipeline

binding - Binding of this Dispatch instance, current one of SOAP/HTTP or XML/HTTP

allowFaultResponseMsg - A packet containing a SOAP fault message is allowed as the response to a request on this dispatch instance.

Method Detail

invokeAsync

public final javax.xml.ws.Response<T> invokeAsync(T param)

Specified by:

invokeAsync in interface javax.xml.ws.Dispatch<T>

invokeAsync

public final Future<?> invokeAsync(T param,
                                   javax.xml.ws.AsyncHandler<T> asyncHandler)

Specified by:

invokeAsync in interface javax.xml.ws.Dispatch<T>

doInvoke

public final T doInvoke(T in,
                        RequestContext rc,
                        ResponseContextReceiver receiver)

Synchronously invokes a service. See Stub.process(Packet, RequestContext, ResponseContextReceiver) on why it takes a RequestContext and ResponseContextReceiver as a parameter.

invoke

public final T invoke(T in)

Specified by:

invoke in interface javax.xml.ws.Dispatch<T>

invokeOneWay

public final void invokeOneWay(T in)

Specified by:

invokeOneWay in interface javax.xml.ws.Dispatch<T>

checkValidSOAPMessageDispatch

public static void checkValidSOAPMessageDispatch(WSBinding binding,
                                                 javax.xml.ws.Service.Mode mode)

checkValidDataSourceDispatch

public static void checkValidDataSourceDispatch(WSBinding binding,
                                                javax.xml.ws.Service.Mode mode)

getPortName

@NotNull
public final QName 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 as WSDLPort.getName(), but this method returns a port name even if no WSDL is available for this stub.

Specified by:

getPortName in class Stub

resolveURI

@NotNull
protected String resolveURI(@NotNull
                            URI endpointURI,
                            @Nullable
                            String pathInfo,
                            @Nullable
                            String queryString)

setOutboundAttachments

protected AttachmentSet setOutboundAttachments()

setOutboundHeaders

public void setOutboundHeaders(Object... headers)

Description copied from interface: WSBindingProvider

Sets the out-bound headers to be added to messages sent from this BindingProvider.

Each object must be a JAXB-bound object that is understood by the JAXBContext object known by this WSBindingProvider (that is, if this is a Dispatch with JAXB, then JAXBContext given to Service.createDispatch(QName,JAXBContext,Mode) and if this is a typed proxy, then JAXBContext implicitly created by the JAX-WS RI.)

Specified by:

setOutboundHeaders in interface WSBindingProvider

Parameters:

headers - Can be null or empty.

createSourceDispatch

@Deprecated
public static javax.xml.ws.Dispatch<Source> createSourceDispatch(QName port,
                                                                 javax.xml.ws.Service.Mode mode,
                                                                 WSServiceDelegate owner,
                                                                 Tube pipe,
                                                                 BindingImpl binding,
                                                                 WSEndpointReference epr)

Deprecated.

createSourceDispatch

public static javax.xml.ws.Dispatch<Source> createSourceDispatch(WSPortInfo portInfo,
                                                                 javax.xml.ws.Service.Mode mode,
                                                                 BindingImpl binding,
                                                                 WSEndpointReference epr)