Service (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

javax.xml.ws
class Service

java.lang.Object extended by

javax.xml.ws.Service

Most common way to construct:

QName serviceName = …;

Service service = Service.create(serviceName);

Based on 26 examples

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 {@link 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.

Nested Class Summary
`static enum`	`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)` Creates a `Service` instance.
`static Service`	`create(URL wsdlDocumentLocation, QName serviceName)` Creates a `Service` instance.
`Dispatch`	`createDispatch(EndpointReference endpointReference, Class type, Service.Mode mode, WebServiceFeature[] features)` Creates a `Dispatch` instance for use with objects of the user's choosing.
`Dispatch`	`createDispatch(EndpointReference endpointReference, JAXBContext context, Service.Mode mode, WebServiceFeature[] features)` Creates a `Dispatch` instance for use with JAXB generated objects.
`Dispatch`	`createDispatch(QName portName, Class type, Service.Mode mode)` Creates a `Dispatch` instance for use with objects of the user's choosing.
`Dispatch`	`createDispatch(QName portName, Class type, Service.Mode mode, WebServiceFeature[] features)` Creates a `Dispatch` instance for use with objects of the user's choosing.
`Dispatch`	`createDispatch(QName portName, JAXBContext context, Service.Mode mode)` Creates a `Dispatch` instance for use with JAXB generated objects.
`Dispatch`	`createDispatch(QName portName, JAXBContext context, Service.Mode mode, WebServiceFeature[] features)` Creates a `Dispatch` instance for use with JAXB generated objects.
`Executor`	`getExecutor()` Returns the executor for this `Service`instance.
`HandlerResolver`	`getHandlerResolver()` Returns the configured handler resolver.
`Object`	`getPort(Class serviceEndpointInterface)` The `getPort` method returns a proxy.
`Object`	`getPort(Class serviceEndpointInterface, WebServiceFeature[] features)` The `getPort` method returns a proxy.
`Object`	`getPort(EndpointReference endpointReference, Class serviceEndpointInterface, WebServiceFeature[] features)` The `getPort` method returns a proxy.
`Object`	`getPort(QName portName, Class serviceEndpointInterface)` The `getPort` method returns a proxy.
`Object`	`getPort(QName portName, Class serviceEndpointInterface, WebServiceFeature[] features)` The `getPort` method returns a proxy.
`Iterator`	`getPorts()` Returns an `Iterator` for the list of `QName`s 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)

Parameters:: wsdlDocumentLocation; serviceName

Method Detail

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.

create

public static Service create(QName serviceName)

Creates a Service instance.

Parameters:: serviceName - QName for the service

create

public static Service create(URL wsdlDocumentLocation,
                             QName serviceName)

Creates 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

createDispatch

public Dispatch createDispatch(EndpointReference endpointReference,
                               Class type,
                               Service.Mode mode,
                               WebServiceFeature[] features)

Creates a Dispatch instance for use with objects of the user's choosing. If there are any reference parameters in the endpointReference, then those reference parameters MUST appear as SOAP headers, indicating them to be reference parameters, on all messages sent to the endpoint. The endpointReference's address MUST be used for invocations on the endpoint. 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 dispatch accordingly from the WSDL associated with this Service instance or from the metadata from the endpointReference. If this Service instance has a WSDL and the endpointReference also has a WSDL in its metadata, then the WSDL from this instance MUST be used. If this Service instance does not have a WSDL and the endpointReference does have a WSDL, then the WSDL from the endpointReference MAY be used. An implementation MUST be able to retrieve the portName from the endpointReference metadata.

This method behaves the same as calling

 dispatch = service.createDispatch(portName, type, mode, features);

where the portName is retrieved from the WSDL or EndpointReference metadata.

Parameters:: endpointReference - The EndpointReference for the target service endpoint that will be invoked by the returned Dispatch object.; type - The class of object used to messages or message payloads. Implementations are required to support javax.xml.transform.Source and javax.xml.soap.SOAPMessage.; 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.; features - An array of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.
Returns:: Dispatch instance

createDispatch

public Dispatch createDispatch(EndpointReference endpointReference,
                               JAXBContext context,
                               Service.Mode mode,
                               WebServiceFeature[] features)

Creates a Dispatch instance for use with JAXB generated objects. If there are any reference parameters in the endpointReference, then those reference parameters MUST appear as SOAP headers, indicating them to be reference parameters, on all messages sent to the endpoint. The endpointReference's address MUST be used for invocations on the endpoint. 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 dispatch accordingly from the WSDL associated with this Service instance or from the metadata from the endpointReference. If this Service instance has a WSDL and the endpointReference also has a WSDL in its metadata, then the WSDL from this instance MUST be used. If this Service instance does not have a WSDL and the endpointReference does have a WSDL, then the WSDL from the endpointReference MAY be used. An implementation MUST be able to retrieve the portName from the endpointReference metadata.

This method behavies the same as calling

 dispatch = service.createDispatch(portName, context, mode, features);

where the portName is retrieved from the WSDL or endpointReference metadata.

Parameters:: endpointReference - The EndpointReference for the target service endpoint that will be invoked by the returned Dispatch object.; 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.; features - An array of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.
Returns:: Dispatch instance

createDispatch

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

Creates a Dispatch instance for use with objects of the user's choosing.

Parameters:: portName - Qualified name for the target service endpoint; type - The class of object used for 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.

createDispatch

public Dispatch createDispatch(QName portName,
                               Class type,
                               Service.Mode mode,
                               WebServiceFeature[] features)

Creates a Dispatch instance for use with objects of the user's choosing.

Parameters:: portName - Qualified name for the target service endpoint; type - The class of object used for messages or message payloads. Implementations are required to support javax.xml.transform.Source and javax.xml.soap.SOAPMessage.; 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.; features - A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.
Returns:: Dispatch instance.

createDispatch

public Dispatch 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.

createDispatch

public Dispatch createDispatch(QName portName,
                               JAXBContext context,
                               Service.Mode mode,
                               WebServiceFeature[] features)

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.; features - A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.
Returns:: Dispatch instance.

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.

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.

getPort

public Object getPort(Class serviceEndpointInterface)

The getPort method returns a proxy. 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.

getPort

public Object getPort(Class serviceEndpointInterface,
                      WebServiceFeature[] features)

Parameters:: serviceEndpointInterface - Service endpoint interface.; features - A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.
Returns:: Object instance that supports the specified service endpoint interface.

getPort

public Object getPort(EndpointReference endpointReference,
                      Class serviceEndpointInterface,
                      WebServiceFeature[] features)

The getPort method returns a proxy. The parameter endpointReference specifies the endpoint that will be invoked by the returned proxy. If there are any reference parameters in the endpointReference, then those reference parameters MUST appear as SOAP headers, indicating them to be reference parameters, on all messages sent to the endpoint. The endpointReference's address MUST be used for invocations on the endpoint. 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 from the WSDL associated with this Service instance or from the metadata from the endpointReference. If this Service instance has a WSDL and the endpointReference metadata also has a WSDL, then the WSDL from this instance MUST be used. If this Service instance does not have a WSDL and the endpointReference does have a WSDL, then the WSDL from the endpointReference MAY be used. The returned proxy should not be reconfigured by the client. If this Service instance has a known proxy port that matches the information contained in the WSDL, then that proxy is returned, otherwise a WebServiceException is thrown.

Calling this method has the same behavior as the following

 port = service.getPort(portName, serviceEndpointInterface);

where the portName is retrieved from the metadata of the endpointReference or from the serviceEndpointInterface and the WSDL associated with this Service instance.

Parameters:: endpointReference - The EndpointReference for the target service endpoint that will be invoked by the returned proxy.; serviceEndpointInterface - Service endpoint interface.; features - A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.
Returns:: Object Proxy instance that supports the specified service endpoint interface.

getPort

public Object getPort(QName portName,
                      Class serviceEndpointInterface)

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

Parameters:: portName - Qualified name of the service endpoint in the WSDL service description.; serviceEndpointInterface - Service endpoint interface supported by the dynamic proxy instance.
Returns:: Object Proxy instance that supports the specified service endpoint interface.

getPort

public Object getPort(QName portName,
                      Class serviceEndpointInterface,
                      WebServiceFeature[] features)

Parameters:: portName - Qualified name of the service endpoint in the WSDL service description.; serviceEndpointInterface - Service endpoint interface supported by the dynamic proxy instance.; features - A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.
Returns:: Object Proxy instance that supports the specified service endpoint interface.

getPorts

public Iterator 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.

getServiceName

public QName getServiceName()

Gets the name of this service.

Returns:: Qualified name of this service

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.

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.

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.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:

The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.

javax.xml.wsclass Service

Service

addPort

create

create

createDispatch

createDispatch

createDispatch

createDispatch

createDispatch

createDispatch

getExecutor

getHandlerResolver

getPort

getPort

getPort

getPort

getPort

getPorts

getServiceName

getWSDLDocumentLocation

setExecutor

setHandlerResolver

javax.xml.ws
class Service