JAX-WS API 2.3.1 · javax.xml.ws.Service

Modifier and Type	Class and Description
public static enum	Service.Mode The orientation of a dynamic client or service.

Modifier and Type	Field and Description
private ServiceDelegate	delegate

Access	Constructor and Description
protected	Service(URL `URL` for the WSDL document location for the service wsdlDocumentLocation, QName `QName` for the service serviceName) Creates a `Service`.
protected	Service(URL `URL` for the WSDL document location for the service wsdlDocumentLocation, QName `QName` for the service serviceName, WebServiceFeature... Web Service features that must be configured on the service. If the provider doesn't understand a feature, it must throw a WebServiceException. features) Creates a `Service`.

Method Summary

Modifier and Type	Method and Description
public void	addPort(QName Qualified name for the target service endpoint. portName, String A String identifier of a binding. bindingId, String Address of the target service endpoint as a URI. endpointAddress) Creates a new port for the service.
public static Service	Returns: Service instance create(URL `URL` for the WSDL document location for the service wsdlDocumentLocation, QName `QName` for the service serviceName) Creates a `Service` instance.
public static Service	Returns: Service instance configured with requested web service features create(URL `URL` for the WSDL document location for the service wsdlDocumentLocation, QName `QName` for the service serviceName, WebServiceFeature... Web Service features that must be configured on the service. If the provider doesn't understand a feature, it must throw a WebServiceException. features) Creates a `Service` instance.
public static Service	Returns: Service instance create(QName `QName` for the service serviceName) Creates a `Service` instance.
public static Service	Returns: Service instance configured with requested web service features create(QName `QName` for the service serviceName, WebServiceFeature... Web Service features that must be configured on the service. If the provider doesn't understand a feature, it must throw a WebServiceException. features) Creates a `Service` instance.
public < The type of the message or payload T> Dispatch<T>	Returns: Dispatch instance. createDispatch(QName Qualified name for the target service endpoint portName, Class<T> 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. type, Service.Mode Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE when type is SOAPMessage. mode) Creates a `Dispatch` instance for use with objects of the client's choosing.
public < The type of the message or payload T> Dispatch<T>	Returns: Dispatch instance. createDispatch(QName Qualified name for the target service endpoint portName, Class<T> The class of object used for messages or message payloads. Implementations are required to support `javax.xml.transform.Source` and `javax.xml.soap.SOAPMessage`. type, Service.Mode Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. Mode MUST be `MESSAGE` when type is `SOAPMessage`. mode, WebServiceFeature... A list of `WebServiceFeatures` to configure on the proxy. Supported features not in the `features` parameter will have their default values. features) Creates a `Dispatch` instance for use with objects of the client's choosing.
public < The type of the message or payload T> Dispatch<T>	Returns: Dispatch instance createDispatch(EndpointReference The `EndpointReference` for the target service endpoint that will be invoked by the returned `Dispatch` object. endpointReference, Class<T> The class of object used to messages or message payloads. Implementations are required to support `javax.xml.transform.Source` and `javax.xml.soap.SOAPMessage`. type, Service.Mode Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. Mode MUST be `MESSAGE` when type is `SOAPMessage`. mode, WebServiceFeature... An array of `WebServiceFeatures` to configure on the proxy. Supported features not in the `features` parameter will have their default values. features) Creates a `Dispatch` instance for use with objects of the client's choosing.
public Dispatch<Object>	Returns: Dispatch instance. createDispatch(QName Qualified name for the target service endpoint portName, JAXBContext The JAXB context used to marshall and unmarshall messages or message payloads. context, Service.Mode Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. mode) Creates a `Dispatch` instance for use with JAXB generated objects.
public Dispatch<Object>	Returns: Dispatch instance. createDispatch(QName Qualified name for the target service endpoint portName, JAXBContext The JAXB context used to marshall and unmarshall messages or message payloads. context, Service.Mode Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. mode, WebServiceFeature... A list of `WebServiceFeatures` to configure on the proxy. Supported features not in the `features` parameter will have their default values. features) Creates a `Dispatch` instance for use with JAXB generated objects.
public Dispatch<Object>	Returns: Dispatch instance createDispatch(EndpointReference The `EndpointReference` for the target service endpoint that will be invoked by the returned `Dispatch` object. endpointReference, JAXBContext The JAXB context used to marshall and unmarshall messages or message payloads. context, Service.Mode Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. mode, WebServiceFeature... An array of `WebServiceFeatures` to configure on the proxy. Supported features not in the `features` parameter will have their default values. features) Creates a `Dispatch` instance for use with JAXB generated objects.
public Executor	Returns: The `java.util.concurrent.Executor` to be used to invoke a callback. getExecutor() Returns the executor for this `Service`instance.
public HandlerResolver	Returns: HandlerResolver The `HandlerResolver` being used by this `Service` instance, or `null` if there isn't one. getHandlerResolver() Returns the configured handler resolver.
public < Service endpoint interface. T> T	Returns: Object Proxy instance that supports the specified service endpoint interface. getPort(QName Qualified name of the service endpoint in the WSDL service description. portName, Class<T> Service endpoint interface supported by the dynamic proxy instance. serviceEndpointInterface) The `getPort` method returns a proxy.
public < Service endpoint interface. T> T	Returns: Object Proxy instance that supports the specified service endpoint interface. getPort(QName Qualified name of the service endpoint in the WSDL service description. portName, Class<T> Service endpoint interface supported by the dynamic proxy instance. serviceEndpointInterface, WebServiceFeature... A list of WebServiceFeatures to configure on the proxy. Supported features not in the `features` parameter will have their default values. features) The `getPort` method returns a proxy.
public < Service endpoint interface. T> T	Returns: Object instance that supports the specified service endpoint interface. getPort(Class<T> Service endpoint interface. serviceEndpointInterface) The `getPort` method returns a proxy.
public < Service endpoint interface. T> T	Returns: Object instance that supports the specified service endpoint interface. getPort(Class<T> Service endpoint interface. serviceEndpointInterface, WebServiceFeature... A list of WebServiceFeatures to configure on the proxy. Supported features not in the `features` parameter will have their default values. features) The `getPort` method returns a proxy.
public < Service endpoint interface. T> T	Returns: Object Proxy instance that supports the specified service endpoint interface. getPort(EndpointReference The `EndpointReference` for the target service endpoint that will be invoked by the returned proxy. endpointReference, Class<T> Service endpoint interface. serviceEndpointInterface, WebServiceFeature... A list of `WebServiceFeatures` to configure on the proxy. Supported features not in the `features` parameter will have their default values. features) The `getPort` method returns a proxy.
public Iterator<QName>	Returns: Returns `java.util.Iterator` with elements of type `javax.xml.namespace.QName`. getPorts() Returns an `Iterator` for the list of `QName`s of service endpoints grouped by this service
public QName	Returns: Qualified name of this service getServiceName() Gets the name of this service.
public URL	Returns: URL for the location of the WSDL document for this service. getWSDLDocumentLocation() Gets the location of the WSDL document for this Service.
public void	setExecutor(Executor The `java.util.concurrent.Executor` to be used to invoke a callback. executor) Sets the executor for this `Service` instance.
public void	setHandlerResolver(HandlerResolver The `HandlerResolver` to use for all subsequently created proxy/dispatch objects. handlerResolver) Sets the `HandlerResolver` for this `Service` instance.

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

delegate	back to summary
private ServiceDelegate delegate

Service	back to summary
protected Service(URL wsdlDocumentLocation, QName serviceName) Creates a `Service`. The specified WSDL document location and service qualified name MUST uniquely identify a `wsdl:service` element. Parameters wsdlDocumentLocation:URL `URL` for the WSDL document location for the service serviceName:QName `QName` for the service

Service	back to summary
protected Service(URL wsdlDocumentLocation, QName serviceName, WebServiceFeature... features) Creates a `Service`. The created instance is configured with the web service features. The specified WSDL document location and service qualified name MUST uniquely identify a `wsdl:service` element. Parameters wsdlDocumentLocation:URL `URL` for the WSDL document location for the service serviceName:QName `QName` for the service features:WebServiceFeature[] Web Service features that must be configured on the service. If the provider doesn't understand a feature, it must throw a WebServiceException.

Method Detail

addPort back to summary

addPort	back to summary
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 `Dispatch`instances. Parameters portName:QName Qualified name for the target service endpoint. bindingId:String A String identifier of a binding. endpointAddress:String Address of the target service endpoint as a URI. Exceptions WebServiceException: If any error in the creation of the port. See Also `javax.xml.ws.soap.SOAPBinding#SOAP11HTTP_BINDING`, `javax.xml.ws.soap.SOAPBinding#SOAP12HTTP_BINDING`, `javax.xml.ws.http.HTTPBinding#HTTP_BINDING`

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:QName: Qualified name for the target service endpoint.
bindingId:String: A String identifier of a binding.
endpointAddress:String: Address of the target service endpoint as a URI.

Exceptions

WebServiceException:: If any error in the creation of the port.

create back to summary

create	back to summary
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 `URL` for the WSDL document location for the service serviceName:QName `QName` for the service Returns:Service Service instance Exceptions WebServiceException: If any error in creation of the specified service.

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: URL for the WSDL document location for the service
serviceName:QName: QName for the service

Returns:Service

Service instance

Exceptions

WebServiceException:: If any error in creation of the specified service.

create back to summary

create	back to summary
public static Service create(URL wsdlDocumentLocation, QName serviceName, WebServiceFeature... features) Creates a `Service` instance. The created instance is configured with the web service features. The specified WSDL document location and service qualified name MUST uniquely identify a `wsdl:service` element. Parameters wsdlDocumentLocation:URL `URL` for the WSDL document location for the service serviceName:QName `QName` for the service features:WebServiceFeature[] Web Service features that must be configured on the service. If the provider doesn't understand a feature, it must throw a WebServiceException. Returns:Service Service instance configured with requested web service features Exceptions WebServiceException: If any error in creation of the specified service. Since 1.7, JAX-WS 2.2

public static Service create(URL wsdlDocumentLocation, QName serviceName, WebServiceFeature... features)

Creates a Service instance. The created instance is configured with the web service features. The specified WSDL document location and service qualified name MUST uniquely identify a wsdl:service element.

Parameters

wsdlDocumentLocation:URL: URL for the WSDL document location for the service
serviceName:QName: QName for the service
features:WebServiceFeature[]: Web Service features that must be configured on the service. If the provider doesn't understand a feature, it must throw a WebServiceException.

Returns:Service

Service instance configured with requested web service features

Exceptions

WebServiceException:: If any error in creation of the specified service.

Since

1.7, JAX-WS 2.2

create back to summary

create	back to summary
public static Service create(QName serviceName) Creates a `Service` instance. Parameters serviceName:QName `QName` for the service Returns:Service Service instance Exceptions WebServiceException: If any error in creation of the specified service

public static Service create(QName serviceName)

Creates a Service instance.

Parameters

serviceName:QName: QName for the service

Returns:Service

Service instance

Exceptions

WebServiceException:: If any error in creation of the specified service

create back to summary

create	back to summary
public static Service create(QName serviceName, WebServiceFeature... features) Creates a `Service` instance. The created instance is configured with the web service features. Parameters serviceName:QName `QName` for the service features:WebServiceFeature[] Web Service features that must be configured on the service. If the provider doesn't understand a feature, it must throw a WebServiceException. Returns:Service Service instance configured with requested web service features Exceptions WebServiceException: If any error in creation of the specified service Since 1.7, JAX-WS 2.2

public static Service create(QName serviceName, WebServiceFeature... features)

Creates a Service instance. The created instance is configured with the web service features.

Parameters

serviceName:QName: QName for the service
features:WebServiceFeature[]: Web Service features that must be configured on the service. If the provider doesn't understand a feature, it must throw a WebServiceException.

Returns:Service

Service instance configured with requested web service features

Exceptions

WebServiceException:: If any error in creation of the specified service

Since

1.7, JAX-WS 2.2

createDispatch back to summary

createDispatch	back to summary
public <T> Dispatch<T> createDispatch(QName portName, Class<T> type, Service.Mode mode) Creates a `Dispatch` instance for use with objects of the client's choosing. Parameters <T> The type of the message or payload portName:QName Qualified name for the target service endpoint type:Class<T> 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:Service.Mode Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE when type is SOAPMessage. Returns:Dispatch<T> Dispatch instance. Exceptions WebServiceException: If any error in the creation of the `Dispatch` object. See Also `javax.xml.transform.Source`, `javax.xml.soap.SOAPMessage`

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

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

Parameters

<T>: The type of the message or payload
portName:QName: Qualified name for the target service endpoint
type:Class<T>: 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:Service.Mode: Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE when type is SOAPMessage.

Returns:Dispatch<T>

Dispatch instance.

Exceptions

WebServiceException:: If any error in the creation of the Dispatch object.

createDispatch back to summary

createDispatch	back to summary
public <T> Dispatch<T> createDispatch(QName portName, Class<T> type, Service.Mode mode, WebServiceFeature... features) Creates a `Dispatch` instance for use with objects of the client's choosing. Parameters <T> The type of the message or payload portName:QName Qualified name for the target service endpoint type:Class<T> 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:Service.Mode Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. Mode MUST be `MESSAGE` when type is `SOAPMessage`. features:WebServiceFeature[] A list of `WebServiceFeatures` to configure on the proxy. Supported features not in the `features` parameter will have their default values. Returns:Dispatch<T> Dispatch instance. Exceptions WebServiceException: If any error in the creation of the `Dispatch` object or if a feature is enabled that is not compatible with this port or is unsupported. Since 1.6, JAX-WS 2.1 See Also `javax.xml.transform.Source`, `javax.xml.soap.SOAPMessage`, `WebServiceFeature`

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

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

Parameters

<T>: The type of the message or payload
portName:QName: Qualified name for the target service endpoint
type:Class<T>: 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:Service.Mode: Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE when type is SOAPMessage.
features:WebServiceFeature[]: A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.

Returns:Dispatch<T>

Dispatch instance.

Exceptions

WebServiceException:: If any error in the creation of the Dispatch object or if a feature is enabled that is not compatible with this port or is unsupported.

Since

1.6, JAX-WS 2.1

createDispatch back to summary

createDispatch	back to summary
public <T> Dispatch<T> createDispatch(EndpointReference endpointReference, Class<T> type, Service.Mode mode, WebServiceFeature... features) Creates a `Dispatch` instance for use with objects of the client'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 <T> The type of the message or payload endpointReference:EndpointReference The `EndpointReference` for the target service endpoint that will be invoked by the returned `Dispatch` object. type:Class<T> 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:Service.Mode Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. Mode MUST be `MESSAGE` when type is `SOAPMessage`. features:WebServiceFeature[] An array of `WebServiceFeatures` to configure on the proxy. Supported features not in the `features` parameter will have their default values. Returns:Dispatch<T> Dispatch instance Exceptions WebServiceException: If there is any missing WSDL metadata as required by this method. If the `endpointReference` metadata does not match the `serviceName` or `portName` of a WSDL associated with this `Service` instance. If the `portName` cannot be determined from the `EndpointReference` metadata. If any error in the creation of the `Dispatch` object. If a feature is enabled that is not compatible with this port or is unsupported. Since 1.6, JAX-WS 2.1 See Also `javax.xml.transform.Source`, `javax.xml.soap.SOAPMessage`, `WebServiceFeature`

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

Creates a Dispatch instance for use with objects of the client'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

<T>: The type of the message or payload
endpointReference:EndpointReference: The EndpointReference for the target service endpoint that will be invoked by the returned Dispatch object.
type:Class<T>: 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:Service.Mode: Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE when type is SOAPMessage.
features:WebServiceFeature[]: An array of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.

Returns:Dispatch<T>

Dispatch instance

Exceptions

WebServiceException:

If there is any missing WSDL metadata as required by this method.
If the endpointReference metadata does not match the serviceName or portName of a WSDL associated with this Service instance.
If the portName cannot be determined from the EndpointReference metadata.
If any error in the creation of the Dispatch object.
If a feature is enabled that is not compatible with this port or is unsupported.

Since

1.6, JAX-WS 2.1

createDispatch back to summary

createDispatch	back to summary
public Dispatch<Object> createDispatch(QName portName, JAXBContext context, Service.Mode mode) Creates a `Dispatch` instance for use with JAXB generated objects. Parameters portName:QName Qualified name for the target service endpoint context:JAXBContext The JAXB context used to marshall and unmarshall messages or message payloads. mode:Service.Mode Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. Returns:Dispatch<Object> Dispatch instance. Exceptions WebServiceException: If any error in the creation of the `Dispatch` object. See Also `javax.xml.bind.JAXBContext`

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

Creates a Dispatch instance for use with JAXB generated objects.

Parameters

portName:QName: Qualified name for the target service endpoint
context:JAXBContext: The JAXB context used to marshall and unmarshall messages or message payloads.
mode:Service.Mode: Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body.

Returns:Dispatch<Object>

Dispatch instance.

Exceptions

WebServiceException:: If any error in the creation of the Dispatch object.

See Also

javax.xml.bind.JAXBContext

createDispatch back to summary

createDispatch	back to summary
public Dispatch<Object> createDispatch(QName portName, JAXBContext context, Service.Mode mode, WebServiceFeature... features) Creates a `Dispatch` instance for use with JAXB generated objects. Parameters portName:QName Qualified name for the target service endpoint context:JAXBContext The JAXB context used to marshall and unmarshall messages or message payloads. mode:Service.Mode Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. features:WebServiceFeature[] A list of `WebServiceFeatures` to configure on the proxy. Supported features not in the `features` parameter will have their default values. Returns:Dispatch<Object> Dispatch instance. Exceptions WebServiceException: If any error in the creation of the `Dispatch` object or if a feature is enabled that is not compatible with this port or is unsupported. Since 1.6, JAX-WS 2.1 See Also `javax.xml.bind.JAXBContext`, `WebServiceFeature`

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

Creates a Dispatch instance for use with JAXB generated objects.

Parameters

portName:QName: Qualified name for the target service endpoint
context:JAXBContext: The JAXB context used to marshall and unmarshall messages or message payloads.
mode:Service.Mode: Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body.
features:WebServiceFeature[]: A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.

Returns:Dispatch<Object>

Dispatch instance.

Exceptions

WebServiceException:: If any error in the creation of the Dispatch object or if a feature is enabled that is not compatible with this port or is unsupported.

Since

1.6, JAX-WS 2.1

createDispatch back to summary

createDispatch	back to summary
public Dispatch<Object> 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:EndpointReference The `EndpointReference` for the target service endpoint that will be invoked by the returned `Dispatch` object. context:JAXBContext The JAXB context used to marshall and unmarshall messages or message payloads. mode:Service.Mode Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. features:WebServiceFeature[] An array of `WebServiceFeatures` to configure on the proxy. Supported features not in the `features` parameter will have their default values. Returns:Dispatch<Object> Dispatch instance Exceptions WebServiceException: If there is any missing WSDL metadata as required by this method. If the `endpointReference` metadata does not match the `serviceName` or `portName` of a WSDL associated with this `Service` instance. If the `portName` cannot be determined from the `EndpointReference` metadata. If any error in the creation of the `Dispatch` object. if a feature is enabled that is not compatible with this port or is unsupported. Since 1.6, JAX-WS 2.1 See Also `javax.xml.bind.JAXBContext`, `WebServiceFeature`

public Dispatch<Object> 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:EndpointReference: The EndpointReference for the target service endpoint that will be invoked by the returned Dispatch object.
context:JAXBContext: The JAXB context used to marshall and unmarshall messages or message payloads.
mode:Service.Mode: Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body.
features:WebServiceFeature[]: An array of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.

Returns:Dispatch<Object>

Dispatch instance

Exceptions

WebServiceException:

If there is any missing WSDL metadata as required by this method.
If the endpointReference metadata does not match the serviceName or portName of a WSDL associated with this Service instance.
If the portName cannot be determined from the EndpointReference metadata.
If any error in the creation of the Dispatch object.
if a feature is enabled that is not compatible with this port or is unsupported.

Since

1.6, JAX-WS 2.1

getExecutor back to summary

getExecutor	back to summary
public Executor getExecutor() Returns the executor for this `Service`instance. The executor is used for all asynchronous invocations that require callbacks. Returns:Executor The `java.util.concurrent.Executor` to be used to invoke a callback. See Also `java.util.concurrent.Executor`

public Executor getExecutor()

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

Returns:Executor: The java.util.concurrent.Executor to be used to invoke a callback.
See Also: java.util.concurrent.Executor

getHandlerResolver back to summary

getHandlerResolver	back to summary
public HandlerResolver getHandlerResolver() Returns the configured handler resolver. Returns:HandlerResolver HandlerResolver The `HandlerResolver` being used by this `Service` instance, or `null` if there isn't one.

public HandlerResolver getHandlerResolver()

Returns the configured handler resolver.

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

getPort back to summary

getPort	back to summary
public <T> T getPort(QName portName, Class<T> 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 <T> Service endpoint interface. portName:QName Qualified name of the service endpoint in the WSDL service description. serviceEndpointInterface:Class<T> Service endpoint interface supported by the dynamic proxy instance. Returns:T Object Proxy instance that supports the specified service endpoint interface. Exceptions 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. If an illegal `serviceEndpointInterface` or `portName` is specified. See Also `java.lang.reflect.Proxy`, `java.lang.reflect.InvocationHandler`

public <T> T getPort(QName portName, Class<T> 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

<T>: Service endpoint interface.
portName:QName: Qualified name of the service endpoint in the WSDL service description.
serviceEndpointInterface:Class<T>: Service endpoint interface supported by the dynamic proxy instance.

Returns:T

Object Proxy instance that supports the specified service endpoint interface.

Exceptions

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.
If an illegal serviceEndpointInterface or portName is specified.

getPort back to summary

getPort	back to summary
public <T> T getPort(QName portName, Class<T> serviceEndpointInterface, WebServiceFeature... features) 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 <T> Service endpoint interface. portName:QName Qualified name of the service endpoint in the WSDL service description. serviceEndpointInterface:Class<T> Service endpoint interface supported by the dynamic proxy instance. features:WebServiceFeature[] A list of WebServiceFeatures to configure on the proxy. Supported features not in the `features` parameter will have their default values. Returns:T Object Proxy instance that supports the specified service endpoint interface. Exceptions 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. If an illegal `serviceEndpointInterface` or `portName` is specified. If a feature is enabled that is not compatible with this port or is unsupported. Since 1.6, JAX-WS 2.1 See Also `java.lang.reflect.Proxy`, `java.lang.reflect.InvocationHandler`, `WebServiceFeature`

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

Parameters

<T>: Service endpoint interface.
portName:QName: Qualified name of the service endpoint in the WSDL service description.
serviceEndpointInterface:Class<T>: Service endpoint interface supported by the dynamic proxy instance.
features:WebServiceFeature[]: A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.

Returns:T

Object Proxy instance that supports the specified service endpoint interface.

Exceptions

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.
If an illegal serviceEndpointInterface or portName is specified.
If a feature is enabled that is not compatible with this port or is unsupported.

Since

1.6, JAX-WS 2.1

getPort back to summary

getPort	back to summary
public <T> T getPort(Class<T> 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 <T> Service endpoint interface. serviceEndpointInterface:Class<T> Service endpoint interface. Returns:T Object instance that supports the specified service endpoint interface. Exceptions WebServiceException: If there is an error during creation of the proxy. If there is any missing WSDL metadata as required by this method. If an illegal `serviceEndpointInterface` is specified.

public <T> T getPort(Class<T> 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

<T>: Service endpoint interface.
serviceEndpointInterface:Class<T>: Service endpoint interface.

Returns:T

Object instance that supports the specified service endpoint interface.

Exceptions

WebServiceException:

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

getPort back to summary

getPort	back to summary
public <T> T getPort(Class<T> serviceEndpointInterface, WebServiceFeature... features) 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 <T> Service endpoint interface. serviceEndpointInterface:Class<T> Service endpoint interface. features:WebServiceFeature[] A list of WebServiceFeatures to configure on the proxy. Supported features not in the `features` parameter will have their default values. Returns:T Object instance that supports the specified service endpoint interface. Exceptions WebServiceException: If there is an error during creation of the proxy. If there is any missing WSDL metadata as required by this method. If an illegal `serviceEndpointInterface` is specified. If a feature is enabled that is not compatible with this port or is unsupported. Since 1.6, JAX-WS 2.1 See Also `WebServiceFeature`

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

Parameters

<T>: Service endpoint interface.
serviceEndpointInterface:Class<T>: Service endpoint interface.
features:WebServiceFeature[]: A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.

Returns:T

Object instance that supports the specified service endpoint interface.

Exceptions

WebServiceException:

If there is an error during creation of the proxy.
If there is any missing WSDL metadata as required by this method.
If an illegal serviceEndpointInterface is specified.
If a feature is enabled that is not compatible with this port or is unsupported.

Since

1.6, JAX-WS 2.1

See Also

WebServiceFeature

getPort back to summary

getPort	back to summary
public <T> T getPort(EndpointReference endpointReference, Class<T> 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 <T> Service endpoint interface. endpointReference:EndpointReference The `EndpointReference` for the target service endpoint that will be invoked by the returned proxy. serviceEndpointInterface:Class<T> Service endpoint interface. features:WebServiceFeature[] A list of `WebServiceFeatures` to configure on the proxy. Supported features not in the `features` parameter will have their default values. Returns:T Object Proxy instance that supports the specified service endpoint interface. Exceptions WebServiceException: If there is an error during creation of the proxy. If there is any missing WSDL metadata as required by this method. If the `endpointReference` metadata does not match the `serviceName` of this `Service` instance. If a `portName` cannot be extracted from the WSDL or `endpointReference` metadata. If an invalid `endpointReference` is specified. If an invalid `serviceEndpointInterface` is specified. If a feature is enabled that is not compatible with this port or is unsupported. Since 1.6, JAX-WS 2.1

public <T> T getPort(EndpointReference endpointReference, Class<T> 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

<T>: Service endpoint interface.
endpointReference:EndpointReference: The EndpointReference for the target service endpoint that will be invoked by the returned proxy.
serviceEndpointInterface:Class<T>: Service endpoint interface.
features:WebServiceFeature[]: A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.

Returns:T

Object Proxy instance that supports the specified service endpoint interface.

Exceptions

WebServiceException:

If there is an error during creation of the proxy.
If there is any missing WSDL metadata as required by this method.
If the endpointReference metadata does not match the serviceName of this Service instance.
If a portName cannot be extracted from the WSDL or endpointReference metadata.
If an invalid endpointReference is specified.
If an invalid serviceEndpointInterface is specified.
If a feature is enabled that is not compatible with this port or is unsupported.

Since

1.6, JAX-WS 2.1

getPorts back to summary

getPorts	back to summary
public Iterator<QName> getPorts() Returns an `Iterator` for the list of `QName`s of service endpoints grouped by this service Returns:Iterator<QName> Returns `java.util.Iterator` with elements of type `javax.xml.namespace.QName`. Exceptions WebServiceException: If this Service class does not have access to the required WSDL metadata.

public Iterator<QName> getPorts()

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

Returns:Iterator<QName>

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

Exceptions

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

getServiceName	back to summary
public QName getServiceName() Gets the name of this service. Returns:QName Qualified name of this service

getServiceName

back to summary

public QName getServiceName()

Gets the name of this service.

Returns:QName: Qualified name of this service

getWSDLDocumentLocation	back to summary
public URL getWSDLDocumentLocation() Gets the location of the WSDL document for this Service. Returns:URL URL for the location of the WSDL document for this service.

getWSDLDocumentLocation

back to summary

public URL getWSDLDocumentLocation()

Gets the location of the WSDL document for this Service.

Returns:URL: URL for the location of the WSDL document for this service.

setExecutor back to summary

setExecutor	back to summary
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:Executor The `java.util.concurrent.Executor` to be used to invoke a callback. Exceptions SecurityException: If the instance does not support setting an executor for security reasons (e.g. the necessary permissions are missing). See Also `java.util.concurrent.Executor`

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:Executor: The java.util.concurrent.Executor to be used to invoke a callback.

Exceptions

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

See Also

java.util.concurrent.Executor

setHandlerResolver back to summary

setHandlerResolver	back to summary
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:HandlerResolver The `HandlerResolver` to use for all subsequently created proxy/dispatch objects. See Also `javax.xml.ws.handler.HandlerResolver`

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:HandlerResolver: The HandlerResolver to use for all subsequently created proxy/dispatch objects.

See Also

javax.xml.ws.handler.HandlerResolver

Modifier and Type	Field and Description
public static final Service.Mode	MESSAGE Message mode.
public static final Service.Mode	PAYLOAD Payload mode.

Modifier and Type	Method and Description
public static Service.Mode	valueOf(String name)
public static Service.Mode[]	values()

public Class Service

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Service.Mode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail