javax.xml.ws: public class: Service

javax.xml.ws
public class: Service [javadoc | source]

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

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.

Also see:

javax.xml.ws.spi.Provider

javax.xml.ws.handler.HandlerResolver

java.util.concurrent.Executor

since: JAX-WS - 2.0

Nested Class Summary:
public enum class	Service.Mode	The orientation of a dynamic client or service. MESSAGE provides access to entire protocol message, PAYLOAD to protocol message payload only.

Constructor:
protected Service(URL wsdlDocumentLocation, QName serviceName) { delegate = Provider.provider().createServiceDelegate(wsdlDocumentLocation, serviceName, this.getClass()); }

Constructor:

 protected Service(URL wsdlDocumentLocation,
    QName serviceName) {
      delegate = Provider.provider().createServiceDelegate(wsdlDocumentLocation,
                                                           serviceName,
                                                           this.getClass());
}

Method from javax.xml.ws.Service Summary:
addPort, create, create, createDispatch, createDispatch, getExecutor, getHandlerResolver, getPort, getPort, getPorts, getServiceName, getWSDLDocumentLocation, setExecutor, setHandlerResolver

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.xml.ws.Service Detail:
public void addPort(QName portName, String bindingId, String endpointAddress) { delegate.addPort(portName, bindingId, 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 `Dispatch`instances.
public static Service create(QName serviceName) { return new Service(null, serviceName); } Create a `Service` instance.
public static Service create(URL wsdlDocumentLocation, QName serviceName) { return new Service(wsdlDocumentLocation, serviceName); } Create a `Service` instance. The specified WSDL document location and service qualified name must uniquely identify a `wsdl:service` element.
public Dispatch createDispatch(QName portName, Class type, Service.Mode mode) { return delegate.createDispatch(portName, type, mode); } Creates a `Dispatch` instance for use with objects of the users choosing.
public Dispatch createDispatch(QName portName, JAXBContext context, Service.Mode mode) { return delegate.createDispatch(portName, context, mode); } Creates a `Dispatch` instance for use with JAXB generated objects.
public Executor getExecutor() { return delegate.getExecutor(); } Returns the executor for this `Service`instance. The executor is used for all asynchronous invocations that require callbacks.
public HandlerResolver getHandlerResolver() { return delegate.getHandlerResolver(); } Returns the configured handler resolver.
public T getPort(Class serviceEndpointInterface) { return delegate.getPort(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.
public T getPort(QName portName, Class serviceEndpointInterface) { return delegate.getPort(portName, 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.
public Iterator getPorts() { return delegate.getPorts(); } Returns an `Iterator` for the list of `QName`s of service endpoints grouped by this service
public QName getServiceName() { return delegate.getServiceName(); } Gets the name of this service.
public URL getWSDLDocumentLocation() { return delegate.getWSDLDocumentLocation(); } Gets the location of the WSDL document for this Service.
public void setExecutor(Executor executor) { delegate.setExecutor(executor); } Sets the executor for this `Service` instance. The executor is used for all asynchronous invocations that require callbacks.
public void setHandlerResolver(HandlerResolver handlerResolver) { delegate.setHandlerResolver(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.

Method from javax.xml.ws.Service Detail:

 public  void addPort(QName portName,
    String bindingId,
    String endpointAddress) {
      delegate.addPort(portName, bindingId, endpointAddress);
}

Dispatch

 public static Service create(QName serviceName) {
      return new Service(null, serviceName);
}

Service

 public static Service create(URL wsdlDocumentLocation,
    QName serviceName) {
      return new Service(wsdlDocumentLocation, serviceName);
}

Service

wsdl:service

 public Dispatch createDispatch(QName portName,
    Class type,
    Service.Mode mode) {
      return delegate.createDispatch(portName, type, mode);
}

Dispatch

 public Dispatch createDispatch(QName portName,
    JAXBContext context,
    Service.Mode mode) {
      return delegate.createDispatch(portName, context,  mode);
}

Dispatch

 public Executor getExecutor() {
       return delegate.getExecutor();
}

Service

 public HandlerResolver getHandlerResolver() {
        return delegate.getHandlerResolver();
}

Returns the configured handler resolver.

 public T getPort(Class serviceEndpointInterface) {
      return delegate.getPort(serviceEndpointInterface);
}

serviceEndpointInterface

 public T getPort(QName portName,
    Class serviceEndpointInterface) {
      return delegate.getPort(portName, serviceEndpointInterface);
}

serviceEndpointInterface

 public Iterator getPorts() {
      return delegate.getPorts();
}

Iterator

QName

 public QName getServiceName() {
      return delegate.getServiceName();
}

Gets the name of this service.

 public URL getWSDLDocumentLocation() {
      return delegate.getWSDLDocumentLocation();
}

Gets the location of the WSDL document for this Service.

 public  void setExecutor(Executor executor) {
       delegate.setExecutor(executor);
}

Service

 public  void setHandlerResolver(HandlerResolver handlerResolver) {
       delegate.setHandlerResolver(handlerResolver);
}

HandlerResolver

Service

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.