public abstract class DispatchImpl<T> extends Stub implements Dispatch<T>
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.Modifier and Type | Field and Description |
---|---|
(package private) boolean |
allowFaultResponseMsg |
(package private) static long |
AWAIT_TERMINATION_TIME |
(package private) static String |
HTTP_REQUEST_METHOD_GET |
(package private) static String |
HTTP_REQUEST_METHOD_POST |
(package private) static String |
HTTP_REQUEST_METHOD_PUT |
(package private) Service.Mode |
mode |
(package private) SOAPVersion |
soapVersion |
addrVersion, binding, endpointReference, operationDispatcher, owner, portInfo, portname, PREVENT_SYNC_START_FOR_ASYNC_INVOKE, requestContext, wsdlPort
ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, SOAPACTION_URI_PROPERTY, SOAPACTION_USE_PROPERTY, USERNAME_PROPERTY
Modifier | Constructor and Description |
---|---|
protected |
DispatchImpl(QName port,
Service.Mode mode,
WSServiceDelegate owner,
Tube pipe,
BindingImpl binding,
WSEndpointReference epr)
Deprecated.
|
protected |
DispatchImpl(WSPortInfo portInfo,
Service.Mode mode,
BindingImpl binding,
Tube pipe,
WSEndpointReference epr,
boolean allowFaultResponseMsg) |
protected |
DispatchImpl(WSPortInfo portInfo,
Service.Mode mode,
BindingImpl binding,
WSEndpointReference epr) |
protected |
DispatchImpl(WSPortInfo portInfo,
Service.Mode mode,
BindingImpl binding,
WSEndpointReference epr,
boolean allowFaultResponseMsg) |
protected |
DispatchImpl(WSPortInfo portInfo,
Service.Mode mode,
Tube pipe,
BindingImpl binding,
WSEndpointReference epr,
boolean allowFaultResponseMsg) |
Modifier and Type | Method and Description |
---|---|
(package private) static void |
checkNullAllowed(Object in,
RequestContext rc,
WSBinding binding,
Service.Mode mode) |
static void |
checkValidDataSourceDispatch(WSBinding binding,
Service.Mode mode) |
static void |
checkValidSOAPMessageDispatch(WSBinding binding,
Service.Mode mode) |
(package private) abstract Packet |
createPacket(T msg)
Abstract method that is implemented by each concrete Dispatch class
|
static Dispatch<Source> |
createSourceDispatch(QName port,
Service.Mode mode,
WSServiceDelegate owner,
Tube pipe,
BindingImpl binding,
WSEndpointReference epr)
Deprecated.
|
static Dispatch<Source> |
createSourceDispatch(WSPortInfo portInfo,
Service.Mode mode,
BindingImpl binding,
WSEndpointReference epr) |
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) |
Response<T> |
invokeAsync(T param) |
Future<?> |
invokeAsync(T param,
AsyncHandler<T> asyncHandler) |
void |
invokeOneWay(T in) |
(package private) static boolean |
isPAYLOADMode(Service.Mode mode) |
(package private) static boolean |
isXMLHttp(WSBinding binding) |
(package private) static boolean |
methodNotOk(RequestContext rc) |
(package private) void |
resolveEndpointAddress(Packet message,
RequestContext requestContext) |
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 . |
(package private) void |
setProperties(Packet packet,
boolean expectReply) |
(package private) abstract T |
toReturnValue(Packet response)
Obtains the value to return from the response message.
|
close, 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getBinding, getEndpointReference, getEndpointReference, getRequestContext, getResponseContext
final Service.Mode mode
final SOAPVersion soapVersion
final boolean allowFaultResponseMsg
static final long AWAIT_TERMINATION_TIME
static final String HTTP_REQUEST_METHOD_GET
static final String HTTP_REQUEST_METHOD_POST
static final String HTTP_REQUEST_METHOD_PUT
@Deprecated protected DispatchImpl(QName port, Service.Mode mode, WSServiceDelegate owner, Tube pipe, BindingImpl binding, @Nullable WSEndpointReference epr)
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/HTTPprotected DispatchImpl(WSPortInfo portInfo, Service.Mode mode, BindingImpl binding, @Nullable WSEndpointReference epr)
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/HTTPprotected DispatchImpl(WSPortInfo portInfo, Service.Mode mode, BindingImpl binding, @Nullable WSEndpointReference epr, boolean allowFaultResponseMsg)
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.protected DispatchImpl(WSPortInfo portInfo, Service.Mode mode, BindingImpl binding, Tube pipe, @Nullable WSEndpointReference epr, boolean allowFaultResponseMsg)
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.protected DispatchImpl(WSPortInfo portInfo, Service.Mode mode, Tube pipe, BindingImpl binding, @Nullable WSEndpointReference epr, boolean allowFaultResponseMsg)
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/HTTPallowFaultResponseMsg
- A packet containing a SOAP fault message is allowed as the response to a request on this dispatch instance.abstract Packet createPacket(T msg)
msg
- message passed in from the client program on the invocationabstract T toReturnValue(Packet response)
public final Response<T> invokeAsync(T param)
invokeAsync
in interface Dispatch<T>
public final Future<?> invokeAsync(T param, AsyncHandler<T> asyncHandler)
invokeAsync
in interface Dispatch<T>
public final T doInvoke(T in, RequestContext rc, ResponseContextReceiver receiver)
Stub.process(Packet, RequestContext, ResponseContextReceiver)
on
why it takes a RequestContext
and ResponseContextReceiver
as a parameter.public final void invokeOneWay(T in)
invokeOneWay
in interface Dispatch<T>
void setProperties(Packet packet, boolean expectReply)
static boolean isXMLHttp(@NotNull WSBinding binding)
static boolean isPAYLOADMode(@NotNull Service.Mode mode)
static void checkNullAllowed(@Nullable Object in, RequestContext rc, WSBinding binding, Service.Mode mode)
static boolean methodNotOk(@NotNull RequestContext rc)
public static void checkValidSOAPMessageDispatch(WSBinding binding, Service.Mode mode)
public static void checkValidDataSourceDispatch(WSBinding binding, Service.Mode mode)
@NotNull public final QName getPortName()
Stub
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.
getPortName
in class Stub
void resolveEndpointAddress(@NotNull Packet message, @NotNull RequestContext requestContext)
@NotNull protected String resolveURI(@NotNull URI endpointURI, @Nullable String pathInfo, @Nullable String queryString)
protected AttachmentSet setOutboundAttachments()
public void setOutboundHeaders(Object... headers)
WSBindingProvider
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.)
setOutboundHeaders
in interface WSBindingProvider
headers
- Can be null or empty.@Deprecated public static Dispatch<Source> createSourceDispatch(QName port, Service.Mode mode, WSServiceDelegate owner, Tube pipe, BindingImpl binding, WSEndpointReference epr)
public static Dispatch<Source> createSourceDispatch(WSPortInfo portInfo, Service.Mode mode, BindingImpl binding, WSEndpointReference epr)
Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.