Package com.sun.xml.ws.client

Class WSServiceDelegate

java.lang.Object

jakarta.xml.ws.spi.ServiceDelegate

com.sun.xml.ws.api.WSService

com.sun.xml.ws.client.WSServiceDelegate

All Implemented Interfaces:

Component, ComponentRegistry

public class WSServiceDelegate
extends WSService

Service objects provide the client view of a Web service.

Service acts as a factory of the following:

• Proxies for a target service endpoint.
• Instances of jakarta.xml.ws.Dispatch for dynamic message-oriented invocation of a remote operation.

The ports available on a service can be enumerated using the getPorts method. Alternatively, you can pass a service endpoint interface to the unary getPort method and let the runtime select a compatible port.

Handler chains for all the objects created by a Service can be set by means of the provided HandlerRegistry.

An Executor may be set on the service in order to gain better control over the threads used to dispatch asynchronous callbacks. For instance, thread pooling with certain parameters can be enabled by creating a ThreadPoolExecutor and registering it with the service.

Since:

JAX-WS 2.0

Author:

WS Development Team

See Also:

• Executor

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.xml.ws.api.WSService

WSService.InitParams

Field Summary

Fields

Modifier and Type	Field	Description
protected static final WebServiceFeature[]	EMPTY_FEATURES

Fields inherited from class com.sun.xml.ws.api.WSService

EMPTY_PARAMS, INIT_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WSServiceDelegate(URL wsdlDocumentLocation, QName serviceName, Class<? extends Service> serviceClass, WebServiceFeatureList features)
	WSServiceDelegate(URL wsdlDocumentLocation, QName serviceName, Class<? extends Service> serviceClass, WebServiceFeature... features)
	WSServiceDelegate(Source wsdl, WSDLService service, QName serviceName, Class<? extends Service> serviceClass, WebServiceFeatureList features)
	WSServiceDelegate(Source wsdl, WSDLService service, QName serviceName, Class<? extends Service> serviceClass, WebServiceFeature... features)
protected	WSServiceDelegate(Source wsdl, QName serviceName, Class<? extends Service> serviceClass, WebServiceFeatureList features)
	WSServiceDelegate(Source wsdl, QName serviceName, Class<? extends Service> serviceClass, WebServiceFeature... features)

Method Summary

Modifier and Type	Method	Description
void	addPort(QName portName, String bindingId, String endpointAddress)
SEIModel	buildRuntimeModel(QName serviceName, QName portName, Class portInterface, WSDLPort wsdlPort, WebServiceFeatureList features)
protected EntityResolver	createCatalogResolver()
Dispatch<Object>	createDispatch(EndpointReference endpointReference, jakarta.xml.bind.JAXBContext context, Service.Mode mode, WebServiceFeature... features)
<T> Dispatch<T>	createDispatch(EndpointReference endpointReference, Class<T> type, Service.Mode mode, WebServiceFeature... features)
protected Dispatch<Object>	createDispatch(QName portName, WSEndpointReference wsepr, jakarta.xml.bind.JAXBContext jaxbContext, Service.Mode mode, WebServiceFeatureList features)
Dispatch<Object>	createDispatch(QName portName, WSEndpointReference wsepr, jakarta.xml.bind.JAXBContext jaxbContext, Service.Mode mode, WebServiceFeature... features)	Works like ServiceDelegate.createDispatch(jakarta.xml.ws.EndpointReference, jakarta.xml.bind.JAXBContext, jakarta.xml.ws.Service.Mode, jakarta.xml.ws.WebServiceFeature[]) but it takes the port name separately, so that EPR without embedded metadata can be used.
<T> Dispatch<T>	createDispatch(QName portName, WSEndpointReference wsepr, Class<T> aClass, Service.Mode mode, WebServiceFeatureList features)
<T> Dispatch<T>	createDispatch(QName portName, WSEndpointReference wsepr, Class<T> aClass, Service.Mode mode, WebServiceFeature... features)	Works like ServiceDelegate.createDispatch(jakarta.xml.ws.EndpointReference, java.lang.Class, jakarta.xml.ws.Service.Mode, jakarta.xml.ws.WebServiceFeature[]) but it takes the port name separately, so that EPR without embedded metadata can be used.
Dispatch<Object>	createDispatch(QName portName, jakarta.xml.bind.JAXBContext jaxbContext, Service.Mode mode)
protected Dispatch<Object>	createDispatch(QName portName, jakarta.xml.bind.JAXBContext jaxbContext, Service.Mode mode, WebServiceFeatureList features)
Dispatch<Object>	createDispatch(QName portName, jakarta.xml.bind.JAXBContext jaxbContext, Service.Mode mode, WebServiceFeature... webServiceFeatures)
<T> Dispatch<T>	createDispatch(QName portName, Class<T> aClass, Service.Mode mode)
<T> Dispatch<T>	createDispatch(QName portName, Class<T> aClass, Service.Mode mode, WebServiceFeatureList features)
<T> Dispatch<T>	createDispatch(QName portName, Class<T> aClass, Service.Mode mode, WebServiceFeature... features)
Container	getContainer()	Gets the Container object.
EndpointAddress	getEndpointAddress(QName qName)
Executor	getExecutor()
HandlerResolver	getHandlerResolver()
<T> T	getPort(WSEndpointReference wsepr, Class<T> portInterface, WebServiceFeature... features)	Works like ServiceDelegate.getPort(EndpointReference, Class, WebServiceFeature...) but takes WSEndpointReference.
protected <T> T	getPort(WSEndpointReference wsepr, QName portName, Class<T> portInterface, WebServiceFeatureList features)
<T> T	getPort(EndpointReference epr, Class<T> portInterface, WebServiceFeature... features)
<T> T	getPort(Class<T> portInterface)
<T> T	getPort(Class<T> portInterface, WebServiceFeature... features)
<T> T	getPort(QName portName, Class<T> portInterface)
<T> T	getPort(QName portName, Class<T> portInterface, WebServiceFeature... features)
WSDLPort	getPortModel(WSDLService wsdlService, QName portName)	Obtains a WSDLPortImpl with error check.
Iterator<QName>	getPorts()
protected Map<QName,PortInfo>	getQNameToPortInfoMap()
Class	getServiceClass()
QName	getServiceName()
protected InvocationHandler	getStubHandler(BindingImpl binding, SEIPortInfo eif, WSEndpointReference epr)
URL	getWSDLDocumentLocation()
WSDLService	getWsdlService()
PortInfo	safeGetPort(QName portName)	Obtains PortInfo for the given name, with error check.
void	setExecutor(Executor executor)
void	setHandlerResolver(HandlerResolver resolver)

Methods inherited from class com.sun.xml.ws.api.WSService

create, create, create, create, getComponents, getSPI, unwrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EMPTY_FEATURES

protected static final WebServiceFeature[] EMPTY_FEATURES

Constructor Details

WSServiceDelegate

public WSServiceDelegate(URL wsdlDocumentLocation,
 QName serviceName,
 Class<? extends Service> serviceClass,
 WebServiceFeature... features)

WSServiceDelegate

protected WSServiceDelegate(URL wsdlDocumentLocation,
 QName serviceName,
 Class<? extends Service> serviceClass,
 WebServiceFeatureList features)

WSServiceDelegate

public WSServiceDelegate(@Nullable
 Source wsdl,
 @NotNull
 QName serviceName,
 @NotNull
 Class<? extends Service> serviceClass,
 WebServiceFeature... features)

Parameters:

serviceClass - Either Service.class or other generated service-derived classes.

WSServiceDelegate

protected WSServiceDelegate(@Nullable
 Source wsdl,
 @NotNull
 QName serviceName,
 @NotNull
 Class<? extends Service> serviceClass,
 WebServiceFeatureList features)

Parameters:

serviceClass - Either Service.class or other generated service-derived classes.

