< prev index next >
src/java.xml.ws/share/classes/javax/xml/ws/Service.java
Print this page
@@ -1,7 +1,7 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
@@ -31,32 +31,32 @@
import javax.xml.bind.JAXBContext;
import javax.xml.ws.spi.ServiceDelegate;
import javax.xml.ws.spi.Provider;
/**
- * <code>Service</code> objects provide the client view of a Web service.
- * <p><code>Service</code> acts as a factory of the following:
+ * {@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</code> method. Alternatively, you can pass a
- * service endpoint interface to the unary <code>getPort</code> method
+ * {@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</code>
- * can be set by means of a <code>HandlerResolver</code>.
+ * <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</code> may be set on the service in order
+ * <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</code> and
+ * 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
@@ -65,12 +65,12 @@
**/
public class Service {
private ServiceDelegate delegate;
/**
- * The orientation of a dynamic client or service. <code>MESSAGE</code> provides
- * access to entire protocol message, <code>PAYLOAD</code> to protocol message
+ * 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, PAYLOAD }
protected Service(java.net.URL wsdlDocumentLocation, QName serviceName) {
@@ -85,13 +85,13 @@
this.getClass(), features);
}
/**
- * The <code>getPort</code> method returns a proxy. A service client
+ * The {@code getPort} method returns a proxy. A service client
* uses this proxy to invoke operations on the target
- * service endpoint. The <code>serviceEndpointInterface</code>
+ * service endpoint. The {@code serviceEndpointInterface}
* specifies the service endpoint interface that is supported by
* the created dynamic proxy instance.
*
* @param portName Qualified name of the service endpoint in
* the WSDL service description.
@@ -106,35 +106,35 @@
* <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</code>
- * or <code>portName</code> is specified.
+ * {@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</code> method returns a proxy. A service client
+ * The {@code getPort} method returns a proxy. A service client
* uses this proxy to invoke operations on the target
- * service endpoint. The <code>serviceEndpointInterface</code>
+ * service endpoint. The {@code serviceEndpointInterface}
* specifies the service endpoint interface that is supported by
* the created dynamic proxy instance.
*
* @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
- * </code> parameter will have their default values.
+ * 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:
@@ -142,12 +142,12 @@
* <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</code>
- * or <code>portName</code> is specified.
+ * {@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
@@ -160,12 +160,12 @@
return delegate.getPort(portName, serviceEndpointInterface, features);
}
/**
- * The <code>getPort</code> method returns a proxy. The parameter
- * <code>serviceEndpointInterface</code> specifies the service
+ * 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.
@@ -178,42 +178,42 @@
* <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</code>
+ * {@code serviceEndpointInterface}
* is specified.
* </UL>
**/
public <T> T getPort(Class<T> serviceEndpointInterface) {
return delegate.getPort(serviceEndpointInterface);
}
/**
- * The <code>getPort</code> method returns a proxy. The parameter
- * <code>serviceEndpointInterface</code> specifies the service
+ * 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 serviceEndpointInterface Service endpoint interface.
* @param features A list of WebServiceFeatures to configure on the
- * proxy. Supported features not in the <code>features
- * </code> parameter will have their default values.
+ * 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</code>
+ * {@code serviceEndpointInterface}
* is specified.
* <LI>If a feature is enabled that is not compatible
* with this port or is unsupported.
* </UL>
*
@@ -226,74 +226,74 @@
return delegate.getPort(serviceEndpointInterface, features);
}
/**
- * The <code>getPort</code> method returns a proxy.
- * The parameter <code>endpointReference</code> specifies the
+ * 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</code>, then those reference
+ * {@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</code> address MUST be used
+ * The {@code endpointReference's} address MUST be used
* for invocations on the endpoint.
- * The parameter <code>serviceEndpointInterface</code> specifies
+ * 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</code> instance or
- * from the metadata from the <code>endpointReference</code>.
- * If this <code>Service</code> instance has a WSDL and
- * the <code>endpointReference</code> metadata
+ * 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</code> instance does not have a WSDL and
- * the <code>endpointReference</code> does have a WSDL, then the
- * WSDL from the <code>endpointReference</code> MAY 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</code> instance has a known proxy
+ * 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);</code>
+ * {@code port = service.getPort(portName, serviceEndpointInterface);}
* </pre>
- * where the <code>portName</code> is retrieved from the
- * metadata of the <code>endpointReference</code> or from the
- * <code>serviceEndpointInterface</code> and the WSDL
- * associated with this <code>Service</code> instance.
+ * 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 endpointReference The <code>EndpointReference</code>
+ * @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</code> to configure on the
- * proxy. Supported features not in the <code>features
- * </code> parameter will have their default values.
+ * @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</code> metadata does
- * not match the <code>serviceName</code> of this
- * <code>Service</code> instance.
- * <LI>If a <code>portName</code> cannot be extracted
- * from the WSDL or <code>endpointReference</code> metadata.
+ * <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</code>
+ * {@code endpointReference}
* is specified.
* <LI>If an invalid
- * <code>serviceEndpointInterface</code>
+ * {@code serviceEndpointInterface}
* is specified.
* <LI>If a feature is enabled that is not compatible
* with this port or is unsupported.
* </UL>
*
@@ -305,11 +305,11 @@
}
/**
* 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</code>instances.
+ * {@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
@@ -323,59 +323,59 @@
delegate.addPort(portName, bindingId, endpointAddress);
}
/**
- * Creates a <code>Dispatch</code> instance for use with objects of
+ * Creates a {@code Dispatch} instance for use with objects of
* the client's choosing.
*
* @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>, <code>javax.xml.soap.SOAPMessage</code>
- * and <code>javax.activation.DataSource</code>, depending on
+ * {@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</code> object.
+ * 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</code> instance for use with objects of
+ * Creates a {@code Dispatch} instance for use with objects of
* the client's choosing.
*
* @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> and <code>javax.xml.soap.SOAPMessage</code>.
+ * {@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</code>
- * when type is <code>SOAPMessage</code>.
- * @param features A list of <code>WebServiceFeatures</code> to configure on the
- * proxy. Supported features not in the <code>features
- * </code> parameter will have their default values.
+ * 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</code> object or if a
+ * 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
@@ -388,68 +388,68 @@
return delegate.createDispatch(portName, type, mode, features);
}
/**
- * Creates a <code>Dispatch</code> instance for use with objects of
+ * Creates a {@code Dispatch} instance for use with objects of
* the client's choosing. If there
* are any reference parameters in the
- * <code>endpointReference</code>, then those reference
+ * {@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</code> address MUST be used
+ * 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</code> instance or
- * from the metadata from the <code>endpointReference</code>.
- * If this <code>Service</code> instance has a WSDL and
- * the <code>endpointReference</code>
+ * 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</code> instance does not have a WSDL and
- * the <code>endpointReference</code> does have a WSDL, then the
- * WSDL from the <code>endpointReference</code> MAY be used.
- * An implementation MUST be able to retrieve the <code>portName</code> from the
- * <code>endpointReference</code> metadata.
+ * 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);</code>
+ * {@code dispatch = service.createDispatch(portName, type, mode, features);}
* </pre>
- * where the <code>portName</code> is retrieved from the
- * WSDL or <code>EndpointReference</code> metadata.
+ * where the {@code portName} is retrieved from the
+ * WSDL or {@code EndpointReference} metadata.
*
- * @param endpointReference The <code>EndpointReference</code>
+ * @param endpointReference The {@code EndpointReference}
* for the target service endpoint that will be invoked by the
- * returned <code>Dispatch</code> object.
+ * 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</code> and <code>javax.xml.soap.SOAPMessage</code>.
+ * {@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</code>
- * when type is <code>SOAPMessage</code>.
- * @param features An array of <code>WebServiceFeatures</code> to configure on the
- * proxy. Supported features not in the <code>features
- * </code> parameter will have their default values.
+ * 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</code> metadata does
- * not match the <code>serviceName</code> or <code>portName</code>
+ * <li>If the {@code endpointReference} metadata does
+ * not match the {@code serviceName} or {@code portName}
* of a WSDL associated
- * with this <code>Service</code> instance.
- * <li>If the <code>portName</code> cannot be determined
- * from the <code>EndpointReference</code> metadata.
+ * 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</code> object.
+ * 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
@@ -463,11 +463,11 @@
WebServiceFeature... features) {
return delegate.createDispatch(endpointReference, type, mode, features);
}
/**
- * Creates a <code>Dispatch</code> instance for use with JAXB
+ * 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.
@@ -477,39 +477,39 @@
* 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</code> object.
+ * 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</code> instance for use with JAXB
+ * 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</code> to configure on the
- * proxy. Supported features not in the <code>features
- * </code> parameter will have their default values.
+ * @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</code> object or if a
+ * 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
@@ -521,67 +521,67 @@
return delegate.createDispatch(portName, context, mode, features);
}
/**
- * Creates a <code>Dispatch</code> instance for use with JAXB
+ * Creates a {@code Dispatch} instance for use with JAXB
* generated objects. If there
* are any reference parameters in the
- * <code>endpointReference</code>, then those reference
+ * {@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</code> address MUST be used
+ * 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</code> instance or
- * from the metadata from the <code>endpointReference</code>.
- * If this <code>Service</code> instance has a WSDL and
- * the <code>endpointReference</code>
+ * 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</code> instance does not have a WSDL and
- * the <code>endpointReference</code> does have a WSDL, then the
- * WSDL from the <code>endpointReference</code> MAY be used.
- * An implementation MUST be able to retrieve the <code>portName</code> from the
- * <code>endpointReference</code> metadata.
+ * 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);</code>
+ * {@code dispatch = service.createDispatch(portName, context, mode, features);}
* </pre>
- * where the <code>portName</code> is retrieved from the
- * WSDL or <code>endpointReference</code> metadata.
+ * where the {@code portName} is retrieved from the
+ * WSDL or {@code endpointReference} metadata.
*
- * @param endpointReference The <code>EndpointReference</code>
+ * @param endpointReference The {@code EndpointReference}
* for the target service endpoint that will be invoked by the
- * returned <code>Dispatch</code> object.
+ * 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</code> to configure on the
- * proxy. Supported features not in the <code>features
- * </code> parameter will have their default values.
+ * @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</code> metadata does
- * not match the <code>serviceName</code> or <code>portName</code>
+ * <li>If the {@code endpointReference} metadata does
+ * not match the {@code serviceName} or {@code portName}
* of a WSDL associated
- * with this <code>Service</code> instance.
- * <li>If the <code>portName</code> cannot be determined
- * from the <code>EndpointReference</code> metadata.
+ * 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</code> object.
+ * 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
@@ -602,16 +602,16 @@
public QName getServiceName() {
return delegate.getServiceName();
}
/**
- * Returns an <code>Iterator</code> for the list of
- * <code>QName</code>s of service endpoints grouped by this
+ * Returns an {@code Iterator} for the list of
+ * {@code QName}s of service endpoints grouped by this
* service
*
- * @return Returns <code>java.util.Iterator</code> with elements
- * of type <code>javax.xml.namespace.QName</code>.
+ * @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();
@@ -628,57 +628,57 @@
}
/**
* Returns the configured handler resolver.
*
- * @return HandlerResolver The <code>HandlerResolver</code> being
- * used by this <code>Service</code> instance, or <code>null</code>
+ * @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</code> for this <code>Service</code>
+ * 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</code> to use
+ * @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</code>instance.
+ * 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</code> to be
+ * @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</code> instance.
+ * 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</code>
+ * @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).
@@ -688,37 +688,37 @@
public void setExecutor(java.util.concurrent.Executor executor) {
delegate.setExecutor(executor);
}
/**
- * Creates a <code>Service</code> instance.
+ * Creates a {@code Service} instance.
*
* The specified WSDL document location and service qualified name MUST
- * uniquely identify a <code>wsdl:service</code> element.
+ * uniquely identify a {@code wsdl:service} element.
*
- * @param wsdlDocumentLocation <code>URL</code> for the WSDL document location
+ * @param wsdlDocumentLocation {@code URL} for the WSDL document location
* for the service
- * @param serviceName <code>QName</code> for the service
+ * @param serviceName {@code QName} for the service
* @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</code> instance. The created instance is
+ * 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</code> element.
+ * uniquely identify a {@code wsdl:service} element.
*
- * @param wsdlDocumentLocation <code>URL</code> for the WSDL document location
+ * @param wsdlDocumentLocation {@code URL} for the WSDL document location
* for the service
- * @param serviceName <code>QName</code> 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.
* @throws WebServiceException If any error in creation of the
* specified service.
@@ -729,25 +729,25 @@
QName serviceName, WebServiceFeature ... features) {
return new Service(wsdlDocumentLocation, serviceName, features);
}
/**
- * Creates a <code>Service</code> instance.
+ * Creates a {@code Service} instance.
*
- * @param serviceName <code>QName</code> for the service
+ * @param serviceName {@code QName} for the service
* @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</code> instance. The created instance is
+ * Creates a {@code Service} instance. The created instance is
* configured with the web service features.
*
- * @param serviceName <code>QName</code> 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.
* @throws WebServiceException If any error in creation of the
* specified service
< prev index next >