javax.xml.ws
Class Service

java.lang.Object
  javax.xml.ws.Service

public class Service
extends Object

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 javax.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 a HandlerResolver.

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

See Also:

Provider, HandlerResolver, Executor

Nested Class Summary

static class

Service.Mode The orientation of a dynamic client or service.

Constructor Summary

protected

Service(URL wsdlDocumentLocation, QName serviceName)

Method Summary

void	addPort(QName portName, String bindingId, String endpointAddress) Creates a new port for the service.
static Service	create(QName serviceName) Create a Service instance.
static Service	create(URL wsdlDocumentLocation, QName serviceName) Create a Service instance.
<T> Dispatch<T>	createDispatch(QName portName, Class<T> type, Service.Mode mode) Creates a Dispatch instance for use with objects of the users choosing.
Dispatch<Object>	createDispatch(QName portName, JAXBContext context, Service.Mode mode) Creates a Dispatch instance for use with JAXB generated objects.
Executor	getExecutor() Returns the executor for this Serviceinstance.
HandlerResolver	getHandlerResolver() Returns the configured handler resolver.
<T> T	getPort(Class<T> serviceEndpointInterface) The getPort method returns a stub.
<T> T	getPort(QName portName, Class<T> serviceEndpointInterface) The getPort method returns a stub.
Iterator<QName>	getPorts() Returns an Iterator for the list of QNames of service endpoints grouped by this service
QName	getServiceName() Gets the name of this service.
URL	getWSDLDocumentLocation() Gets the location of the WSDL document for this Service.
void	setExecutor(Executor executor) Sets the executor for this Service instance.
void	setHandlerResolver(HandlerResolver handlerResolver) Sets the HandlerResolver for this Service instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Service

protected Service(URL wsdlDocumentLocation,
                  QName serviceName)

Method Detail

getPort

public <T> T getPort(QName portName,
                     Class<T> serviceEndpointInterface)

The getPort method returns a stub. A service client uses this stub to invoke operations on the target service endpoint. The serviceEndpointInterface specifies the service endpoint interface that is supported by the created dynamic proxy or stub instance.

Parameters:

portName - Qualified name of the service endpoint in the WSDL service description

serviceEndpointInterface - Service endpoint interface supported by the dynamic proxy or stub instance

Returns:

Object Proxy instance that supports the specified service endpoint interface

Throws:

WebServiceException - This exception is thrown in the following cases:

• If there is an error in creation of the proxy
• If there is any missing WSDL metadata as required by this method
• Optionally, if an illegal serviceEndpointInterface or portName is specified

See Also:

Proxy, InvocationHandler

getPort

public <T> T getPort(Class<T> serviceEndpointInterface)

The getPort method returns a stub. The parameter serviceEndpointInterface specifies the service endpoint interface that is supported by the returned proxy. In the implementation of this method, the JAX-WS runtime system takes the responsibility of selecting a protocol binding (and a port) and configuring the proxy accordingly. The returned proxy should not be reconfigured by the client.

Parameters:

serviceEndpointInterface - Service endpoint interface

Returns:

Object instance that supports the specified service endpoint interface

Throws:

WebServiceException -

• If there is an error during creation of the proxy
• If there is any missing WSDL metadata as required by this method
• Optionally, if an illegal serviceEndpointInterface is specified

addPort

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

Creates a new port for the service. Ports created in this way contain no WSDL port type information and can only be used for creating Dispatchinstances.

Parameters:

portName - Qualified name for the target service endpoint

bindingId - A String identifier of a binding.

endpointAddress - Address of the target service endpoint as a URI

Throws:

WebServiceException - If any error in the creation of the port

See Also:

SOAPBinding.SOAP11HTTP_BINDING, SOAPBinding.SOAP12HTTP_BINDING, HTTPBinding.HTTP_BINDING

createDispatch

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

Creates a Dispatch instance for use with objects of the users choosing.

Parameters:

portName - Qualified name for the target service endpoint

type - The class of object used to messages or message payloads. Implementations are required to support javax.xml.transform.Source, javax.xml.soap.SOAPMessage and javax.activation.DataSource, depending on the binding in use.

mode - Controls whether the created dispatch instance is message or payload oriented, i.e. whether the user will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the user will work with SOAP messages or the contents of a SOAP body. Mode must be MESSAGE when type is SOAPMessage.

Returns:

Dispatch instance

Throws:

WebServiceException - If any error in the creation of the Dispatch object

See Also:

Source, SOAPMessage

createDispatch

public Dispatch<Object> createDispatch(QName portName,
                                       JAXBContext context,
                                       Service.Mode mode)

Creates a Dispatch instance for use with JAXB generated objects.

Parameters:

portName - Qualified name for the target service endpoint

context - The JAXB context used to marshall and unmarshall messages or message payloads.

mode - Controls whether the created dispatch instance is message or payload oriented, i.e. whether the user will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the user will work with SOAP messages or the contents of a SOAP body.

Returns:

Dispatch instance

Throws:

ServiceException - If any error in the creation of the Dispatch object

See Also:

JAXBContext

getServiceName

public QName getServiceName()

Gets the name of this service.

Returns:

Qualified name of this service

getPorts

public Iterator<QName> getPorts()

Returns an Iterator for the list of QNames of service endpoints grouped by this service

Returns:

Returns java.util.Iterator with elements of type javax.xml.namespace.QName

Throws:

WebServiceException - If this Service class does not have access to the required WSDL metadata

getWSDLDocumentLocation

public URL getWSDLDocumentLocation()

Gets the location of the WSDL document for this Service.

Returns:

URL for the location of the WSDL document for this service

getHandlerResolver

public HandlerResolver getHandlerResolver()

Returns the configured handler resolver.

Returns:

HandlerResolver The HandlerResolver being used by this Service instance, or null if there isn't one.

setHandlerResolver

public void setHandlerResolver(HandlerResolver handlerResolver)

Sets the HandlerResolver for this Service instance.

The handler resolver, if present, will be called once for each proxy or dispatch instance that is created, and the handler chain returned by the resolver will be set on the instance.

Parameters:

handlerResolver - The HandlerResolver to use for all subsequently created proxy/dispatch objects.

See Also:

HandlerResolver

getExecutor

public Executor getExecutor()

Returns the executor for this Serviceinstance. The executor is used for all asynchronous invocations that require callbacks.

Returns:

The java.util.concurrent.Executor to be used to invoke a callback.

See Also:

Executor

setExecutor

public void setExecutor(Executor executor)

Sets the executor for this Service instance. The executor is used for all asynchronous invocations that require callbacks.

Parameters:

executor - The java.util.concurrent.Executor to be used to invoke a callback.

Throws:

SecurityException - If the instance does not support setting an executor for security reasons (e.g. the necessary permissions are missing).

See Also:

Executor

create

public static Service create(URL wsdlDocumentLocation,
                             QName serviceName)

Create a Service instance. The specified WSDL document location and service qualified name must uniquely identify a wsdl:service element.

Parameters:

wsdlDocumentLocation - URL for the WSDL document location for the service

serviceName - QName for the service

Throws:

WebServiceException - If any error in creation of the specified service

create

public static Service create(QName serviceName)

Create a Service instance.

Parameters:

serviceName - QName for the service

Throws:

WebServiceException - If any error in creation of the specified service