WSServiceDelegate

public WSServiceDelegate(@Nullable
 Source wsdl,
 @Nullable
 WSDLService service,
 @NotNull
 QName serviceName,
 @NotNull
 Class<? extends Service> serviceClass,
 WebServiceFeature... features)

Parameters:

serviceClass - Either Service.class or other generated service-derived classes.

WSServiceDelegate

public WSServiceDelegate(@Nullable
 Source wsdl,
 @Nullable
 WSDLService service,
 @NotNull
 QName serviceName,
 @NotNull
 Class<? extends Service> serviceClass,
 WebServiceFeatureList features)

Parameters:

serviceClass - Either Service.class or other generated service-derived classes.

Method Details

getQNameToPortInfoMap

protected Map<QName,PortInfo> getQNameToPortInfoMap()

createCatalogResolver

protected EntityResolver createCatalogResolver()

getExecutor

public Executor getExecutor()

Specified by:

getExecutor in class ServiceDelegate

setExecutor

public void setExecutor(Executor executor)

Specified by:

setExecutor in class ServiceDelegate

getHandlerResolver

public HandlerResolver getHandlerResolver()

Specified by:

getHandlerResolver in class ServiceDelegate

setHandlerResolver

public void setHandlerResolver(HandlerResolver resolver)

Specified by:

setHandlerResolver in class ServiceDelegate

getPort

public <T> T getPort(QName portName,
 Class<T> portInterface)
              throws WebServiceException

Specified by:

getPort in class ServiceDelegate

Throws:

WebServiceException

getPort

public <T> T getPort(QName portName,
 Class<T> portInterface,
 WebServiceFeature... features)

Specified by:

getPort in class ServiceDelegate

getPort

public <T> T getPort(EndpointReference epr,
 Class<T> portInterface,
 WebServiceFeature... features)

Specified by:

getPort in class ServiceDelegate

getPort

public <T> T getPort(WSEndpointReference wsepr,
 Class<T> portInterface,
 WebServiceFeature... features)

Description copied from class: WSService

Works like ServiceDelegate.getPort(EndpointReference, Class, WebServiceFeature...) but takes WSEndpointReference.

Specified by:

getPort in class WSService

getPort

protected <T> T getPort(WSEndpointReference wsepr,
 QName portName,
 Class<T> portInterface,
 WebServiceFeatureList features)

getPort

public <T> T getPort(Class<T> portInterface,
 WebServiceFeature... features)

Specified by:

getPort in class ServiceDelegate

getPort

public <T> T getPort(Class<T> portInterface)
              throws WebServiceException

Specified by:

getPort in class ServiceDelegate

Throws:

WebServiceException

addPort

public void addPort(QName portName,
 String bindingId,
 String endpointAddress)
             throws WebServiceException

Specified by:

addPort in class ServiceDelegate

Throws:

WebServiceException

createDispatch

public <T> Dispatch<T> createDispatch(QName portName,
 Class<T> aClass,
 Service.Mode mode)
                               throws WebServiceException

Specified by:

createDispatch in class ServiceDelegate

Throws:

WebServiceException

createDispatch

public <T> Dispatch<T> createDispatch(QName portName,
 WSEndpointReference wsepr,
 Class<T> aClass,
 Service.Mode mode,
 WebServiceFeature... features)

Description copied from class: WSService

Works like ServiceDelegate.createDispatch(jakarta.xml.ws.EndpointReference, java.lang.Class, jakarta.xml.ws.Service.Mode, jakarta.xml.ws.WebServiceFeature[]) but it takes the port name separately, so that EPR without embedded metadata can be used.

Specified by:

createDispatch in class WSService

createDispatch

public <T> Dispatch<T> createDispatch(QName portName,
 WSEndpointReference wsepr,
 Class<T> aClass,
 Service.Mode mode,
 WebServiceFeatureList features)

createDispatch

public <T> Dispatch<T> createDispatch(QName portName,
 Class<T> aClass,
 Service.Mode mode,
 WebServiceFeature... features)

