| java.lang.Object
 javax.xml.ws.Service
| Service | | public class Service (Code) | | 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: javax.xml.ws.spi.Provider
See Also: javax.xml.ws.handler.HandlerResolver
See Also: java.util.concurrent.Executor |
| Inner Class :public enum Mode | |
| Method Summary | |
| public void | addPort(QName portName, String bindingId, String endpointAddress)
Creates a new port for the service. | | public static Service | create(java.net.URL wsdlDocumentLocation, QName serviceName)
Creates a Service instance. | | public static Service | create(QName serviceName)
Creates a Service instance. | | public Dispatch<T> | createDispatch(QName portName, Class<T> type, Mode mode)
Creates a Dispatch instance for use with objects of
the user's choosing.
Parameters:
portName - Qualified name for the target service endpoint
Parameters:
type - The class of object used for messages or messagepayloads. | | public Dispatch<T> | createDispatch(QName portName, Class<T> 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
Parameters:
type - The class of object used for messages or messagepayloads. | | public Dispatch<T> | createDispatch(EndpointReference endpointReference, Class<T> type, Service.Mode mode, WebServiceFeature... features)
Creates a Dispatch instance for use with objects of
the user's choosing. | | public Dispatch<Object> | createDispatch(QName portName, JAXBContext context, Mode mode)
Creates a Dispatch instance for use with JAXB
generated objects.
Parameters:
portName - Qualified name for the target service endpoint
Parameters:
context - The JAXB context used to marshall and unmarshallmessages or message payloads.
Parameters:
mode - Controls whether the created dispatch instance is messageor payload oriented, i.e. | | 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 - Qualified name for the target service endpoint
Parameters:
context - The JAXB context used to marshall and unmarshallmessages or message payloads.
Parameters:
mode - Controls whether the created dispatch instance is messageor payload oriented, i.e. | | public Dispatch<Object> | createDispatch(EndpointReference endpointReference, JAXBContext context, Service.Mode mode, WebServiceFeature... features)
Creates a Dispatch instance for use with JAXB
generated objects. | | public java.util.concurrent.Executor | getExecutor()
Returns the executor for this Serviceinstance. | | public HandlerResolver | getHandlerResolver()
Returns the configured handler resolver. | | public T | getPort(QName portName, Class<T> serviceEndpointInterface)
The getPort method returns a proxy. | | public T | getPort(QName portName, Class<T> serviceEndpointInterface, WebServiceFeature... features)
The getPort method returns a proxy. | | public T | getPort(Class<T> serviceEndpointInterface)
The getPort method returns a proxy. | | public T | getPort(Class<T> serviceEndpointInterface, WebServiceFeature... features)
The getPort method returns a proxy. | | public 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. | | public Iterator<javax.xml.namespace.QName> | getPorts()
| | public QName | getServiceName()
Gets the name of this service. | | public java.net.URL | getWSDLDocumentLocation()
Gets the location of the WSDL document for this Service. | | public void | setExecutor(java.util.concurrent.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.Executorto be used to invoke a callback.
throws:
SecurityException - If the instance does not supportsetting an executor for security reasons (e.g. | | public void | setHandlerResolver(HandlerResolver handlerResolver)
Sets the HandlerResolver for this Service
instance. |
| create | | public static Service create(java.net.URL wsdlDocumentLocation, QName serviceName)(Code) | | 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 locationfor the service
Parameters:
serviceName - QName for the service
throws:
WebServiceException - If any error in creation of thespecified service. |
| create | | public static Service create(QName serviceName)(Code) | | Creates a Service instance.
Parameters:
serviceName - QName for the service
throws:
WebServiceException - If any error in creation of thespecified service |
| createDispatch | | public Dispatch<T> createDispatch(QName portName, Class<T> type, Mode mode)(Code) | | Creates a Dispatch instance for use with objects of
the user's choosing.
Parameters:
portName - Qualified name for the target service endpoint
Parameters:
type - The class of object used for messages or messagepayloads. Implementations are required to supportjavax.xml.transform.Source, javax.xml.soap.SOAPMessageand javax.activation.DataSource, depending onthe binding in use.
Parameters:
mode - Controls whether the created dispatch instance is messageor payload oriented, i.e. whether the user will work with completeprotocol messages or message payloads. E.g. when using the SOAPprotocol, this parameter controls whether the user will work withSOAP messages or the contents of a SOAP body. Mode MUST be MESSAGEwhen type is SOAPMessage. Dispatch instance.
throws:
WebServiceException - If any error in the creation ofthe Dispatch object.
See Also: javax.xml.transform.Source
See Also: javax.xml.soap.SOAPMessage |
| createDispatch | | public Dispatch<T> createDispatch(QName portName, Class<T> type, Service.Mode mode, WebServiceFeature... features)(Code) | | Creates a Dispatch instance for use with objects of
the user's choosing.
Parameters:
portName - Qualified name for the target service endpoint
Parameters:
type - The class of object used for messages or messagepayloads. Implementations are required to supportjavax.xml.transform.Source and javax.xml.soap.SOAPMessage.
Parameters:
mode - Controls whether the created dispatch instance is messageor payload oriented, i.e. whether the user will work with completeprotocol messages or message payloads. E.g. when using the SOAPprotocol, this parameter controls whether the user will work withSOAP messages or the contents of a SOAP body. Mode MUST be MESSAGEwhen type is SOAPMessage.
Parameters:
features - A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values. Dispatch instance.
throws:
WebServiceException - If any error in the creation ofthe Dispatch object or if a feature is enabled that is not compatible with this port or is unsupported.
See Also: javax.xml.transform.Source
See Also: javax.xml.soap.SOAPMessage
See Also: WebServiceFeature
since:
JAX-WS 2.1 |
| createDispatch | | public Dispatch<T> createDispatch(EndpointReference endpointReference, Class<T> type, Service.Mode mode, WebServiceFeature... features)(Code) | | 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 EndpointReferencefor the target service endpoint that will be invoked by thereturned Dispatch object.
Parameters:
type - The class of object used to messages or messagepayloads. Implementations are required to supportjavax.xml.transform.Source and javax.xml.soap.SOAPMessage.
Parameters:
mode - Controls whether the created dispatch instance is messageor payload oriented, i.e. whether the user will work with completeprotocol messages or message payloads. E.g. when using the SOAPprotocol, this parameter controls whether the user will work withSOAP messages or the contents of a SOAP body. Mode MUST be MESSAGEwhen type is SOAPMessage.
Parameters:
features - An array of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values. Dispatch instance
throws:
WebServiceException - - If there is any missing WSDL metadataas required by this method.
- If the
endpointReference metadata doesnot match the serviceName or portNameof a WSDL associatedwith this Service instance. - If the
portName cannot be determinedfrom the EndpointReference metadata. - If any error in the creation ofthe
Dispatch object. - If a feature is enabled that is not compatible with this port or is unsupported.
See Also: javax.xml.transform.Source
See Also: javax.xml.soap.SOAPMessage
See Also: WebServiceFeature
since:
JAX-WS 2.1 |
| createDispatch | | public Dispatch<Object> createDispatch(QName portName, JAXBContext context, Mode mode)(Code) | | Creates a Dispatch instance for use with JAXB
generated objects.
Parameters:
portName - Qualified name for the target service endpoint
Parameters:
context - The JAXB context used to marshall and unmarshallmessages or message payloads.
Parameters:
mode - Controls whether the created dispatch instance is messageor payload oriented, i.e. whether the user will work with completeprotocol messages or message payloads. E.g. when using the SOAPprotocol, this parameter controls whether the user will work withSOAP messages or the contents of a SOAP body. Dispatch instance.
throws:
WebServiceException - If any error in the creation ofthe Dispatch object.
See Also: javax.xml.bind.JAXBContext |
| createDispatch | | public Dispatch<Object> createDispatch(QName portName, JAXBContext context, Service.Mode mode, WebServiceFeature... features)(Code) | | Creates a Dispatch instance for use with JAXB
generated objects.
Parameters:
portName - Qualified name for the target service endpoint
Parameters:
context - The JAXB context used to marshall and unmarshallmessages or message payloads.
Parameters:
mode - Controls whether the created dispatch instance is messageor payload oriented, i.e. whether the user will work with completeprotocol messages or message payloads. E.g. when using the SOAPprotocol, this parameter controls whether the user will work withSOAP messages or the contents of a SOAP body.
Parameters:
features - A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values. Dispatch instance.
throws:
WebServiceException - If any error in the creation ofthe Dispatch object or if a feature is enabled that is not compatible with this port or is unsupported.
See Also: javax.xml.bind.JAXBContext
See Also: WebServiceFeature
since:
JAX-WS 2.1 |
| createDispatch | | public Dispatch<Object> createDispatch(EndpointReference endpointReference, JAXBContext context, Service.Mode mode, WebServiceFeature... features)(Code) | | 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 EndpointReferencefor the target service endpoint that will be invoked by thereturned Dispatch object.
Parameters:
context - The JAXB context used to marshall and unmarshallmessages or message payloads.
Parameters:
mode - Controls whether the created dispatch instance is messageor payload oriented, i.e. whether the user will work with completeprotocol messages or message payloads. E.g. when using the SOAPprotocol, this parameter controls whether the user will work withSOAP messages or the contents of a SOAP body.
Parameters:
features - An array of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values. Dispatch instance
throws:
WebServiceException - - If there is any missing WSDL metadataas required by this method.
- If the
endpointReference metadata doesnot match the serviceName or portNameof a WSDL associatedwith this Service instance. - If the
portName cannot be determinedfrom the EndpointReference metadata. - If any error in the creation ofthe
Dispatch object. - if a feature is enabled that is not compatible with this port or is unsupported.
See Also: javax.xml.bind.JAXBContext
See Also: WebServiceFeature
since:
JAX-WS 2.1 |
| getHandlerResolver | | public HandlerResolver getHandlerResolver()(Code) | | Returns the configured handler resolver.
HandlerResolver The HandlerResolver beingused by this Service instance, or nullif there isn't one. |
| getPort | | public T getPort(QName portName, Class<T> serviceEndpointInterface)(Code) | | 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 inthe WSDL service description.
Parameters:
serviceEndpointInterface - Service endpoint interfacesupported by the dynamic proxy instance. Object Proxy instance thatsupports the specified service endpointinterface.
throws:
WebServiceException - This exception is thrown in thefollowing cases:- If there is an error in creation ofthe proxy.
- If there is any missing WSDL metadataas required by this method.
- If an illegal
serviceEndpointInterfaceor portName is specified.
See Also: java.lang.reflect.Proxy
See Also: java.lang.reflect.InvocationHandler |
| getPort | | public T getPort(QName portName, Class<T> serviceEndpointInterface, WebServiceFeature... features)(Code) | | 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 inthe WSDL service description.
Parameters:
serviceEndpointInterface - Service endpoint interfacesupported by the dynamic proxy instance.
Parameters:
features - A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values. Object Proxy instance thatsupports the specified service endpointinterface.
throws:
WebServiceException - This exception is thrown in thefollowing cases:- If there is an error in creation ofthe proxy.
- If there is any missing WSDL metadataas required by this method.
- If an illegal
serviceEndpointInterfaceor portName is specified. - If a feature is enabled that is not compatiblewith this port or is unsupported.
See Also: java.lang.reflect.Proxy
See Also: java.lang.reflect.InvocationHandler
See Also: WebServiceFeature
since:
JAX-WS 2.1 |
| getPort | | public T getPort(Class<T> serviceEndpointInterface)(Code) | | 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. Object instance that supports thespecified service endpoint interface.
throws:
WebServiceException - - If there is an error during creationof the proxy.
- If there is any missing WSDL metadataas required by this method.
- If an illegal.
serviceEndpointInterfaceis specified.
|
| getPort | | public T getPort(Class<T> serviceEndpointInterface, WebServiceFeature... features)(Code) | | 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.
Parameters:
features - A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values. Object instance that supports thespecified service endpoint interface.
throws:
WebServiceException - - If there is an error during creationof the proxy.
- If there is any missing WSDL metadataas required by this method.
- If an illegal
serviceEndpointInterfaceis specified. - If a feature is enabled that is not compatiblewith this port or is unsupported.
See Also: WebServiceFeature
since:
JAX-WS 2.1 |
| getPort | | public T getPort(EndpointReference endpointReference, Class<T> serviceEndpointInterface, WebServiceFeature... features)(Code) | | 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 EndpointReferencefor the target service endpoint that will be invoked by thereturned proxy.
Parameters:
serviceEndpointInterface - Service endpoint interface.
Parameters:
features - A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values. Object Proxy instance that supports thespecified service endpoint interface.
throws:
WebServiceException - - If there is an error during creationof the proxy.
- If there is any missing WSDL metadataas required by this method.
- If the
endpointReference metadata doesnot match the serviceName of thisService instance. - If a
portName cannot be extractedfrom the WSDL or endpointReference metadata. - If an invalid
endpointReferenceis specified. - If an invalid
serviceEndpointInterfaceis specified. - If a feature is enabled that is not compatiblewith this port or is unsupported.
since:
JAX-WS 2.1 |
| getPorts | | public Iterator<javax.xml.namespace.QName> getPorts()(Code) | | Returns an Iterator for the list of
QNames of service endpoints grouped by this
service
Returns java.util.Iterator with elementsof type javax.xml.namespace.QName.
throws:
WebServiceException - If this Service class does nothave access to the required WSDL metadata. |
| getServiceName | | public QName getServiceName()(Code) | | Gets the name of this service.
Qualified name of this service |
| getWSDLDocumentLocation | | public java.net.URL getWSDLDocumentLocation()(Code) | | Gets the location of the WSDL document for this Service.
URL for the location of the WSDL document forthis service. |
| setExecutor | | public void setExecutor(java.util.concurrent.Executor executor)(Code) | | Sets the executor for this Service instance.
The executor is used for all asynchronous invocations that
require callbacks.
Parameters:
executor - The java.util.concurrent.Executorto be used to invoke a callback.
throws:
SecurityException - If the instance does not supportsetting an executor for security reasons (e.g. thenecessary permissions are missing).
See Also: java.util.concurrent.Executor |
| setHandlerResolver | | public void setHandlerResolver(HandlerResolver handlerResolver)(Code) | | 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 usefor all subsequently created proxy/dispatch objects.
See Also: javax.xml.ws.handler.HandlerResolver |
|
|