ServiceDelegate
and
Endpoint
objects.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract Endpoint
createAndPublishEndpoint
(String address, Object implementor) Creates and publishes an endpoint object with the specified address and implementation object.createAndPublishEndpoint
(String address, Object implementor, WebServiceFeature... features) Creates and publishes an endpoint object with the specified address, implementation object and web service features.createEndpoint
(String bindingId, Class<?> implementorClass, Invoker invoker, WebServiceFeature... features) Creates an endpoint object with the provided binding, implementation class, invoker and web service features.abstract Endpoint
createEndpoint
(String bindingId, Object implementor) Creates an endpoint object with the provided binding and implementation object.createEndpoint
(String bindingId, Object implementor, WebServiceFeature... features) Creates an endpoint object with the provided binding, implementation object and web service features.abstract ServiceDelegate
createServiceDelegate
(URL wsdlDocumentLocation, QName serviceName, Class<? extends Service> serviceClass) Creates a service delegate object.createServiceDelegate
(URL wsdlDocumentLocation, QName serviceName, Class<? extends Service> serviceClass, WebServiceFeature... features) Creates a service delegate object.abstract W3CEndpointReference
createW3CEndpointReference
(String address, QName serviceName, QName portName, List<Element> metadata, String wsdlDocumentLocation, List<Element> referenceParameters) Factory method to create aW3CEndpointReference
.createW3CEndpointReference
(String address, QName interfaceName, QName serviceName, QName portName, List<Element> metadata, String wsdlDocumentLocation, List<Element> referenceParameters, List<Element> elements, Map<QName, String> attributes) Factory method to create aW3CEndpointReference
.abstract <T> T
getPort
(EndpointReference endpointReference, Class<T> serviceEndpointInterface, WebServiceFeature... features) The getPort method returns a proxy.static Provider
provider()
Creates a new provider object.abstract EndpointReference
readEndpointReference
(Source eprInfoset) read an EndpointReference from the infoset contained ineprInfoset
.
-
Constructor Details
-
Provider
protected Provider()Creates a new instance of Provider
-
-
Method Details
-
provider
Creates a new provider object.The algorithm used to locate the provider subclass to use consists of the following steps:
- If a system property with the name
jakarta.xml.ws.spi.Provider
is defined, then its value is used as the name of the implementation class. This phase of the look up enables per-JVM override of the Jakarta XML Web Services implementation. - Use the service-provider loading facilities, defined by the
ServiceLoader
class, to attempt to locate and load an implementation ofProvider
service using the default loading mechanism. - Finally, if all the steps above fail, then the rest of the lookup is unspecified. That said, the recommended behavior is to simply look for some hard-coded platform default Jakarta XML Web Services implementation. This phase of the lookup is so that the environment can have its own Jakarta XML Web Services implementation as the last resort.
- Returns:
- provider object
- If a system property with the name
-
createServiceDelegate
public abstract ServiceDelegate createServiceDelegate(URL wsdlDocumentLocation, QName serviceName, Class<? extends Service> serviceClass) Creates a service delegate object.- Parameters:
wsdlDocumentLocation
- A URL pointing to the WSDL document for the service, ornull
if there isn't one.serviceName
- The qualified name of the service.serviceClass
- The service class, which MUST be eitherjakarta.xml.ws.Service
or a subclass thereof.- Returns:
- The newly created service delegate.
-
createServiceDelegate
public ServiceDelegate createServiceDelegate(URL wsdlDocumentLocation, QName serviceName, Class<? extends Service> serviceClass, WebServiceFeature... features) Creates a service delegate object.- Parameters:
wsdlDocumentLocation
- A URL pointing to the WSDL document for the service, ornull
if there isn't one.serviceName
- The qualified name of the service.serviceClass
- The service class, which MUST be eitherjakarta.xml.ws.Service
or a subclass thereof.features
- Web Service features that must be configured on the service. If the provider doesn't understand a feature, it must throw a WebServiceException.- Returns:
- The newly created service delegate.
-
createEndpoint
Creates an endpoint object with the provided binding and implementation object.- Parameters:
bindingId
- A URI specifying the desired binding (e.g. SOAP/HTTP)implementor
- A service implementation object to which incoming requests will be dispatched. The corresponding class MUST be annotated with all the necessary Web service annotations.- Returns:
- The newly created endpoint.
-
createAndPublishEndpoint
Creates and publishes an endpoint object with the specified address and implementation object.- Parameters:
address
- A URI specifying the address and transport/protocol to use. A http: URI MUST result in the SOAP 1.1/HTTP binding being used. Implementations may support other URI schemes.implementor
- A service implementation object to which incoming requests will be dispatched. The corresponding class MUST be annotated with all the necessary Web service annotations.- Returns:
- The newly created endpoint.
-
readEndpointReference
read an EndpointReference from the infoset contained ineprInfoset
.- Parameters:
eprInfoset
- infoset for EndpointReference- Returns:
- the
EndpointReference
unmarshalled fromeprInfoset
. This method never returnsnull
. - Throws:
WebServiceException
- If there is an error creating theEndpointReference
from the specifiedeprInfoset
.NullPointerException
- If thenull
eprInfoset
value is given.
-
getPort
public abstract <T> T getPort(EndpointReference endpointReference, Class<T> serviceEndpointInterface, WebServiceFeature... features) The getPort method returns a proxy. If there are any reference parameters in theendpointReference
, then those reference parameters MUST appear as SOAP headers, indicating them to be reference parameters, on all messages sent to the endpoint. The parameterserviceEndpointInterface
specifies the service endpoint interface that is supported by the returned proxy. The parameterendpointReference
specifies the endpoint that will be invoked by the returned proxy. In the implementation of this method, the Jakarta XML Web Services runtime system takes the responsibility of selecting a protocol binding (and a port) and configuring the proxy accordingly from the WSDL metadata of theserviceEndpointInterface
and theEndpointReference
. For this method to successfully return a proxy, WSDL metadata MUST be available and theendpointReference
MUST contain an implementation understoodserviceName
metadata.- Type Parameters:
T
- Service endpoint interface- Parameters:
endpointReference
- the EndpointReference that will be invoked by the returned proxy.serviceEndpointInterface
- Service endpoint interfacefeatures
- A list of WebServiceFeatures to configure on the proxy. Supported features not in thefeatures
parameter will have their default values.- Returns:
- Object Proxy instance that supports the specified service endpoint interface
- Throws:
WebServiceException
-- If there is an error during creation of the proxy
- If there is any missing WSDL metadata as required by this method}
- If this
endpointReference
is illegal - If an illegal
serviceEndpointInterface
is specified - If a feature is enabled that is not compatible with this port or is unsupported.
- See Also:
-
createW3CEndpointReference
public abstract W3CEndpointReference createW3CEndpointReference(String address, QName serviceName, QName portName, List<Element> metadata, String wsdlDocumentLocation, List<Element> referenceParameters) Factory method to create aW3CEndpointReference
.This method can be used to create a
W3CEndpointReference
for any endpoint by specifying theaddress
property along with any other desired properties. This method can also be used to create aW3CEndpointReference
for an endpoint that is published by the same Jakarta EE application. To do so theaddress
property can be provided or this method can automatically determine theaddress
of an endpoint that is published by the same Jakarta EE application and is identified by theserviceName
andportName
properties. If theaddress
isnull
and theserviceName
andportName
do not identify an endpoint published by the same Jakarta EE application, ajavax.lang.IllegalStateException
MUST be thrown.- Parameters:
address
- Specifies the address of the target endpointserviceName
- Qualified name of the service in the WSDL.portName
- Qualified name of the endpoint in the WSDL.metadata
- A list of elements that should be added to theW3CEndpointReference
instanceswsa:metadata
element.wsdlDocumentLocation
- URL for the WSDL document location for the service.referenceParameters
- Reference parameters to be associated with the returnedEndpointReference
instance.- Returns:
- the
W3CEndpointReference
created fromserviceName
,portName
,metadata
,wsdlDocumentLocation
andreferenceParameters
. This method never returnsnull
. - Throws:
IllegalStateException
-- If the
address
,serviceName
andportName
are allnull
. - If the
serviceName
service isnull
and theportName
is NOTnull
. - If the
address
property isnull
and theserviceName
andportName
do not specify a valid endpoint published by the same Jakarta EE application. - If the
serviceName
is NOTnull
and is not present in the specified WSDL. - If the
portName
port is notnull
and it is not present inserviceName
service in the WSDL. - If the
wsdlDocumentLocation
is NOTnull
and does not represent a valid WSDL.
- If the
WebServiceException
- If an error occurs while creating theW3CEndpointReference
.
-
createW3CEndpointReference
public W3CEndpointReference createW3CEndpointReference(String address, QName interfaceName, QName serviceName, QName portName, List<Element> metadata, String wsdlDocumentLocation, List<Element> referenceParameters, List<Element> elements, Map<QName, String> attributes) Factory method to create aW3CEndpointReference
. Using this method, aW3CEndpointReference
instance can be created with extension elements, and attributes.Provider
implementations must override the default implementation.This method can be used to create a
W3CEndpointReference
for any endpoint by specifying theaddress
property along with any other desired properties. This method can also be used to create aW3CEndpointReference
for an endpoint that is published by the same Jakarta EE application. To do so theaddress
property can be provided or this method can automatically determine theaddress
of an endpoint that is published by the same Jakarta EE application and is identified by theserviceName
andportName
properties. If theaddress
isnull
and theserviceName
andportName
do not identify an endpoint published by the same Jakarta EE application, ajavax.lang.IllegalStateException
MUST be thrown.- Parameters:
address
- Specifies the address of the target endpointinterfaceName
- thewsam:InterfaceName
element in thewsa:Metadata
element.serviceName
- Qualified name of the service in the WSDL.portName
- Qualified name of the endpoint in the WSDL.metadata
- A list of elements that should be added to theW3CEndpointReference
instanceswsa:metadata
element.wsdlDocumentLocation
- URL for the WSDL document location for the service.referenceParameters
- Reference parameters to be associated with the returnedEndpointReference
instance.elements
- extension elements to be associated with the returnedEndpointReference
instance.attributes
- extension attributes to be associated with the returnedEndpointReference
instance.- Returns:
- the
W3CEndpointReference
created fromserviceName
,portName
,metadata
,wsdlDocumentLocation
andreferenceParameters
. This method never returnsnull
. - Throws:
IllegalStateException
-- If the
address
,serviceName
andportName
are allnull
. - If the
serviceName
service isnull
and theportName
is NOTnull
. - If the
address
property isnull
and theserviceName
andportName
do not specify a valid endpoint published by the same Jakarta EE application. - If the
serviceName
is NOTnull
and is not present in the specified WSDL. - If the
portName
port is notnull
and it is not present inserviceName
service in the WSDL. - If the
wsdlDocumentLocation
is NOTnull
and does not represent a valid WSDL. - If the
wsdlDocumentLocation
is NOTnull
but wsdl:wsdlLocation's namespace name cannot be got from the available metadata.
- If the
WebServiceException
- If an error occurs while creating theW3CEndpointReference
.
-
createAndPublishEndpoint
public Endpoint createAndPublishEndpoint(String address, Object implementor, WebServiceFeature... features) Creates and publishes an endpoint object with the specified address, implementation object and web service features.Provider
implementations must override the default implementation.- Parameters:
address
- A URI specifying the address and transport/protocol to use. A http: URI MUST result in the SOAP 1.1/HTTP binding being used. Implementations may support other URI schemes.implementor
- A service implementation object to which incoming requests will be dispatched. The corresponding class MUST be annotated with all the necessary Web service annotations.features
- A list of WebServiceFeatures to configure on the endpoint. Supported features not in thefeatures
parameter will have their default values.- Returns:
- The newly created endpoint.
-
createEndpoint
Creates an endpoint object with the provided binding, implementation object and web service features.Provider
implementations must override the default implementation.- Parameters:
bindingId
- A URI specifying the desired binding (e.g. SOAP/HTTP)implementor
- A service implementation object to which incoming requests will be dispatched. The corresponding class MUST be annotated with all the necessary Web service annotations.features
- A list of WebServiceFeatures to configure on the endpoint. Supported features not in thefeatures
parameter will have their default values.- Returns:
- The newly created endpoint.
-
createEndpoint
public Endpoint createEndpoint(String bindingId, Class<?> implementorClass, Invoker invoker, WebServiceFeature... features) Creates an endpoint object with the provided binding, implementation class, invoker and web service features. Containers typically use this to create Endpoint objects.Provider
implementations must override the default implementation.- Parameters:
bindingId
- A URI specifying the desired binding (e.g. SOAP/HTTP). Can be null.implementorClass
- A service implementation class that MUST be annotated with all the necessary Web service annotations.invoker
- that does the actual invocation on the service instance.features
- A list of WebServiceFeatures to configure on the endpoint. Supported features not in thefeatures
parameter will have their default values.- Returns:
- The newly created endpoint.
-