Specified by:

createDispatch in class ServiceDelegate

createDispatch

public <T> Dispatch<T> createDispatch(QName portName,
 Class<T> aClass,
 Service.Mode mode,
 WebServiceFeatureList features)

createDispatch

public <T> Dispatch<T> createDispatch(EndpointReference endpointReference,
 Class<T> type,
 Service.Mode mode,
 WebServiceFeature... features)

Specified by:

createDispatch in class ServiceDelegate

safeGetPort

@NotNull
public PortInfo safeGetPort(QName portName)

Obtains PortInfo for the given name, with error check.

getEndpointAddress

public EndpointAddress getEndpointAddress(QName qName)

createDispatch

public Dispatch<Object> createDispatch(QName portName,
 jakarta.xml.bind.JAXBContext jaxbContext,
 Service.Mode mode)
                                throws WebServiceException

Specified by:

createDispatch in class ServiceDelegate

Throws:

WebServiceException

createDispatch

public Dispatch<Object> createDispatch(QName portName,
 WSEndpointReference wsepr,
 jakarta.xml.bind.JAXBContext jaxbContext,
 Service.Mode mode,
 WebServiceFeature... features)

Description copied from class: WSService

Works like ServiceDelegate.createDispatch(jakarta.xml.ws.EndpointReference, jakarta.xml.bind.JAXBContext, jakarta.xml.ws.Service.Mode, jakarta.xml.ws.WebServiceFeature[]) but it takes the port name separately, so that EPR without embedded metadata can be used.

Specified by:

createDispatch in class WSService

createDispatch

protected Dispatch<Object> createDispatch(QName portName,
 WSEndpointReference wsepr,
 jakarta.xml.bind.JAXBContext jaxbContext,
 Service.Mode mode,
 WebServiceFeatureList features)

getContainer

@NotNull
public Container getContainer()

Description copied from class: WSService

Gets the Container object.

The components inside WSEndpoint uses this reference to communicate with the hosting environment.

Specified by:

getContainer in class WSService

Returns:

always same object. If no "real" Container instance is given, Container.NONE will be returned.

createDispatch

public Dispatch<Object> createDispatch(QName portName,
 jakarta.xml.bind.JAXBContext jaxbContext,
 Service.Mode mode,
 WebServiceFeature... webServiceFeatures)

Specified by:

createDispatch in class ServiceDelegate

createDispatch

protected Dispatch<Object> createDispatch(QName portName,
 jakarta.xml.bind.JAXBContext jaxbContext,
 Service.Mode mode,
 WebServiceFeatureList features)

createDispatch

public Dispatch<Object> createDispatch(EndpointReference endpointReference,
 jakarta.xml.bind.JAXBContext context,
 Service.Mode mode,
 WebServiceFeature... features)

Specified by:

createDispatch in class ServiceDelegate

getServiceName

public QName getServiceName()

Specified by:

getServiceName in class ServiceDelegate

getServiceClass

public Class getServiceClass()

getPorts

public Iterator<QName> getPorts()
                         throws WebServiceException

Specified by:

getPorts in class ServiceDelegate

Throws:

WebServiceException

getWSDLDocumentLocation

public URL getWSDLDocumentLocation()

Specified by:

getWSDLDocumentLocation in class ServiceDelegate

getStubHandler

protected InvocationHandler getStubHandler(BindingImpl binding,
 SEIPortInfo eif,
 @Nullable
 WSEndpointReference epr)

getPortModel

@NotNull
public WSDLPort getPortModel(WSDLService wsdlService,
 QName portName)

Obtains a WSDLPortImpl with error check.

Returns:

guaranteed to be non-null.

buildRuntimeModel

public SEIModel buildRuntimeModel(QName serviceName,
 QName portName,
 Class portInterface,
 WSDLPort wsdlPort,
 WebServiceFeatureList features)

getWsdlService

public WSDLService getWsdlService()