You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
824 lines
35 KiB
824 lines
35 KiB
/* |
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
|
* |
|
* Copyright (c) 2005-2017 Oracle and/or its affiliates. All rights reserved. |
|
* |
|
* The contents of this file are subject to the terms of either the GNU |
|
* General Public License Version 2 only ("GPL") or the Common Development |
|
* and Distribution License("CDDL") (collectively, the "License"). You |
|
* may not use this file except in compliance with the License. You can |
|
* obtain a copy of the License at |
|
* https://oss.oracle.com/licenses/CDDL+GPL-1.1 |
|
* or LICENSE.txt. See the License for the specific |
|
* language governing permissions and limitations under the License. |
|
* |
|
* When distributing the software, include this License Header Notice in each |
|
* file and include the License file at LICENSE.txt. |
|
* |
|
* GPL Classpath Exception: |
|
* Oracle designates this particular file as subject to the "Classpath" |
|
* exception as provided by Oracle in the GPL Version 2 section of the License |
|
* file that accompanied this code. |
|
* |
|
* Modifications: |
|
* If applicable, add the following below the License Header, with the fields |
|
* enclosed by brackets [] replaced by your own identifying information: |
|
* "Portions Copyright [year] [name of copyright owner]" |
|
* |
|
* Contributor(s): |
|
* If you wish your version of this file to be governed by only the CDDL or |
|
* only the GPL Version 2, indicate your decision by adding "[Contributor] |
|
* elects to include this software in this distribution under the [CDDL or GPL |
|
* Version 2] license." If you don't indicate a single choice of license, a |
|
* recipient has the option to distribute your version of this file under |
|
* either the CDDL, the GPL Version 2 or to extend the choice of license to |
|
* its licensees as provided above. However, if you add GPL Version 2 code |
|
* and therefore, elected the GPL Version 2 license, then the option applies |
|
* only if the new code is made subject to such option by the copyright |
|
* holder. |
|
*/ |
|
|
|
package javax.xml.ws; |
|
|
|
import javax.xml.namespace.QName; |
|
import java.util.Iterator; |
|
import javax.xml.ws.handler.HandlerResolver; |
|
import javax.xml.bind.JAXBContext; |
|
import javax.xml.ws.spi.ServiceDelegate; |
|
import javax.xml.ws.spi.Provider; |
|
|
|
/** |
|
* {@code Service} objects provide the client view of a Web service. |
|
* <p>{@code Service} acts as a factory of the following: |
|
* <ul> |
|
* <li>Proxies for a target service endpoint.</li> |
|
* <li>Instances of {@link javax.xml.ws.Dispatch} for |
|
* dynamic message-oriented invocation of a remote |
|
* operation. |
|
* </li> |
|
* </ul> |
|
* |
|
* <p>The ports available on a service can be enumerated using the |
|
* {@code getPorts} method. Alternatively, you can pass a |
|
* service endpoint interface to the unary {@code getPort} method |
|
* and let the runtime select a compatible port. |
|
* |
|
* <p>Handler chains for all the objects created by a {@code Service} |
|
* can be set by means of a {@code HandlerResolver}. |
|
* |
|
* <p>An {@code 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 {@code ThreadPoolExecutor} and |
|
* registering it with the service. |
|
* |
|
* @since 1.6, JAX-WS 2.0 |
|
* |
|
* @see javax.xml.ws.spi.Provider |
|
* @see javax.xml.ws.handler.HandlerResolver |
|
* @see java.util.concurrent.Executor |
|
**/ |
|
public class Service { |
|
|
|
private ServiceDelegate delegate; |
|
/** |
|
* The orientation of a dynamic client or service. {@code MESSAGE} provides |
|
* access to entire protocol message, {@code PAYLOAD} to protocol message |
|
* payload only. |
|
**/ |
|
public enum Mode { |
|
|
|
/** |
|
* Message mode. |
|
*/ |
|
MESSAGE, |
|
|
|
/** |
|
* Payload mode. |
|
*/ |
|
PAYLOAD } |
|
|
|
/** |
|
* Creates a {@code Service}. |
|
* |
|
* The specified WSDL document location and service qualified name MUST |
|
* uniquely identify a {@code wsdl:service} element. |
|
* |
|
* @param wsdlDocumentLocation {@code URL} for the WSDL document location |
|
* for the service |
|
* @param serviceName {@code QName} for the service |
|
*/ |
|
protected Service(java.net.URL wsdlDocumentLocation, QName serviceName) { |
|
delegate = Provider.provider().createServiceDelegate(wsdlDocumentLocation, |
|
serviceName, |
|
this.getClass()); |
|
} |
|
|
|
/** |
|
* Creates a {@code Service}. The created instance is |
|
* configured with the web service features. |
|
* |
|
* The specified WSDL document location and service qualified name MUST |
|
* uniquely identify a {@code wsdl:service} element. |
|
* |
|
* @param wsdlDocumentLocation {@code URL} for the WSDL document location |
|
* for the service |
|
* @param serviceName {@code QName} for the service |
|
* @param features Web Service features that must be configured on |
|
* the service. If the provider doesn't understand a feature, |
|
* it must throw a WebServiceException. |
|
*/ |
|
protected Service(java.net.URL wsdlDocumentLocation, QName serviceName, WebServiceFeature ... features) { |
|
delegate = Provider.provider().createServiceDelegate(wsdlDocumentLocation, |
|
serviceName, |
|
this.getClass(), features); |
|
} |
|
|
|
|
|
/** |
|
* The {@code getPort} method returns a proxy. A service client |
|
* uses this proxy to invoke operations on the target |
|
* service endpoint. The {@code serviceEndpointInterface} |
|
* specifies the service endpoint interface that is supported by |
|
* the created dynamic proxy instance. |
|
* |
|
* @param <T> Service endpoint interface. |
|
* @param portName Qualified name of the service endpoint in |
|
* the WSDL service description. |
|
* @param serviceEndpointInterface Service endpoint interface |
|
* supported by the dynamic proxy instance. |
|
* @return Object Proxy instance that |
|
* supports the specified service endpoint |
|
* interface. |
|
* @throws WebServiceException This exception is thrown in the |
|
* following cases: |
|
* <UL> |
|
* <LI>If there is an error in creation of |
|
* the proxy. |
|
* <LI>If there is any missing WSDL metadata |
|
* as required by this method. |
|
* <LI>If an illegal |
|
* {@code serviceEndpointInterface} |
|
* or {@code portName} is specified. |
|
* </UL> |
|
* @see java.lang.reflect.Proxy |
|
* @see java.lang.reflect.InvocationHandler |
|
**/ |
|
public <T> T getPort(QName portName, |
|
Class<T> serviceEndpointInterface) { |
|
return delegate.getPort(portName, serviceEndpointInterface); |
|
} |
|
|
|
/** |
|
* The {@code getPort} method returns a proxy. A service client |
|
* uses this proxy to invoke operations on the target |
|
* service endpoint. The {@code serviceEndpointInterface} |
|
* specifies the service endpoint interface that is supported by |
|
* the created dynamic proxy instance. |
|
* |
|
* @param <T> Service endpoint interface. |
|
* @param portName Qualified name of the service endpoint in |
|
* the WSDL service description. |
|
* @param serviceEndpointInterface Service endpoint interface |
|
* supported by the dynamic proxy instance. |
|
* @param features A list of WebServiceFeatures to configure on the |
|
* proxy. Supported features not in the {@code features |
|
* } parameter will have their default values. |
|
* @return Object Proxy instance that |
|
* supports the specified service endpoint |
|
* interface. |
|
* @throws WebServiceException This exception is thrown in the |
|
* following cases: |
|
* <UL> |
|
* <LI>If there is an error in creation of |
|
* the proxy. |
|
* <LI>If there is any missing WSDL metadata |
|
* as required by this method. |
|
* <LI>If an illegal |
|
* {@code serviceEndpointInterface} |
|
* or {@code portName} is specified. |
|
* <LI>If a feature is enabled that is not compatible |
|
* with this port or is unsupported. |
|
* </UL> |
|
* @see java.lang.reflect.Proxy |
|
* @see java.lang.reflect.InvocationHandler |
|
* @see WebServiceFeature |
|
* |
|
* @since 1.6, JAX-WS 2.1 |
|
**/ |
|
public <T> T getPort(QName portName, |
|
Class<T> serviceEndpointInterface, WebServiceFeature... features) { |
|
return delegate.getPort(portName, serviceEndpointInterface, features); |
|
} |
|
|
|
|
|
/** |
|
* The {@code getPort} method returns a proxy. The parameter |
|
* {@code 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. |
|
* |
|
* @param <T> Service endpoint interface. |
|
* @param serviceEndpointInterface Service endpoint interface. |
|
* @return Object instance that supports the |
|
* specified service endpoint interface. |
|
* @throws WebServiceException |
|
* <UL> |
|
* <LI>If there is an error during creation |
|
* of the proxy. |
|
* <LI>If there is any missing WSDL metadata |
|
* as required by this method. |
|
* <LI>If an illegal |
|
* {@code serviceEndpointInterface} |
|
* is specified. |
|
* </UL> |
|
**/ |
|
public <T> T getPort(Class<T> serviceEndpointInterface) { |
|
return delegate.getPort(serviceEndpointInterface); |
|
} |
|
|
|
|
|
/** |
|
* The {@code getPort} method returns a proxy. The parameter |
|
* {@code 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. |
|
* |
|
* @param <T> Service endpoint interface. |
|
* @param serviceEndpointInterface Service endpoint interface. |
|
* @param features A list of WebServiceFeatures to configure on the |
|
* proxy. Supported features not in the {@code features |
|
* } parameter will have their default values. |
|
* @return Object instance that supports the |
|
* specified service endpoint interface. |
|
* @throws WebServiceException |
|
* <UL> |
|
* <LI>If there is an error during creation |
|
* of the proxy. |
|
* <LI>If there is any missing WSDL metadata |
|
* as required by this method. |
|
* <LI>If an illegal |
|
* {@code serviceEndpointInterface} |
|
* is specified. |
|
* <LI>If a feature is enabled that is not compatible |
|
* with this port or is unsupported. |
|
* </UL> |
|
* |
|
* @see WebServiceFeature |
|
* |
|
* @since 1.6, JAX-WS 2.1 |
|
**/ |
|
public <T> T getPort(Class<T> serviceEndpointInterface, |
|
WebServiceFeature... features) { |
|
return delegate.getPort(serviceEndpointInterface, features); |
|
} |
|
|
|
|
|
/** |
|
* The {@code getPort} method returns a proxy. |
|
* The parameter {@code endpointReference} specifies the |
|
* endpoint that will be invoked by the returned proxy. If there |
|
* are any reference parameters in the |
|
* {@code endpointReference}, then those reference |
|
* parameters MUST appear as SOAP headers, indicating them to be |
|
* reference parameters, on all messages sent to the endpoint. |
|
* The {@code endpointReference's} address MUST be used |
|
* for invocations on the endpoint. |
|
* The parameter {@code 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 {@code Service} instance or |
|
* from the metadata from the {@code endpointReference}. |
|
* If this {@code Service} instance has a WSDL and |
|
* the {@code endpointReference} metadata |
|
* also has a WSDL, then the WSDL from this instance MUST be used. |
|
* If this {@code Service} instance does not have a WSDL and |
|
* the {@code endpointReference} does have a WSDL, then the |
|
* WSDL from the {@code endpointReference} MAY be used. |
|
* The returned proxy should not be reconfigured by the client. |
|
* If this {@code 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. |
|
* <p> |
|
* Calling this method has the same behavior as the following |
|
* <pre> |
|
* {@code port = service.getPort(portName, serviceEndpointInterface);} |
|
* </pre> |
|
* where the {@code portName} is retrieved from the |
|
* metadata of the {@code endpointReference} or from the |
|
* {@code serviceEndpointInterface} and the WSDL |
|
* associated with this {@code Service} instance. |
|
* |
|
* @param <T> Service endpoint interface. |
|
* @param endpointReference The {@code EndpointReference} |
|
* for the target service endpoint that will be invoked by the |
|
* returned proxy. |
|
* @param serviceEndpointInterface Service endpoint interface. |
|
* @param features A list of {@code WebServiceFeatures} to configure on the |
|
* proxy. Supported features not in the {@code features |
|
* } parameter will have their default values. |
|
* @return Object Proxy instance that supports the |
|
* specified service endpoint interface. |
|
* @throws WebServiceException |
|
* <UL> |
|
* <LI>If there is an error during creation |
|
* of the proxy. |
|
* <LI>If there is any missing WSDL metadata |
|
* as required by this method. |
|
* <LI>If the {@code endpointReference} metadata does |
|
* not match the {@code serviceName} of this |
|
* {@code Service} instance. |
|
* <LI>If a {@code portName} cannot be extracted |
|
* from the WSDL or {@code endpointReference} metadata. |
|
* <LI>If an invalid |
|
* {@code endpointReference} |
|
* is specified. |
|
* <LI>If an invalid |
|
* {@code serviceEndpointInterface} |
|
* is specified. |
|
* <LI>If a feature is enabled that is not compatible |
|
* with this port or is unsupported. |
|
* </UL> |
|
* |
|
* @since 1.6, JAX-WS 2.1 |
|
**/ |
|
public <T> T getPort(EndpointReference endpointReference, |
|
Class<T> serviceEndpointInterface, WebServiceFeature... features) { |
|
return delegate.getPort(endpointReference, serviceEndpointInterface, features); |
|
} |
|
|
|
/** |
|
* 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 |
|
* {@code Dispatch}instances. |
|
* |
|
* @param portName Qualified name for the target service endpoint. |
|
* @param bindingId A String identifier of a binding. |
|
* @param endpointAddress Address of the target service endpoint as a URI. |
|
* @throws WebServiceException If any error in the creation of |
|
* the port. |
|
* |
|
* @see javax.xml.ws.soap.SOAPBinding#SOAP11HTTP_BINDING |
|
* @see javax.xml.ws.soap.SOAPBinding#SOAP12HTTP_BINDING |
|
* @see javax.xml.ws.http.HTTPBinding#HTTP_BINDING |
|
**/ |
|
public void addPort(QName portName, String bindingId, String endpointAddress) { |
|
delegate.addPort(portName, bindingId, endpointAddress); |
|
} |
|
|
|
|
|
/** |
|
* Creates a {@code Dispatch} instance for use with objects of |
|
* the client's choosing. |
|
* |
|
* @param <T> The type of the message or payload |
|
* @param portName Qualified name for the target service endpoint |
|
* @param type The class of object used for messages or message |
|
* payloads. Implementations are required to support |
|
* {@code javax.xml.transform.Source}, {@code javax.xml.soap.SOAPMessage} |
|
* and {@code javax.activation.DataSource}, depending on |
|
* the binding in use. |
|
* @param 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. |
|
* |
|
* @return Dispatch instance. |
|
* @throws WebServiceException If any error in the creation of |
|
* the {@code Dispatch} object. |
|
* |
|
* @see javax.xml.transform.Source |
|
* @see javax.xml.soap.SOAPMessage |
|
**/ |
|
public <T> Dispatch<T> createDispatch(QName portName, Class<T> type, Mode mode) { |
|
return delegate.createDispatch(portName, type, mode); |
|
} |
|
|
|
|
|
/** |
|
* Creates a {@code Dispatch} instance for use with objects of |
|
* the client's choosing. |
|
* |
|
* @param <T> The type of the message or payload |
|
* @param portName Qualified name for the target service endpoint |
|
* @param type The class of object used for messages or message |
|
* payloads. Implementations are required to support |
|
* {@code javax.xml.transform.Source} and {@code javax.xml.soap.SOAPMessage}. |
|
* @param 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 {@code MESSAGE} |
|
* when type is {@code SOAPMessage}. |
|
* @param features A list of {@code WebServiceFeatures} to configure on the |
|
* proxy. Supported features not in the {@code features |
|
* } parameter will have their default values. |
|
* |
|
* @return Dispatch instance. |
|
* @throws WebServiceException If any error in the creation of |
|
* the {@code Dispatch} object or if a |
|
* feature is enabled that is not compatible with |
|
* this port or is unsupported. |
|
* |
|
* @see javax.xml.transform.Source |
|
* @see javax.xml.soap.SOAPMessage |
|
* @see WebServiceFeature |
|
* |
|
* @since 1.6, JAX-WS 2.1 |
|
**/ |
|
public <T> Dispatch<T> createDispatch(QName portName, Class<T> type, |
|
Service.Mode mode, WebServiceFeature... features) { |
|
return delegate.createDispatch(portName, type, mode, features); |
|
} |
|
|
|
|
|
/** |
|
* Creates a {@code Dispatch} instance for use with objects of |
|
* the client's choosing. If there |
|
* are any reference parameters in the |
|
* {@code endpointReference}, then those reference |
|
* parameters MUST appear as SOAP headers, indicating them to be |
|
* reference parameters, on all messages sent to the endpoint. |
|
* The {@code 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 {@code Service} instance or |
|
* from the metadata from the {@code endpointReference}. |
|
* If this {@code Service} instance has a WSDL and |
|
* the {@code endpointReference} |
|
* also has a WSDL in its metadata, then the WSDL from this instance MUST be used. |
|
* If this {@code Service} instance does not have a WSDL and |
|
* the {@code endpointReference} does have a WSDL, then the |
|
* WSDL from the {@code endpointReference} MAY be used. |
|
* An implementation MUST be able to retrieve the {@code portName} from the |
|
* {@code endpointReference} metadata. |
|
* <p> |
|
* This method behaves the same as calling |
|
* <pre> |
|
* {@code dispatch = service.createDispatch(portName, type, mode, features);} |
|
* </pre> |
|
* where the {@code portName} is retrieved from the |
|
* WSDL or {@code EndpointReference} metadata. |
|
* |
|
* @param <T> The type of the message or payload |
|
* @param endpointReference The {@code EndpointReference} |
|
* for the target service endpoint that will be invoked by the |
|
* returned {@code Dispatch} object. |
|
* @param type The class of object used to messages or message |
|
* payloads. Implementations are required to support |
|
* {@code javax.xml.transform.Source} and {@code javax.xml.soap.SOAPMessage}. |
|
* @param 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 {@code MESSAGE} |
|
* when type is {@code SOAPMessage}. |
|
* @param features An array of {@code WebServiceFeatures} to configure on the |
|
* proxy. Supported features not in the {@code features |
|
* } parameter will have their default values. |
|
* |
|
* @return Dispatch instance |
|
* @throws WebServiceException |
|
* <UL> |
|
* <LI>If there is any missing WSDL metadata |
|
* as required by this method. |
|
* <li>If the {@code endpointReference} metadata does |
|
* not match the {@code serviceName} or {@code portName} |
|
* of a WSDL associated |
|
* with this {@code Service} instance. |
|
* <li>If the {@code portName} cannot be determined |
|
* from the {@code EndpointReference} metadata. |
|
* <li>If any error in the creation of |
|
* the {@code Dispatch} object. |
|
* <li>If a feature is enabled that is not |
|
* compatible with this port or is unsupported. |
|
* </UL> |
|
* |
|
* @see javax.xml.transform.Source |
|
* @see javax.xml.soap.SOAPMessage |
|
* @see WebServiceFeature |
|
* |
|
* @since 1.6, JAX-WS 2.1 |
|
**/ |
|
public <T> Dispatch<T> createDispatch(EndpointReference endpointReference, |
|
Class<T> type, Service.Mode mode, |
|
WebServiceFeature... features) { |
|
return delegate.createDispatch(endpointReference, type, mode, features); |
|
} |
|
|
|
/** |
|
* Creates a {@code Dispatch} instance for use with JAXB |
|
* generated objects. |
|
* |
|
* @param portName Qualified name for the target service endpoint |
|
* @param context The JAXB context used to marshall and unmarshall |
|
* messages or message payloads. |
|
* @param 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. |
|
* |
|
* @return Dispatch instance. |
|
* @throws WebServiceException If any error in the creation of |
|
* the {@code Dispatch} object. |
|
* |
|
* @see javax.xml.bind.JAXBContext |
|
**/ |
|
public Dispatch<Object> createDispatch(QName portName, JAXBContext context, |
|
Mode mode) { |
|
return delegate.createDispatch(portName, context, mode); |
|
} |
|
|
|
|
|
/** |
|
* Creates a {@code Dispatch} instance for use with JAXB |
|
* generated objects. |
|
* |
|
* @param portName Qualified name for the target service endpoint |
|
* @param context The JAXB context used to marshall and unmarshall |
|
* messages or message payloads. |
|
* @param 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. |
|
* @param features A list of {@code WebServiceFeatures} to configure on the |
|
* proxy. Supported features not in the {@code features |
|
* } parameter will have their default values. |
|
* |
|
* @return Dispatch instance. |
|
* @throws WebServiceException If any error in the creation of |
|
* the {@code Dispatch} object or if a |
|
* feature is enabled that is not compatible with |
|
* this port or is unsupported. |
|
* |
|
* @see javax.xml.bind.JAXBContext |
|
* @see WebServiceFeature |
|
* |
|
* @since 1.6, JAX-WS 2.1 |
|
**/ |
|
public Dispatch<Object> createDispatch(QName portName, |
|
JAXBContext context, Service.Mode mode, WebServiceFeature... features) { |
|
return delegate.createDispatch(portName, context, mode, features); |
|
} |
|
|
|
|
|
/** |
|
* Creates a {@code Dispatch} instance for use with JAXB |
|
* generated objects. If there |
|
* are any reference parameters in the |
|
* {@code endpointReference}, then those reference |
|
* parameters MUST appear as SOAP headers, indicating them to be |
|
* reference parameters, on all messages sent to the endpoint. |
|
* The {@code 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 {@code Service} instance or |
|
* from the metadata from the {@code endpointReference}. |
|
* If this {@code Service} instance has a WSDL and |
|
* the {@code endpointReference} |
|
* also has a WSDL in its metadata, then the WSDL from this instance |
|
* MUST be used. |
|
* If this {@code Service} instance does not have a WSDL and |
|
* the {@code endpointReference} does have a WSDL, then the |
|
* WSDL from the {@code endpointReference} MAY be used. |
|
* An implementation MUST be able to retrieve the {@code portName} from the |
|
* {@code endpointReference} metadata. |
|
* <p> |
|
* This method behavies the same as calling |
|
* <pre> |
|
* {@code dispatch = service.createDispatch(portName, context, mode, features);} |
|
* </pre> |
|
* where the {@code portName} is retrieved from the |
|
* WSDL or {@code endpointReference} metadata. |
|
* |
|
* @param endpointReference The {@code EndpointReference} |
|
* for the target service endpoint that will be invoked by the |
|
* returned {@code Dispatch} object. |
|
* @param context The JAXB context used to marshall and unmarshall |
|
* messages or message payloads. |
|
* @param 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. |
|
* @param features An array of {@code WebServiceFeatures} to configure on the |
|
* proxy. Supported features not in the {@code features |
|
* } parameter will have their default values. |
|
* |
|
* @return Dispatch instance |
|
* @throws WebServiceException |
|
* <UL> |
|
* <li>If there is any missing WSDL metadata |
|
* as required by this method. |
|
* <li>If the {@code endpointReference} metadata does |
|
* not match the {@code serviceName} or {@code portName} |
|
* of a WSDL associated |
|
* with this {@code Service} instance. |
|
* <li>If the {@code portName} cannot be determined |
|
* from the {@code EndpointReference} metadata. |
|
* <li>If any error in the creation of |
|
* the {@code Dispatch} object. |
|
* <li>if a feature is enabled that is not |
|
* compatible with this port or is unsupported. |
|
* </UL> |
|
* |
|
* @see javax.xml.bind.JAXBContext |
|
* @see WebServiceFeature |
|
* |
|
* @since 1.6, JAX-WS 2.1 |
|
**/ |
|
public Dispatch<Object> createDispatch(EndpointReference endpointReference, |
|
JAXBContext context, Service.Mode mode, |
|
WebServiceFeature... features) { |
|
return delegate.createDispatch(endpointReference, context, mode, features); |
|
} |
|
|
|
/** |
|
* Gets the name of this service. |
|
* @return Qualified name of this service |
|
**/ |
|
public QName getServiceName() { |
|
return delegate.getServiceName(); |
|
} |
|
|
|
/** |
|
* Returns an {@code Iterator} for the list of |
|
* {@code QName}s of service endpoints grouped by this |
|
* service |
|
* |
|
* @return Returns {@code java.util.Iterator} with elements |
|
* of type {@code javax.xml.namespace.QName}. |
|
* @throws WebServiceException If this Service class does not |
|
* have access to the required WSDL metadata. |
|
**/ |
|
public Iterator<javax.xml.namespace.QName> getPorts() { |
|
return delegate.getPorts(); |
|
} |
|
|
|
/** |
|
* Gets the location of the WSDL document for this Service. |
|
* |
|
* @return URL for the location of the WSDL document for |
|
* this service. |
|
**/ |
|
public java.net.URL getWSDLDocumentLocation() { |
|
return delegate.getWSDLDocumentLocation(); |
|
} |
|
|
|
/** |
|
* Returns the configured handler resolver. |
|
* |
|
* @return HandlerResolver The {@code HandlerResolver} being |
|
* used by this {@code Service} instance, or {@code null} |
|
* if there isn't one. |
|
**/ |
|
public HandlerResolver getHandlerResolver() { |
|
return delegate.getHandlerResolver(); |
|
} |
|
|
|
/** |
|
* Sets the {@code HandlerResolver} for this {@code Service} |
|
* instance. |
|
* <p> |
|
* 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. |
|
* |
|
* @param handlerResolver The {@code HandlerResolver} to use |
|
* for all subsequently created proxy/dispatch objects. |
|
* |
|
* @see javax.xml.ws.handler.HandlerResolver |
|
**/ |
|
public void setHandlerResolver(HandlerResolver handlerResolver) { |
|
delegate.setHandlerResolver(handlerResolver); |
|
} |
|
|
|
/** |
|
* Returns the executor for this {@code Service}instance. |
|
* |
|
* The executor is used for all asynchronous invocations that |
|
* require callbacks. |
|
* |
|
* @return The {@code java.util.concurrent.Executor} to be |
|
* used to invoke a callback. |
|
* |
|
* @see java.util.concurrent.Executor |
|
**/ |
|
public java.util.concurrent.Executor getExecutor() { |
|
return delegate.getExecutor(); |
|
} |
|
|
|
/** |
|
* Sets the executor for this {@code Service} instance. |
|
* |
|
* The executor is used for all asynchronous invocations that |
|
* require callbacks. |
|
* |
|
* @param executor The {@code java.util.concurrent.Executor} |
|
* to be used to invoke a callback. |
|
* |
|
* @throws SecurityException If the instance does not support |
|
* setting an executor for security reasons (e.g. the |
|
* necessary permissions are missing). |
|
* |
|
* @see java.util.concurrent.Executor |
|
**/ |
|
public void setExecutor(java.util.concurrent.Executor executor) { |
|
delegate.setExecutor(executor); |
|
} |
|
|
|
/** |
|
* Creates a {@code Service} instance. |
|
* |
|
* The specified WSDL document location and service qualified name MUST |
|
* uniquely identify a {@code wsdl:service} element. |
|
* |
|
* @param wsdlDocumentLocation {@code URL} for the WSDL document location |
|
* for the service |
|
* @param serviceName {@code QName} for the service |
|
* @return Service instance |
|
* @throws WebServiceException If any error in creation of the |
|
* specified service. |
|
**/ |
|
public static Service create( |
|
java.net.URL wsdlDocumentLocation, |
|
QName serviceName) { |
|
return new Service(wsdlDocumentLocation, serviceName); |
|
} |
|
|
|
/** |
|
* Creates a {@code 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 {@code wsdl:service} element. |
|
* |
|
* @param wsdlDocumentLocation {@code URL} for the WSDL document location |
|
* for the service |
|
* @param serviceName {@code QName} for the service |
|
* @param features Web Service features that must be configured on |
|
* the service. If the provider doesn't understand a feature, |
|
* it must throw a WebServiceException. |
|
* @return Service instance configured with requested web service features |
|
* @throws WebServiceException If any error in creation of the |
|
* specified service. |
|
* @since 1.7, JAX-WS 2.2 |
|
**/ |
|
public static Service create( |
|
java.net.URL wsdlDocumentLocation, |
|
QName serviceName, WebServiceFeature ... features) { |
|
return new Service(wsdlDocumentLocation, serviceName, features); |
|
} |
|
|
|
/** |
|
* Creates a {@code Service} instance. |
|
* |
|
* @param serviceName {@code QName} for the service |
|
* @return Service instance |
|
* @throws WebServiceException If any error in creation of the |
|
* specified service |
|
*/ |
|
public static Service create(QName serviceName) { |
|
return new Service(null, serviceName); |
|
} |
|
|
|
/** |
|
* Creates a {@code Service} instance. The created instance is |
|
* configured with the web service features. |
|
* |
|
* @param serviceName {@code QName} for the service |
|
* @param features Web Service features that must be configured on |
|
* the service. If the provider doesn't understand a feature, |
|
* it must throw a WebServiceException. |
|
* @return Service instance configured with requested web service features |
|
* @throws 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) { |
|
return new Service(null, serviceName, features); |
|
} |
|
} |
|
|
|
|
|
|
|
|