[jbossws-commits] JBossWS SVN: r1622 - in trunk: . src/main/java/javax/xml/ws src/main/java/javax/xml/ws/handler src/main/java/javax/xml/ws/handler/soap src/main/java/javax/xml/ws/http src/main/java/javax/xml/ws/soap src/main/java/javax/xml/ws/spi src/main/java/javax/xml/ws/wsaddressing src/main/java/org/jboss/ws/core/jaxws src/main/java/org/jboss/ws/core/jaxws/binding src/main/java/org/jboss/ws/core/jaxws/client src/main/java/org/jboss/ws/core/jaxws/handler src/main/java/org/jboss/ws/core/jaxws/spi src/tes

Author: thomas.diesler(a)jboss.com Date: 2006-12-11 06:06:03 -0500 (Mon, 11 Dec 2006) New Revision: 1622 Added: trunk/src/main/java/javax/xml/ws/Action.java trunk/src/main/java/javax/xml/ws/EndpointReference.java trunk/src/main/java/javax/xml/ws/FaultAction.java trunk/src/main/java/javax/xml/ws/RespectBinding.java trunk/src/main/java/javax/xml/ws/RespectBindingFeature.java trunk/src/main/java/javax/xml/ws/WebServiceFeature.java trunk/src/main/java/javax/xml/ws/soap/Addressing.java trunk/src/main/java/javax/xml/ws/soap/AddressingFeature.java trunk/src/main/java/javax/xml/ws/soap/MTOM.java trunk/src/main/java/javax/xml/ws/soap/MTOMFeature.java trunk/src/main/java/javax/xml/ws/spi/WebServiceFeatureAnnotation.java trunk/src/main/java/javax/xml/ws/wsaddressing/ trunk/src/main/java/javax/xml/ws/wsaddressing/W3CEndpointReference.java trunk/src/main/java/javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.java trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/TestEndpoint.java trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/TestEndpointService.java trunk/src/test/resources/jaxws/eardeployment/META-INF/ trunk/src/test/resources/jaxws/eardeployment/META-INF/wsdl/ trunk/src/test/resources/jaxws/eardeployment/META-INF/wsdl/TestEndpoint.wsdl Removed: trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/EndpointInterface.java Modified: trunk/STATUS_AND_NEWS.txt trunk/src/main/java/javax/xml/ws/AsyncHandler.java trunk/src/main/java/javax/xml/ws/Binding.java trunk/src/main/java/javax/xml/ws/BindingProvider.java trunk/src/main/java/javax/xml/ws/BindingType.java trunk/src/main/java/javax/xml/ws/Dispatch.java trunk/src/main/java/javax/xml/ws/Endpoint.java trunk/src/main/java/javax/xml/ws/Holder.java trunk/src/main/java/javax/xml/ws/LogicalMessage.java trunk/src/main/java/javax/xml/ws/ProtocolException.java trunk/src/main/java/javax/xml/ws/Provider.java trunk/src/main/java/javax/xml/ws/RequestWrapper.java trunk/src/main/java/javax/xml/ws/Response.java trunk/src/main/java/javax/xml/ws/ResponseWrapper.java trunk/src/main/java/javax/xml/ws/Service.java trunk/src/main/java/javax/xml/ws/ServiceMode.java trunk/src/main/java/javax/xml/ws/WebEndpoint.java trunk/src/main/java/javax/xml/ws/WebFault.java trunk/src/main/java/javax/xml/ws/WebServiceClient.java trunk/src/main/java/javax/xml/ws/WebServiceContext.java trunk/src/main/java/javax/xml/ws/WebServiceException.java trunk/src/main/java/javax/xml/ws/WebServicePermission.java trunk/src/main/java/javax/xml/ws/WebServiceProvider.java trunk/src/main/java/javax/xml/ws/WebServiceRef.java trunk/src/main/java/javax/xml/ws/WebServiceRefs.java trunk/src/main/java/javax/xml/ws/handler/Handler.java trunk/src/main/java/javax/xml/ws/handler/HandlerResolver.java trunk/src/main/java/javax/xml/ws/handler/LogicalHandler.java trunk/src/main/java/javax/xml/ws/handler/LogicalMessageContext.java trunk/src/main/java/javax/xml/ws/handler/MessageContext.java trunk/src/main/java/javax/xml/ws/handler/PortInfo.java trunk/src/main/java/javax/xml/ws/handler/soap/SOAPHandler.java trunk/src/main/java/javax/xml/ws/handler/soap/SOAPMessageContext.java trunk/src/main/java/javax/xml/ws/http/HTTPBinding.java trunk/src/main/java/javax/xml/ws/http/HTTPException.java trunk/src/main/java/javax/xml/ws/soap/SOAPBinding.java trunk/src/main/java/javax/xml/ws/soap/SOAPFaultException.java trunk/src/main/java/javax/xml/ws/spi/Provider.java trunk/src/main/java/javax/xml/ws/spi/ServiceDelegate.java trunk/src/main/java/org/jboss/ws/core/jaxws/WebServiceContextImpl.java trunk/src/main/java/org/jboss/ws/core/jaxws/binding/BindingImpl.java trunk/src/main/java/org/jboss/ws/core/jaxws/binding/BindingProviderImpl.java trunk/src/main/java/org/jboss/ws/core/jaxws/binding/HTTPBindingJAXWS.java trunk/src/main/java/org/jboss/ws/core/jaxws/binding/MessageBinding.java trunk/src/main/java/org/jboss/ws/core/jaxws/binding/PayloadBinding.java trunk/src/main/java/org/jboss/ws/core/jaxws/binding/SOAP11BindingJAXWS.java trunk/src/main/java/org/jboss/ws/core/jaxws/binding/SOAP12BindingJAXWS.java trunk/src/main/java/org/jboss/ws/core/jaxws/binding/SOAPBindingJAXWS.java trunk/src/main/java/org/jboss/ws/core/jaxws/client/ClientImpl.java trunk/src/main/java/org/jboss/ws/core/jaxws/client/DispatchImpl.java trunk/src/main/java/org/jboss/ws/core/jaxws/handler/SOAPMessageContextJAXWS.java trunk/src/main/java/org/jboss/ws/core/jaxws/spi/EndpointImpl.java trunk/src/main/java/org/jboss/ws/core/jaxws/spi/ProviderImpl.java trunk/src/main/java/org/jboss/ws/core/jaxws/spi/ServiceDelegateImpl.java trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/EJB3Bean.java trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/EarEjb3TestCase.java trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/EarJseTestCase.java trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/JSEBean.java Log: Synch JAXWS API with JAXWS-API-2_1 Modified: trunk/STATUS_AND_NEWS.txt =================================================================== --- trunk/STATUS_AND_NEWS.txt 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/STATUS_AND_NEWS.txt 2006-12-11 11:06:03 UTC (rev 1622) @@ -1,5 +1,20 @@ # $Id$ +11-Dec-2006 +----------- + +* Synchronize JAXWS API with 2.1 +* Add unimplemented methods + BindingImpl: getBindingID + HTTPBindingJAXWS: getBindingID + SOAP11BindingJAXWS: getBindingID + SOAP12BindingJAXWS: getBindingID + MessageBindingJAXWS: getBindingID + PayloadBindingJAXWS: getBindingID + BindingProvider: getEndpointReference + ClientImpl: getEndpointReference + ServiceDelegateImpl: methods with WebServiceFeature + 23-Nov-2006 ----------- Added: trunk/src/main/java/javax/xml/ws/Action.java =================================================================== --- trunk/src/main/java/javax/xml/ws/Action.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/Action.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -0,0 +1,144 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package javax.xml.ws; + +// $Id$ + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * The <code>Action</code> annotation allows explicit association of <code>Action</code> + * message addressing property with <code>input</code>, <code>output</code>, and + * <code>fault</code> messages of the mapped WSDL operation. + * <p> + * This annotation can be specified on each method of a service endpoint interface. + * For such a method, the mapped operation in the generated WSDL + * contains explicit <code>wsaw:Action</code> attribute on the WSDL <code>input</code>, + * <code>output</code> and <code>fault</code> messages of the WSDL <code>operation</code> + * based upon which attributes of the <code>Action</code> annotation have been specified. + * <p> + * <b>Example 1</b>: Specify explicit values for <code>Action</code> message addressing property + * for <code>input</code> and <code>output</code> messages. + * + * <pre> + * &#64;javax.jws.WebService + * public class AddNumbersImpl { + * &#64;javax.xml.ws.Action( + * input="http://example.com/inputAction";, + * output="http://example.com/outputAction") + * public int addNumbers(int number1, int number2) { + * return number1 + number2; + * } + * } + * </pre> + * + * The generated WSDL looks like: + * <pre> + * &lt;definitions targetNamespace=&quot;http://example.com/numbers&quot; ...&gt; + * ... + * &lt;portType name=&quot;AddNumbersPortType&quot;&gt; + * &lt;operation name=&quot;AddNumbers&quot;&gt; + * &lt;input message=&quot;tns:AddNumbersInput&quot; name=&quot;Parameters&quot; + * wsaw:Action=&quot;http://example.com/inputAction&quot;/&gt; + * &lt;output message=&quot;tns:AddNumbersOutput&quot; name=&quot;Result&quot; + * wsaw:Action=&quot;http://example.com/outputAction&quot;/&gt; + * &lt;/operation&gt; + * &lt;portType&gt; + * ... + * &lt;definitions&gt; + * </pre> + * + * <p> + * <b>Example 2</b>: Specify explicit value for <code>Action</code> message addressing property + * for only the <code>input</code> message. The default values are used for the + * <code>output</code> message. + * + * <pre> + * &#64;javax.jws.WebService + * public class AddNumbersImpl { + * &#64;javax.xml.ws.Action(input=&quot;http://example.com/inputAction&quot;) + * public int addNumbers(int number1, int number2) { + * return number1 + number2; + * } + * } + * </pre> + * + * The generated WSDL looks like: + * + * <pre> + * &lt;definitions targetNamespace=&quot;http://example.com/numbers&quot; ...&gt; + * ... + * &lt;portType name=&quot;AddNumbersPortType&quot;&gt; + * &lt;operation name=&quot;AddNumbers&quot;&gt; + * &lt;input message=&quot;tns:AddNumbersInput&quot; name=&quot;Parameters&quot; + * wsaw:Action=&quot;http://example.com/inputAction&quot;/&gt; + * &lt;output message=&quot;tns:AddNumbersOutput&quot; name=&quot;Result&quot;/&gt; + * &lt;/operation&gt; + * &lt;portType&gt; + * ... + * &lt;definitions&gt; + * </pre> + * + * It is legitimate to specify an explicit value for <code>Action</code> message addressing property for + * <code>output</code> message only. In this case, a default value of <code>wsaw:Action</code> is used + * for the <code>input</code> message. + * + * <p> + * <b>Example 3</b>: See <a href="FaultAction.html">FaultAction</a> annotation for an example of + * how to specify an explicit value for <code>Action</code> message addressing property for the + * <code>fault</code> message. + * + * @see FaultAction + * + * @since JAX-WS 2.1 + */ + +@Documented +(a)Retention(RetentionPolicy.RUNTIME) +(a)Target(ElementType.METHOD) +public @interface Action { + /** + * Explicit value of <code>Action</code> message addressing property for the <code>input</code> + * message of the operation. If the value is "", then no <code>wsaw:Action</code> + * is generated. + */ + String input() default ""; + + /** + * Explicit value of <code>Action</code> message addressing property for the <code>output</code> + * message of the operation. If the value is "", then no <code>wsaw:Action</code> + * is generated. + */ + String output() default ""; + + /** + * Explicit value of <code>Action</code> message addressing property for the <code>fault</code> + * message(s) of the operation. Each exception that is mapped to a fault and requires explicit + * <code>Action</code> message addressing property, need to be specified as a value in this property + * using <a href="FaultAction.html">FaultAction</a> annotation. + */ + FaultAction[] fault() default {}; +} Property changes on: trunk/src/main/java/javax/xml/ws/Action.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Modified: trunk/src/main/java/javax/xml/ws/AsyncHandler.java =================================================================== --- trunk/src/main/java/javax/xml/ws/AsyncHandler.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/AsyncHandler.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,14 +21,14 @@ */ package javax.xml.ws; -/** - * The AsyncHandler interface is implemented by clients that wish to receive - * callback notification of the completion of service endpoint operations - * invoked asynchronously. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ +// $Id$ + +/** The <code>AsyncHandler</code> interface is implemented by + * clients that wish to receive callback notification of the completion of + * service endpoint operations invoked asynchronously. + * + * @since JAX-WS 2.0 + **/ public interface AsyncHandler<T> { Modified: trunk/src/main/java/javax/xml/ws/Binding.java =================================================================== --- trunk/src/main/java/javax/xml/ws/Binding.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/Binding.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,24 +21,28 @@ */ package javax.xml.ws; -/** - * The Binding interface is the base interface for JAX-WS protocol bindings. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ +// $Id$ + + +/** The <code>Binding</code> interface is the base interface + * for JAX-WS protocol bindings. + * + * @since JAX-WS 2.0 + **/ public interface Binding { - /** Gets a copy of the handler chain for a protocol binding instance. - * If the returned chain is modified a call to <code>setHandlerChain</code> + /** + * Gets a copy of the handler chain for a protocol binding instance. + * If the returned chain is modified a call to <code>setHandlerChain</code> * is required to configure the binding instance with the new chain. * * @return java.util.List<javax.xml.ws.handler.HandlerInfo> Handler chain - **/ + */ public java.util.List<javax.xml.ws.handler.Handler> getHandlerChain(); - /** Sets the handler chain for the protocol binding instance. + /** + * Sets the handler chain for the protocol binding instance. * * @param chain A List of handler configuration entries * @throws WebServiceException On an error in the configuration of @@ -47,6 +51,16 @@ * operation is not supported. This may be done to * avoid any overriding of a pre-configured handler * chain. - **/ + */ public void setHandlerChain(java.util.List<javax.xml.ws.handler.Handler> chain); + + /** + * Get the URI for this binding instance. + * + * @return String The binding identifier for the port. + * Never returns <code>null</code> + * + * @since JAX-WS 2.1 + */ + String getBindingID(); } Modified: trunk/src/main/java/javax/xml/ws/BindingProvider.java =================================================================== --- trunk/src/main/java/javax/xml/ws/BindingProvider.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/BindingProvider.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,15 +21,20 @@ */ package javax.xml.ws; +// $Id$ + import java.util.Map; -/** - * The BindingProvider interface provides access to the protocol binding and - * associated context objects for request and response message processing. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ +import javax.xml.ws.wsaddressing.W3CEndpointReference; + +/** The <code>BindingProvider</code> interface provides access to the + * protocol binding and associated context objects for request and + * response message processing. + * + * @since JAX-WS 2.0 + * + * @see javax.xml.ws.Binding + **/ public interface BindingProvider { /** Standard property: User name for authentication. @@ -42,33 +47,33 @@ **/ public static final String PASSWORD_PROPERTY = "javax.xml.ws.security.auth.password"; - /** Standard property: Target service endpoint address. The - * URI scheme for the endpoint address specification must - * correspond to the protocol/transport binding for the + /** Standard property: Target service endpoint address. The + * URI scheme for the endpoint address specification MUST + * correspond to the protocol/transport binding for the * binding in use. * <p>Type: java.lang.String **/ public static final String ENDPOINT_ADDRESS_PROPERTY = "javax.xml.ws.service.endpoint.address"; - /** Standard property: This boolean property is used by a service + /** Standard property: This boolean property is used by a service * client to indicate whether or not it wants to participate in * a session with a service endpoint. If this property is set to * true, the service client indicates that it wants the session - * to be maintained. If set to false, the session is not maintained. + * to be maintained. If set to false, the session is not maintained. * The default value for this property is false. * <p>Type: java.lang.Boolean **/ public static final String SESSION_MAINTAIN_PROPERTY = "javax.xml.ws.session.maintain"; - /** Standard property for SOAPAction. This boolean property - * indicates whether or not SOAPAction is to be used. The + /** Standard property for SOAPAction. This boolean property + * indicates whether or not SOAPAction is to be used. The * default value of this property is false indicating that * the SOAPAction is not used. * <p>Type: <code>java.lang.Boolean</code> **/ public static final String SOAPACTION_USE_PROPERTY = "javax.xml.ws.soap.http.soapaction.use"; - /** Standard property for SOAPAction. Indicates the SOAPAction + /** Standard property for SOAPAction. Indicates the SOAPAction * URI if the <code>javax.xml.ws.soap.http.soapaction.use</code> * property is set to <code>true</code>. * <p>Type: <code>java.lang.String</code> @@ -77,7 +82,7 @@ /** Get the context that is used to initialize the message context * for request messages. - * + * * Modifications to the request context do not affect the message context of * either synchronous or asynchronous operations that have already been * started. @@ -86,8 +91,8 @@ **/ Map<String, Object> getRequestContext(); - /** Get the context that resulted from processing a response message. - * + /** Get the context that resulted from processing a response message. + * * The returned context is for the most recently completed synchronous * operation. Subsequent synchronous operation invocations overwrite the * response context. Asynchronous operations return their response context @@ -98,9 +103,73 @@ **/ Map<String, Object> getResponseContext(); - /** Get the Binding for this binding provider. + /** Get the Binding for this binding provider. * * @return The Binding for this binding provider. **/ Binding getBinding(); + + /** + * Returns the <code>EndpointReference</code> associated with + * this <code>BindingProvider</code> instance. + * <p> + * If the Binding for this <code>bindingProvider</code> is + * either SOAP1.1/HTTP or SOAP1.2/HTTP, then a + * <code>W3CEndpointReference</code> MUST be returned. + * If the returned <code>EndpointReference</code> is a + * <code>W3CEndpointReference</code> it MUST contain + * the <code>wsaw:ServiceName</code> element and the + * <code>wsaw:EndpointName</code> attribute on the + * <code>wsaw:ServiceName</code>. It SHOULD contain + * the embedded WSDL in the <code>wsa:Metadata</code> element + * if there is an associated WSDL. The + * <code>wsaw:InterfaceName</code> MAY also be present. + * <br> + * See <a href="http://www.w3.org/TR/2006/CR-ws-addr-wsdl-20060529/"> + * WS-Addressing - WSDL 1.0</a>. + * + * @return EndpointReference of the target endpoint associated with this + * <code>BindingProvider</code> instance. + * + * @throws java.lang.UnsupportedOperationException If this + * <code>BindingProvider</code> uses the XML/HTTP binding. + * + * @see W3CEndpointReference + * + * @since JAX-WS 2.1 + */ + public EndpointReference getEndpointReference(); + + /** + * Returns the <code>EndpointReference</code> associated with + * this <code>BindingProvider</code> instance. The instance + * returned will be of type <code>clazz</code>. + * <p> + * If the returned <code>EndpointReference</code> is a + * <code>W3CEndpointReference</code> it MUST contain + * the <code>wsaw:ServiceName</code> element and the + * <code>wsaw:EndpointName</code> attribute on the + * <code>wsaw:ServiceName</code>. It SHOULD contain + * the embedded WSDL in the <code>wsa:Metadata</code> element + * if there is an associated WSDL. The + * <code>wsaw:InterfaceName</code> MAY also be present. + * <br> + * See <a href="http://www.w3.org/TR/2006/CR-ws-addr-wsdl-20060529/"> + * WS-Addressing - WSDL 1.0</a>. + * + * @param clazz Specifies the type of <code>EndpointReference</code> + * that MUST be returned. + + * @return EndpointReference of the target endpoint associated with this + * <code>BindingProvider</code> instance. MUST be of type + * <code>clazz</code>. + + * @throws WebServiceException If the Class <code>clazz</code> + * is not supported by this implementation. + * @throws java.lang.UnsupportedOperationException If this + * <code>BindingProvider</code> uses the XML/HTTP binding. + * + * @since JAX-WS 2.1 + */ + public <T extends EndpointReference> T getEndpointReference(Class<T> clazz); } Modified: trunk/src/main/java/javax/xml/ws/BindingType.java =================================================================== --- trunk/src/main/java/javax/xml/ws/BindingType.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/BindingType.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,6 +21,8 @@ */ package javax.xml.ws; +// $Id$ + import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; @@ -28,20 +30,19 @@ import java.lang.annotation.Target; /** - * The BindingType annotation is used to specify the binding to use for a web service - * endpoint implementation class. - * - * This annotation may be overriden programmatically or via deployment descriptors, - * depending on the platform in use. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ + * The <code>BindingType</code> annotation is used to + * specify the binding to use for a web service + * endpoint implementation class. As well as specify + * additional features that may be enabled. + * + * @since JAX-WS 2.0 + * + **/ + @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented -public @interface BindingType -{ +public @interface BindingType { /** * A binding identifier (a URI). * If not specified, the default is the SOAP 1.1 / HTTP binding. Modified: trunk/src/main/java/javax/xml/ws/Dispatch.java =================================================================== --- trunk/src/main/java/javax/xml/ws/Dispatch.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/Dispatch.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,16 +21,18 @@ */ package javax.xml.ws; +// $Id$ + import java.util.concurrent.Future; -/** - * The Dispatch interface provides support for the dynamic invocation of a service - * endpoint operations. The javax.xml.ws.Service interface acts as a factory for - * the creation of Dispatch instances. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ +/** The <code>Dispatch</code> interface provides support + * for the dynamic invocation of a service endpoint operations. The + * <code>javax.xml.ws.Service</code> + * interface acts as a factory for the creation of <code>Dispatch</code> + * instances. + * + * @since JAX-WS 2.0 + **/ public interface Dispatch<T> extends BindingProvider { @@ -83,7 +85,7 @@ * @param handler The handler object that will receive the * response to the operation invocation. * @return A <code>Future</code> object that may be used to check the status - * of the operation invocation. This object must not be used to try to + * of the operation invocation. This object MUST NOT be used to try to * obtain the results of the operation - the object returned from * <code>Future<?>.get()</code> is implementation dependent * and any use of it will result in non-portable behaviour. @@ -96,7 +98,7 @@ * interaction mode. The operation invocation is logically non-blocking, * subject to the capabilities of the underlying protocol, no results * are returned. When - * the protocol in use is SOAP/HTTP, this method must block until + * the protocol in use is SOAP/HTTP, this method MUST block until * an HTTP response code has been received or an error occurs. * * The client is responsible for ensuring that the <code>msg</code> object Modified: trunk/src/main/java/javax/xml/ws/Endpoint.java =================================================================== --- trunk/src/main/java/javax/xml/ws/Endpoint.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/Endpoint.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,171 +21,345 @@ */ package javax.xml.ws; -import java.net.MalformedURLException; -import java.net.URL; +// $Id$ + import java.util.List; import java.util.Map; -import java.util.concurrent.Executor; -import javax.xml.transform.Source; -import javax.xml.ws.soap.SOAPBinding; import javax.xml.ws.spi.Provider; +import javax.xml.ws.wsaddressing.W3CEndpointReference; +import org.w3c.dom.Element; + /** * A Web service endpoint. - * - * Endpoints are created using the static methods defined in this class. - * An endpoint is always tied to one Binding and one implementor, both set at - * endpoint creation time. - * - * An endpoint is either in a published or an unpublished state. - * The publish methods can be used to start publishing an endpoint, - * at which point it starts accepting incoming requests. - * Conversely, the stop method can be used to stop accepting incoming - * requests and take the endpoint down. Once stopped, an endpoint cannot - * be published again. - * - * An Executor may be set on the endpoint in order to gain better control - * over the threads used to dispatch incoming requests. For instance, thread - * pooling with certain parameters can be enabled by creating a ThreadPoolExecutor - * and registering it with the endpoint. - * - * Handler chains can be set using the contained Binding. - * - * An endpoint may have a list of metadata documents, such as WSDL and XMLSchema - * documents, bound to it. At publishing time, the JAX-WS implementation will try - * to reuse as much of that metadata as possible instead of generating new one - * based on the annotations present on the implementor. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ + * + * <p>Endpoints are created using the static methods defined in this + * class. An endpoint is always tied to one <code>Binding</code> + * and one implementor, both set at endpoint creation time. + * + * <p>An endpoint is either in a published or an unpublished state. + * The <code>publish</code> methods can be used to start publishing + * an endpoint, at which point it starts accepting incoming requests. + * Conversely, the <code>stop</code> method can be used to stop + * accepting incoming requests and take the endpoint down. + * Once stopped, an endpoint cannot be published again. + * + * <p>An <code>Executor</code> may be set on the endpoint in order + * to gain better control over the threads used to dispatch incoming + * requests. For instance, thread pooling with certain parameters + * can be enabled by creating a <code>ThreadPoolExecutor</code> and + * registering it with the endpoint. + * + * <p>Handler chains can be set using the contained <code>Binding</code>. + * + * <p>An endpoint may have a list of metadata documents, such as WSDL + * and XMLSchema documents, bound to it. At publishing time, the + * JAX-WS implementation will try to reuse as much of that metadata + * as possible instead of generating new one based on the annotations + * present on the implementor. + * + * @since JAX-WS 2.0 + * + * @see javax.xml.ws.Binding + * @see javax.xml.ws.BindingType + * @see javax.xml.ws.soap.SOAPBinding + * @see java.util.concurrent.Executor + * + **/ public abstract class Endpoint { + /** Standard property: name of WSDL service. + * <p>Type: javax.xml.namespace.QName + **/ public static final String WSDL_SERVICE = "javax.xml.ws.wsdl.service"; + + /** Standard property: name of WSDL port. + * <p>Type: javax.xml.namespace.QName + **/ public static final String WSDL_PORT = "javax.xml.ws.wsdl.port"; - public Endpoint() - { - } - /** - * Creates an endpoint with the specified implementor object. If there is a binding specified via a BindingType annotation then it - * MUST be used else a default of SOAP 1.1 / HTTP binding MUST be used. - * - * The newly created endpoint may be published by calling one of the javax.xml.ws.Endpoint#publish(String) - * and javax.xml.ws.Endpoint#publish(Object) methods. - */ + * Creates an endpoint with the specified implementor object. If there is + * a binding specified via a BindingType annotation then it MUST be used else + * a default of SOAP 1.1 / HTTP binding MUST be used. + * <p> + * The newly created endpoint may be published by calling + * one of the javax.xml.ws.Endpoint#publish(String) and + * javax.xml.ws.Endpoint#publish(Object) methods. + * + * + * @param implementor The endpoint implementor. + * + * @return The newly created endpoint. + * + **/ public static Endpoint create(Object implementor) { return create(null, implementor); } /** - * Creates an endpoint with the specified binding type and implementor object. - * - * The newly created endpoint may be published by calling one of the javax.xml.ws.Endpoint#publish(String) - * and javax.xml.ws.Endpoint#publish(Object) methods. - */ + * Creates an endpoint with the specified binding type and + * implementor object. + * <p> + * The newly created endpoint may be published by calling + * one of the javax.xml.ws.Endpoint#publish(String) and + * javax.xml.ws.Endpoint#publish(Object) methods. + * + * @param bindingId A URI specifying the binding to use. If the bindingID is + * <code>null</code> and no binding is specified via a BindingType + * annotation then a default SOAP 1.1 / HTTP binding MUST be used. + * + * @param implementor The endpoint implementor. + * + * @return The newly created endpoint. + * + **/ public static Endpoint create(String bindingId, Object implementor) { return Provider.provider().createEndpoint(bindingId, implementor); } - /** Returns the binding for this endpoint. */ + /** + * Returns the binding for this endpoint. + * + * @return The binding for this endpoint + **/ public abstract Binding getBinding(); - /** Returns the implementation object for this endpoint. */ + /** + * Returns the implementation object for this endpoint. + * + * @return The implementor for this endpoint + **/ public abstract Object getImplementor(); /** - * Publishes this endpoint at the given address. The necessary server infrastructure will be created and configured by the JAX-WS - * implementation using some default configuration. In order to get more control over the server configuration, - * please use the javax.xml.ws.Endpoint#publish(Object) method instead. - * - * @param A URI specifying the address to use. The address must be compatible with the binding specified at the time the endpoint was created. - */ + * Publishes this endpoint at the given address. + * The necessary server infrastructure will be created and + * configured by the JAX-WS implementation using some default configuration. + * In order to get more control over the server configuration, please + * use the javax.xml.ws.Endpoint#publish(Object) method instead. + * + * @param address A URI specifying the address to use. The address + * MUST be compatible with the binding specified at the + * time the endpoint was created. + * + * @throws java.lang.IllegalArgumentException + * If the provided address URI is not usable + * in conjunction with the endpoint's binding. + * + * @throws java.lang.IllegalStateException + * If the endpoint has been published already or it has been stopped. + **/ public abstract void publish(String address); /** - * Creates and publishes an endpoint for the specified implementor object at the given address. - * - * The necessary server infrastructure will be created and configured by the JAX-WS implementation using some default configuration. - * In order to get more control over the server configuration, please use the javax.xml.ws.Endpoint#create(String,Object) - * and javax.xml.ws.Endpoint#publish(Object) method instead. - */ + * Creates and publishes an endpoint for the specified implementor + * object at the given address. + * <p> + * The necessary server infrastructure will be created and + * configured by the JAX-WS implementation using some default configuration. + * + * In order to get more control over the server configuration, please + * use the javax.xml.ws.Endpoint#create(String,Object) and + * javax.xml.ws.Endpoint#publish(Object) method instead. + * + * @param 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. + * @param implementor The endpoint implementor. + * + * @return The newly created endpoint. + * + **/ public static Endpoint publish(String address, Object implementor) { - // 5.5 Conformance (Endpoint publish(String address, Object implementor) Method): The effect of invoking the - // publishmethod on an EndpointMUST be the same as first invoking the createmethod with the binding - // ID appropriate to the URL scheme used by the address, then invoking the publish(String address) - // method on the resulting endpoint. - String bindingId = getBindingFromAddress(address); - Endpoint endpoint = Endpoint.create(bindingId, implementor); - endpoint.publish(address); - - return endpoint; + return Provider.provider().createAndPublishEndpoint(address, implementor); } - public static String getBindingFromAddress(String address) - { - String bindingId; - try - { - URL url = new URL(address); - String protocol = url.getProtocol(); - if (protocol.startsWith("http")) - { - bindingId = SOAPBinding.SOAP11HTTP_BINDING; - } - else - { - throw new IllegalArgumentException("Unsupported protocol: " + address); - } - } - catch (MalformedURLException e) - { - throw new IllegalArgumentException("Invalid endpoint address: " + address); - } - return bindingId; - } - /** - * Publishes this endpoint at the provided server context. - * A server context encapsulates the server infrastructure and addressing information for a particular transport. - * For a call to this method to succeed, the server context passed as an argument to it must be compatible with the endpoint's binding. - * - * @param serverContext An object representing a server context to be used for publishing the endpoint. - */ + * Publishes this endpoint at the provided server context. + * A server context encapsulates the server infrastructure + * and addressing information for a particular transport. + * For a call to this method to succeed, the server context + * passed as an argument to it MUST be compatible with the + * endpoint's binding. + * + * @param serverContext An object representing a server + * context to be used for publishing the endpoint. + * + * @throws java.lang.IllegalArgumentException + * If the provided server context is not + * supported by the implementation or turns + * out to be unusable in conjunction with the + * endpoint's binding. + * + * @throws java.lang.IllegalStateException + * If the endpoint has been published already or it has been stopped. + **/ public abstract void publish(Object serverContext); - /** Stops publishing this endpoint. If the endpoint is not in a published state, this method has not effect. */ + /** + * Stops publishing this endpoint. + * + * If the endpoint is not in a published state, this method + * has not effect. + * + **/ public abstract void stop(); - /** Returns true if the endpoint has been published. */ + /** + * Returns true if the endpoint is in the published state. + * + * @return <code>true</code> if the endpoint is in the published state. + **/ public abstract boolean isPublished(); - /** Returns a list of metadata documents for the service. */ - public abstract List<Source> getMetadata(); + /** + * Returns a list of metadata documents for the service. + * + * @return <code>List&lt;javax.xml.transform.Source&gt;</code> A list of metadata documents for the service + **/ + public abstract List<javax.xml.transform.Source> getMetadata(); - /** Sets the metadata for this endpoint. */ - public abstract void setMetadata(List<Source> list); + /** + * Sets the metadata for this endpoint. + * + * @param metadata A list of XML document sources containing + * metadata information for the endpoint (e.g. + * WSDL or XML Schema documents) + * + * @throws java.lang.IllegalStateException If the endpoint + * has already been published. + **/ + public abstract void setMetadata(List<javax.xml.transform.Source> metadata); - /** Returns the executor for this Endpointinstance. The executor is used to dispatch an incoming request to the implementor object. */ - public abstract Executor getExecutor(); + /** + * Returns the executor for this <code>Endpoint</code>instance. + * + * The executor is used to dispatch an incoming request to + * the implementor object. + * + * @return The <code>java.util.concurrent.Executor</code> to be + * used to dispatch a request. + * + * @see java.util.concurrent.Executor + **/ + public abstract java.util.concurrent.Executor getExecutor(); /** - * Sets the executor for this Endpoint instance. The executor is used to dispatch an incoming request to the implementor object. - * If this Endpoint is published using the publish(Object) method and the specified server context defines its own threading behavior, - * the executor may be ignored. - */ - public abstract void setExecutor(Executor executor); + * Sets the executor for this <code>Endpoint</code> instance. + * + * The executor is used to dispatch an incoming request to + * the implementor object. + * + * If this <code>Endpoint</code> is published using the + * <code>publish(Object)</code> method and the specified server + * context defines its own threading behavior, the executor + * may be ignored. + * + * @param executor The <code>java.util.concurrent.Executor</code> + * to be used to dispatch a request. + * + * @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 abstract void setExecutor(java.util.concurrent.Executor executor); - /** Returns the property bag for this Endpoint instance. */ + /** + * Returns the property bag for this <code>Endpoint</code> instance. + * + * @return Map&lt;String,Object&gt; The property bag + * associated with this instance. + **/ public abstract Map<String, Object> getProperties(); - /** Sets the property bag for this Endpoint instance. */ - public abstract void setProperties(Map<String, Object> map); + /** + * Sets the property bag for this <code>Endpoint</code> instance. + * + * @param properties The property bag associated with + * this instance. + **/ + public abstract void setProperties(Map<String, Object> properties); -} \ No newline at end of file + /** + * Returns the <code>EndpointReference</code> associated with + * this <code>Endpoint</code> instance. + * <p> + * If the Binding for this <code>bindingProvider</code> is + * either SOAP1.1/HTTP or SOAP1.2/HTTP, then a + * <code>W3CEndpointReference</code> MUST be returned. + * If the returned <code>EndpointReference</code> is a + * <code>W3CEndpointReference</code> it MUST contain + * the <code>wsaw:ServiceName</code> element and the + * <code>wsaw:EndpointName</code> attribute on the + * <code>wsaw:ServiceName</code>. It SHOULD contain + * the embedded WSDL in the <code>wsa:Metadata</code> element + * if there is an associated WSDL. The + * <code>wsaw:InterfaceName</code> MAY also be present. + * <br> + * See <a href="http://www.w3.org/TR/2006/CR-ws-addr-wsdl-20060529/"> + * WS-Addressing - WSDL 1.0</a>. + * + * @param referenceParameters Reference parameters to be associated with the + * returned <code>EndpointReference</code> instance. + * @return EndpointReference of this <code>Endpoint</code> instance. + * If the returned <code>EndpointReference</code> is of type + * <code>W3CEndpointReference</code> then it MUST contain the + * the specified <code>referenceParameters</code>. + + * @throws WebServiceException If any error in the creation of + * the <code>EndpointReference</code> or if the <code>Endpoint</code> is + * not in the published state. + * @throws UnsupportedOperationException If this <code>BindingProvider</code> + * uses the XML/HTTP binding. + * + * @see W3CEndpointReference + * + * @since JAX-WS 2.1 + **/ + public abstract EndpointReference getEndpointReference(Element... referenceParameters); + + /** + * Returns the <code>EndpointReference</code> associated with + * this <code>Endpoint</code> instance. + * <p> + * If the returned <code>EndpointReference</code> is a + * <code>W3CEndpointReference</code> it MUST contain + * the <code>wsaw:ServiceName</code> element and the + * <code>wsaw:EndpointName</code> attribute on the + * <code>wsaw:ServiceName</code>. It SHOULD contain + * the embedded WSDL in the <code>wsa:Metadata</code> element + * if there is an associated WSDL. The + * <code>wsaw:InterfaceName</code> MAY also be present. + * <br> + * See <a href="http://www.w3.org/TR/2006/CR-ws-addr-wsdl-20060529/"> + * WS-Addressing - WSDL 1.0</a>. + * + * @param referenceParameters Reference parameters to be associated with the + * returned <code>EndpointReference</code> instance. + * @return EndpointReference of type <code>clazz</code> of this + * <code>Endpoint<code> instance. + * If the returned <code>EndpointReference</code> is of type + * <code>W3CEndpointReference</code> then it MUST contain the + * the specified <code>referenceParameters</code>. + + * @throws WebServiceException If any error in the creation of + * the <code>EndpointReference</code> or if the <code>Endpoint</code> is + * not in the published state or if the <code>clazz</code> is not a supported + * <code>EndpointReference</code> type. + * @throws UnsupportedOperationException If this <code>BindingProvider</code> + * uses the XML/HTTP binding. + * + * + * @since JAX-WS 2.1 + **/ + public abstract <T extends EndpointReference> T getEndpointReference(Class<T> clazz, Element... referenceParameters); +} Added: trunk/src/main/java/javax/xml/ws/EndpointReference.java =================================================================== --- trunk/src/main/java/javax/xml/ws/EndpointReference.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/EndpointReference.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -0,0 +1,188 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package javax.xml.ws; + +// $Id$ + +import java.io.StringWriter; + +import javax.xml.transform.Result; +import javax.xml.transform.Source; +import javax.xml.transform.stream.StreamResult; +import javax.xml.ws.spi.Provider; +import javax.xml.ws.wsaddressing.W3CEndpointReference; + +/** + * This class represents an WS-Addressing EndpointReference + * which is a remote reference to a web service endpoint. + * See <a href="http://www.w3.org/TR/2006/REC-ws-addr-core-20060509/"> + * WS-Addressing</a> + * for more information on WS-Addressing EndpointReferences. + * <p> + * This class is immutable as the typical web service developer + * need not be concerned with its contents. The web service + * developer should use this class strictly as a mechanism to + * reference a remote web service endpoint. See the {@link Service} APIs + * that clients can use to that utilize an <code>EndpointReference</code>. + * See the {@link javax.xml.ws.Endpoint}, and + * {@link javax.xml.ws.BindingProvider} APIs on how + * <code>EndpointReferences</code> can be created for published + * endpoints. + * <p> + * Concrete implementations of this class will represent + * an <code>EndpointReference</code> for a particular version of Addressing. + * For example the {@link W3CEndpointReference} is for use + * with W3C WS-Addressing 1.0 - Core Recommendation. + * If JAX-WS implementors need to support different versions + * of addressing, they should write their own + * <code>EndpointReference</code> subclass for that version. + * This will allow a JAX-WS implementation to createEndpointReference + * vendor specific <code>EndpointReferences</code> that that + * vendor can use to flag a different version of + * addressing. + * <p> + * Web service developers that wish to pass or return + * <code>EndpointReferences</code> in Java methods in an + * SEI should use + * concrete instances of an <code>EndpointReference</code> such + * as the <code>W3CEndpointReferendce</code>. This way the + * schema mapped from the SEI will be more descriptive of the + * type of endpoint reference being passed. + * <p> + * JAX-WS implementors are expected to extract the XML infoset + * from an <CODE>EndpointReferece</CODE> using the + * <code>{@link EndpointReference#writeTo}</code> + * method. + * <p> + * JAXB will bind this class to xs:anyType. If a better binding + * is desired, web services developers should use a concrete + * subclass such as {@link W3CEndpointReference}. + * + * @see W3CEndpointReference + * @see Service + * @since JAX-WS 2.1 + */ +//@XmlTransient // to treat this class like Object as far as databinding is concerned (proposed JAXB 2.1 feature) +public abstract class EndpointReference +{ + // + //Default constructor to be only called by derived types. + // + protected EndpointReference() + { + }; + + /** + * Factory method to read an EndpointReference from the infoset contained in + * <code>eprInfoset</code>. This method delegates to the vendor specific + * implementation of the {@link javax.xml.ws.spi.Provider#readEndpointReference} method. + * + * @param eprInfoset The <code>EndpointReference<code> infoset to be unmarshalled + * + * @return the EndpointReference unmarshalled from <code>eprInfoset</code> + * never <code>null</code> + * @throws WebServiceException + * if an error occurs while creating the + * <code>EndpointReference</code> from the <CODE>eprInfoset</CODE> + * @throws java.lang.IllegalArgumentException + * if the null <code>eprInfoset</tt> value is given. + */ + public static EndpointReference readFrom(Source eprInfoset) + { + return Provider.provider().readEndpointReference(eprInfoset); + } + + /** + * write this EndpointReference to the specified infoset format + * @throws WebServiceException + * if there is an error writing the + * EndpointReference to the specified <code>result</code>. + * + * @throws java.lang.IllegalArgumentException + * If the null <code>result</tt> value is given. + */ + public abstract void writeTo(Result result); + + /** + * The getPort method returns a proxy. If there + * are any reference parameters in the + * <code>EndpointReference</code> instance, then those reference + * parameters MUST appear as SOAP headers, indicating them to be + * reference parameters, on all messages sent to the endpoint. + * The parameter <code>serviceEndpointInterface</code> specifies + * the service endpoint interface that is supported by the + * returned proxy. + * The <code>EndpointReference</code> instance specifies the + * endpoint that will be invoked 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 Metadata from this <code>EndpointReference</code> or from + * annotations on the <code>serviceEndpointInterface</code>. + * <p> + * Because this port is not created from a Service object, handlers + * will not automatically be configured, and the HandlerResolver + * and Executor cannot be get or set for this port. The + * <code>BindingProvider().getBinding().setHandlerChain()</code> + * method can be used to manually configure handlers for this port. + * + * + * @param serviceEndpointInterface Service endpoint interface + * @param features An array of WebServiceFeatures to configure on the + * proxy. Supported features not in the <code>features + * </code> 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 this + * <code>endpointReference</code> + * is invalid + * <LI>If an illegal + * <code>serviceEndpointInterface</code> + * is specified + * <LI>If feature is enabled that is not compatible with + * this port or is unsupported. + * </UL> + * + * @see java.lang.reflect.Proxy + * @see WebServiceFeature + **/ + public <T> T getPort(Class<T> serviceEndpointInterface, WebServiceFeature... features) + { + return Provider.provider().getPort(this, serviceEndpointInterface, features); + } + + /** + * Displays EPR infoset for debugging convenience. + */ + public String toString() + { + StringWriter w = new StringWriter(); + writeTo(new StreamResult(w)); + return w.toString(); + } +} Property changes on: trunk/src/main/java/javax/xml/ws/EndpointReference.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Added: trunk/src/main/java/javax/xml/ws/FaultAction.java =================================================================== --- trunk/src/main/java/javax/xml/ws/FaultAction.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/FaultAction.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -0,0 +1,171 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package javax.xml.ws; + +// $Id$ + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * The <code>FaultAction</code> annotation is used inside an <a href="Action.html"> + * Action</a> annotation to allow an explicit association of <code>Action</code> message + * addressing property with the <code>fault</code> messages of the WSDL operation mapped from + * the exception class. + * <p> + * The <code>fault</code> message in the generated WSDL operation mapped for <code>className</code> + * class contains explicit <code>wsaw:Action</code> attribute. + * + * <p> + * <b>Example 1</b>: Specify explicit values for <code>Action</code> message addressing + * property for the <code>input</code>, <code>output</code> and <code>fault</code> message + * if the Java method throws only one service specific exception. + * + * <pre> + * &#64;javax.jws.WebService + * public class AddNumbersImpl { + * &#64;javax.xml.ws.Action( + * input=&quot;http://example.com/inputAction&quot;, + * output=&quot;http://example.com/outputAction&quot;, + * fault = { + * &#64;javax.xml.ws.FaultAction(className=AddNumbersException.class, value=&quot;http://example.com/faultAction&quot;) + * }) + * public int addNumbers(int number1, int number2) + * throws AddNumbersException { + * return number1 + number2; + * } + * } + * </pre> + * + * The generated WSDL looks like: + * + * <pre> + * &lt;definitions targetNamespace=&quot;http://example.com/numbers&quot; ...&gt; + * ... + * &lt;portType name=&quot;AddNumbersPortType&quot;&gt; + * &lt;operation name=&quot;AddNumbers&quot;&gt; + * &lt;input message=&quot;tns:AddNumbersInput&quot; name=&quot;Parameters&quot; + * wsaw:Action=&quot;http://example.com/inputAction&quot;/&gt; + * &lt;output message=&quot;tns:AddNumbersOutput&quot; name=&quot;Result&quot; + * wsaw:Action=&quot;http://example.com/outputAction&quot;/&gt; + * &lt;fault message=&quot;tns:AddNumbersException&quot; name=&quot;AddNumbersException&quot; + * wsaw:Action=&quot;http://example.com/faultAction&quot;/&gt; + * &lt;/operation&gt; + * &lt;portType&gt; + * ... + * &lt;definitions&gt; + * </pre> + * + * <p> + * Example 2: Here is an example that shows how to specify explicit values for <code>Action</code> + * message addressing property if the Java method throws only one service specific exception, + * without specifying the values for <code>input</code> and <code>output</code> messages. + * + * <pre> + * &#64;javax.jws.WebService + * public class AddNumbersImpl { + * &#64;javax.xml.ws.Action( + * fault = { + * &#64;javax.xml.ws.FaultAction(className=AddNumbersException.class, value=&quot;http://example.com/faultAction&quot;) + * }) + * public int addNumbers(int number1, int number2) + * throws AddNumbersException { + * return number1 + number2; + * } + * } + * </pre> + * + * The generated WSDL looks like: + * + * <pre> + * &lt;definitions targetNamespace=&quot;http://example.com/numbers&quot; ...&gt; + * ... + * &lt;portType name=&quot;AddNumbersPortType&quot;&gt; + * &lt;operation name=&quot;AddNumbers&quot;&gt; + * &lt;input message=&quot;tns:AddNumbersInput&quot; name=&quot;Parameters&quot;/&gt; + * &lt;output message=&quot;tns:AddNumbersOutput&quot; name=&quot;Result&quot;/&gt; + * &lt;fault message=&quot;tns:addNumbersFault&quot; name=&quot;InvalidNumbers&quot; + * wsa:Action=&quot;http://example.com/addnumbers/fault&quot;/&gt; + * &lt;/operation&gt; + * &lt;portType&gt; + * ... + * &lt;definitions&gt; + * </pre> + * + * <p> + * Example 3: Here is an example that shows how to specify explicit values for <code>Action</code> + * message addressing property if the Java method throws more than one service specific exception. + * + * <pre> + * &#64;javax.jws.WebService + * public class AddNumbersImpl { + * &#64;javax.xml.ws.Action( + * fault = { + * &#64;javax.xml.ws.FaultAction(className=AddNumbersException.class, value=&quot;http://example.com/addFaultAction&quot;) + * &#64;javax.xml.ws.FaultAction(className=TooBigNumbersException.class, value=&quot;http://example.com/toobigFaultAction&quot;) + * }) + * public int addNumbers(int number1, int number2) + * throws AddNumbersException, TooBigNumbersException { + * return number1 + number2; + * } + * } + * </pre> + * + * The generated WSDL looks like: + * + * <pre> + * &lt;definitions targetNamespace=&quot;http://example.com/numbers&quot; ...&gt; + * ... + * &lt;portType name=&quot;AddNumbersPortType&quot;&gt; + * &lt;operation name=&quot;AddNumbers&quot;&gt; + * &lt;input message=&quot;tns:AddNumbersInput&quot; name=&quot;Parameters&quot;/&gt; + * &lt;output message=&quot;tns:AddNumbersOutput&quot; name=&quot;Result&quot;/&gt; + * &lt;fault message=&quot;tns:addNumbersFault&quot; name=&quot;AddNumbersException&quot; + * wsa:Action=&quot;http://example.com/addnumbers/fault&quot;/&gt; + * &lt;fault message=&quot;tns:tooBigNumbersFault&quot; name=&quot;TooBigNumbersException&quot; + * wsa:Action=&quot;http://example.com/toobigFaultAction&quot;/&gt; + * &lt;/operation&gt; + * &lt;portType&gt; + * ... + * &lt;definitions&gt; + * </pre> + * + * @since JAX-WS 2.1 + */ + +@Documented +(a)Retention(RetentionPolicy.RUNTIME) +(a)Target(ElementType.METHOD) +public @interface FaultAction { + /** + * Name of the exception class + */ + Class className(); + + /** + * Value of <code>Action</code> message addressing property for the exception + */ + String value() default ""; +} Property changes on: trunk/src/main/java/javax/xml/ws/FaultAction.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Modified: trunk/src/main/java/javax/xml/ws/Holder.java =================================================================== --- trunk/src/main/java/javax/xml/ws/Holder.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/Holder.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,12 +21,13 @@ */ package javax.xml.ws; -/** - * Holds a value of type T. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ +// $Id$ + +/** + * Holds a value of type <code>T</code>. + * + * @since JAX-WS 2.0 + **/ public final class Holder<T> { Modified: trunk/src/main/java/javax/xml/ws/LogicalMessage.java =================================================================== --- trunk/src/main/java/javax/xml/ws/LogicalMessage.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/LogicalMessage.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,16 +21,17 @@ */ package javax.xml.ws; +// $Id$ + import javax.xml.bind.JAXBContext; import javax.xml.transform.Source; -/** - * The LogicalMessage interface represents a protocol agnostic XML message - * and contains methods that provide access to the payload of the message. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ +/** The <code>LogicalMessage</code> interface represents a + * protocol agnostic XML message and contains methods that + * provide access to the payload of the message. + * + * @since JAX-WS 2.0 + **/ public interface LogicalMessage { Modified: trunk/src/main/java/javax/xml/ws/ProtocolException.java =================================================================== --- trunk/src/main/java/javax/xml/ws/ProtocolException.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/ProtocolException.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,15 +21,15 @@ */ package javax.xml.ws; -/** - * The ProtocolException class is a base class for exceptions related to a specific - * protocol binding. Subclasses are used to communicate protocol level fault - * information to clients and may be used on the server to control the protocol - * specific fault representation. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ +// $Id$ + +/** The <code>ProtocolException</code> class is a + * base class for exceptions related to a specific protocol binding. Subclasses + * are used to communicate protocol level fault information to clients and may + * be used on the server to control the protocol specific fault representation. + * + * @since JAX-WS 2.0 + **/ public class ProtocolException extends WebServiceException { /** Modified: trunk/src/main/java/javax/xml/ws/Provider.java =================================================================== --- trunk/src/main/java/javax/xml/ws/Provider.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/Provider.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,15 +21,27 @@ */ package javax.xml.ws; +// $Id$ + /** - * Service endpoints may implement the Provider interface as a dynamic alternative to an - * SEI. Implementations are required to support Provider<Source> and Provider<SOAPMessage>. - * The ServiceMode annotation can be used to control whether the Provider instance will - * receive entire protocol messages or just message payloads. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ + * <p>Service endpoints may implement the <code>Provider</code> + * interface as a dynamic alternative to an SEI. + * + * <p>Implementations are required to support <code>Provider&lt;Source&gt;</code>, + * <code>Provider&lt;SOAPMessage&gt;</code> and + * <code>Provider&lt;DataSource&gt;</code>, depending on the binding + * in use and the service mode. + * + * <p>The <code>ServiceMode</code> annotation can be used to control whether + * the <code>Provider</code> instance will receive entire protocol messages + * or just message payloads. + * + * @since JAX-WS 2.0 + * + * @see javax.xml.transform.Source + * @see javax.xml.soap.SOAPMessage + * @see javax.xml.ws.ServiceMode + **/ public interface Provider<T> { @@ -39,7 +51,7 @@ * @param request The request message or message payload. * @return The response message or message payload. May be null if there is no response. - * @throws WebServiceException if there is an error processing request. + * @throws WebServiceException If there is an error processing request. * The cause of the WebServiceException may be set to a subclass * of ProtocolException to control the protocol level * representation of the exception. Modified: trunk/src/main/java/javax/xml/ws/RequestWrapper.java =================================================================== --- trunk/src/main/java/javax/xml/ws/RequestWrapper.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/RequestWrapper.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,29 +21,31 @@ */ package javax.xml.ws; +// $Id$ + import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; -/** - * Used to annotate methods in the Service Endpoint Interface with the request wrapper - * bean to be used at runtime. The default value of the localName is the operationName, - * as defined in WebMethod annotation and the targetNamespace is the target namespace of - * the SEI. +/** + + * Used to annotate methods in the Service Endpoint Interface with the request + * wrapper bean to be used at runtime. The default value of the localName is + * the operationName, as defined in WebMethod annotation and the + * targetNamespace is the target namespace of the SEI. + * <p> When starting from Java this annotation is used resolve + * overloading conflicts in document literal mode. Only the className + * is required in this case. * - * When starting from Java this annotation is used resolve overloading conflicts in - * document literal mode. Only the className is required in this case. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ + * @since JAX-WS 2.0 + **/ + @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented -public @interface RequestWrapper -{ +public @interface RequestWrapper { /** * Elements local name. **/ Added: trunk/src/main/java/javax/xml/ws/RespectBinding.java =================================================================== --- trunk/src/main/java/javax/xml/ws/RespectBinding.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/RespectBinding.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -0,0 +1,107 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package javax.xml.ws; + +// $Id$ + +import java.lang.annotation.Documented; +import java.lang.annotation.Target; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import javax.xml.ws.spi.WebServiceFeatureAnnotation; + +/** + * This feature clarifies the use of the <code>wsdl:binding</code> + * in a JAX-WS runtime. + * <p> + * This feature is only useful with web services that have an + * associated WSDL. Enabling this feature requires that a JAX-WS + * implementation inspect the <code>wsdl:binding</code> for an + * endpoint at runtime to make sure that all <code>wsdl:extensions</code> + * that have the <code>required</code> attribute set to <code>true</code> + * are understood and are being used. + * <p> + * The following describes the affects of this feature with respect + * to be enabled or disabled: + * <ul> + * <li> ENABLED: In this Mode, a JAX-WS runtime MUST assure that all + * required <code>wsdl:binding</code> extensions are either understood + * and used by the runtime, or explicitly disabled by the web service + * application. A web service application can disable a particular + * extension that has a know <code>WebServiceFeature</code> using + * either the {@link BindingType#features} element on the server + * or one of the following methods on the client: + * <ul> + * <li>{@link Service#getPort(QName,Class,WebServiceFeature...)} + * <li>{@link Service#getPort(Class,WebServiceFeature...)} + * <li>{@link Service#getPort(EndpointReference,Class,WebServiceFeature...)} + * <li>{@link Service#createDispatch(QName,Class, + * Service.Mode mode,WebServiceFeature...)} + * <li>{@link Service#createDispatch(EndpointReference, + * Class,Service.Mode, + * WebServiceFeature...)} + * <li>{@link Service#createDispatch(QName, + * JAXBContext, Service.Mode, WebServiceFeature...)} + * <li>{@link Service#createDispatch(EndpointReference, + * JAXBContext, Service.Mode, WebServiceFeature...)} + * <li>{@link EndpointReference#getPort(Class,WebServiceFeature...)} + * <li>One of the <code>getXXXPort(WebServiceFeatures...)</code> methods on a + * generated <code>Service</code>. + * </ul> + * The runtime MUST also make sure that binding of + * SEI parameters/return values respect the <code>wsdl:binding</code>. + * With this feature enabled, if a required + * <code>wsdl:binding</code> extension is in the WSDL and it is not + * supported by a JAX-WS runtime and it has not + * been explicitly turned off by the web service developer, then + * that JAX-WS runtime MUST behave appropriately based on whether it is + * on the client or server: + * <UL> + * <li>Client: runtime MUST throw a + * <code>WebServiceException</code> no sooner than when one of the methods + * above is invoked but no later than the first invocation of an endpoint + * operation. + * <li>throw a WebServiceException and the endpoint MUST fail to deploy + * </ul> + * <li> DISABLED: In this Mode, an implementation may choose whether + * to inspect the <code>wsdl:binding<code> or not and to what degree + * the <code>wsdl:binding</code> will be inspected. For example, + * one implementation may choose to behave as if this feature is enabled, + * another implementation may only choose to verify the SEI's + * parameter/return type bindings. + * </ul> + * + * @see javax.xml.ws.RespectBindingFeature + * + * @since JAX-WS 2.1 + */ +(a)Target(ElementType.TYPE) +(a)Retention(RetentionPolicy.RUNTIME) +@Documented +@WebServiceFeatureAnnotation(id = RespectBindingFeature.ID, bean = RespectBindingFeature.class) +public @interface RespectBinding { + /** + * Specifies if this feature is enabled or disabled. + */ + boolean enabled() default true; +} Property changes on: trunk/src/main/java/javax/xml/ws/RespectBinding.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Added: trunk/src/main/java/javax/xml/ws/RespectBindingFeature.java =================================================================== --- trunk/src/main/java/javax/xml/ws/RespectBindingFeature.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/RespectBindingFeature.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -0,0 +1,130 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package javax.xml.ws; + +// $Id$ + +import javax.xml.ws.WebServiceFeature; +import javax.xml.ws.WebServiceException; +import javax.xml.ws.spi.Provider; + +/** + * This feature clarifies the use of the <code>wsdl:binding</code> + * in a JAX-WS runtime. + * <p> + * This feature is only useful with web services that have an + * associated WSDL. Enabling this feature requires that a JAX-WS + * implementation inspect the <code>wsdl:binding</code> for an + * endpoint at runtime to make sure that all <code>wsdl:extensions</code> + * that have the <code>required</code> attribute set to <code>true</code> + * are understood and are being used. + * <p> + * The following describes the affects of this feature with respect + * to be enabled or disabled: + * <ul> + * <li> ENABLED: In this Mode, a JAX-WS runtime MUST assure that all + * required <code>wsdl:binding</code> extensions are either understood + and used by the runtime, or explicitly disabled by the web service + * application. A web service application can disable a particular + * extension that has a know <code>WebServiceFeature</code> using + * either the {@link BindingType#features} element on the server + * or one of the following methods on the client: + * <ul> + * <li>{@link Service#getPort(QName,Class,WebServiceFeature...)} + * <li>{@link Service#getPort(Class,WebServiceFeature...)} + * <li>{@link Service#getPort(EndpointReference,Class,WebServiceFeature...)} + * <li>{@link Service#createDispatch(QName,Class, + * Service.Mode mode,WebServiceFeature...)} + * <li>{@link Service#createDispatch(EndpointReference, + * Class,Service.Mode, + * WebServiceFeature...)} + * <li>{@link Service#createDispatch(QName, + * JAXBContext, Service.Mode, WebServiceFeature...)} + * <li>{@link Service#createDispatch(EndpointReference, + * JAXBContext, Service.Mode, WebServiceFeature...)} + * <li>{@link EndpointReference#getPort(Class,WebServiceFeature...)} + * <li>One of the <code>getXXXPort(WebServiceFeatures...)</code> methods on a + * generated <code>Service</code>. + * </ul> + * The runtime MUST also make sure that binding of + * SEI parameters/return values respect the <code>wsdl:binding</code>. + * With this feature enabled, if a required + * <code>wsdl:binding</code> extension is in the WSDL and it is not + * supported by a JAX-WS runtime and it has not + * been explicitly turned off by the web service developer, then + * that JAX-WS runtime MUST behave appropriately based on whether it is + * on the client or server: + * <UL> + * <li>Client: runtime MUST throw a + * <code>WebServiceException</code> no sooner than when one of the methods + * above is invoked but no later than the first invocation of an endpoint + * operation. + * <li>throw a WebServiceException and the endpoint MUST fail to deploy + * </ul> + * <li> DISABLED: In this Mode, an implementation may choose whether + * to inspect the <code>wsdl:binding<code> or not and to what degree + * the <code>wsdl:binding</code> will be inspected. For example, + * one implementation may choose to behave as if this feature is enabled, + * another implementation may only choose to verify the SEI's + * parameter/return type bindings. + * </ul> + * + * @see javax.xml.ws.soap.AddressingFeature + * + * @since JAX-WS 2.1 + */ +public final class RespectBindingFeature extends WebServiceFeature +{ + /** + * + * Constant value identifying the RespectBindingFeature + */ + public static final String ID = "javax.xml.ws.InspectBindingFeature"; + + /** + * Create an <code>RespectBindingFeature</code>. + * The instance created will be enabled. + */ + public RespectBindingFeature() + { + this.enabled = true; + } + + /** + * Create an RespectBindingFeature + * + * @param enabled specifies whether this feature should + * be enabled or not. + */ + public RespectBindingFeature(boolean enabled) + { + this.enabled = enabled; + } + + /** + * {@inheritDoc} + */ + public String getID() + { + return ID; + } +} Property changes on: trunk/src/main/java/javax/xml/ws/RespectBindingFeature.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Modified: trunk/src/main/java/javax/xml/ws/Response.java =================================================================== --- trunk/src/main/java/javax/xml/ws/Response.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/Response.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,21 +21,24 @@ */ package javax.xml.ws; +// $Id$ + import java.util.Map; import java.util.concurrent.Future; -/** - * The Response interface provides methods used to obtain the payload and context of a - * message sent in response to an operation invocation. - * - * For asynchronous operation invocations it provides additional methods to check the - * status of the request. The get(...) methods may throw the standard set of exceptions - * and their cause may be a RemoteException or a WebServiceException that represents the - * error that occured during the asynchronous method invocation. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ +/** The <code>Response</code> interface provides methods used to obtain the + * payload and context of a message sent in response to an operation + * invocation. + * + * <p>For asynchronous operation invocations it provides additional methods + * to check the status of the request. The <code>get(...)</code> methods may + * throw the standard + * set of exceptions and their cause may be a RemoteException or a + * WebServiceException that represents the error that occured during the + * asynchronous method invocation.</p> + * + * @since JAX-WS 2.0 + **/ public interface Response<T> extends Future<T> { /** Gets the contained response context. Modified: trunk/src/main/java/javax/xml/ws/ResponseWrapper.java =================================================================== --- trunk/src/main/java/javax/xml/ws/ResponseWrapper.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/ResponseWrapper.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,42 +21,53 @@ */ package javax.xml.ws; +// $Id$ + import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; -/** +/** * Used to annotate methods in the Service Endpoint Interface with the response - * wrapper bean to be used at runtime.The default value of the localName is the - * operationName as defined in WebMethod annotation appended with Response and - * the targetNamespace is the target namespace of the SEI. + * wrapper bean to be used at runtime. The default value of the localName is + * the operationName as defined in WebMethod annotation appended with + * Response and the targetNamespace is the target namespace of the SEI. + * <p> When starting from Java this annotation is used resolve + * overloading conflicts in document literal mode. Only the className + * is required in this case. * - * When starting from Java this annotation is used resolve overloading conflicts - * in document literal mode. Only the className is required in this case. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ + * @since JAX-WS 2.0 + **/ + @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented -public @interface ResponseWrapper -{ +public @interface ResponseWrapper { /** + * Elements local name. + **/ + public String localName() default ""; /** + * Elements namespace name. + **/ + public String targetNamespace() default ""; /** + * Response wrapper bean name. + **/ + public String className() default ""; + } Modified: trunk/src/main/java/javax/xml/ws/Service.java =================================================================== --- trunk/src/main/java/javax/xml/ws/Service.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/Service.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,9 +21,9 @@ */ package javax.xml.ws; -import java.net.URL; +// $Id$ + import java.util.Iterator; -import java.util.concurrent.Executor; import javax.xml.bind.JAXBContext; import javax.xml.namespace.QName; @@ -32,174 +32,702 @@ import javax.xml.ws.spi.ServiceDelegate; /** - * Service objects provide the client view of a Web service. + * <code>Service</code> objects provide the client view of a Web service. + * <p><code>Service</code> acts as a factory of the following: + * <ul> + * <li>Proxies for a target service endpoint. + * <li>Instances of <code>javax.xml.ws.Dispatch</code> for + * dynamic message-oriented invocation of a remote + * operation. + * </li> * - * Service acts as a factory of the following: + * <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 + * and let the runtime select a compatible port. * - * - Proxies for a target service endpoint. - * - Instances of javax.xml.ws.Dispatch for dynamic message-oriented invocation of a remote operation. + * <p>Handler chains for all the objects created by a <code>Service</code> + * can be set by means of a <code>HandlerResolver</code>. * - * 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. + * <p>An <code>Executor</code> 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 + * registering it with the service. * - * Handler chains for all the objects created by a Service can be set by means of a HandlerResolver. + * @since JAX-WS 2.0 * - * 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. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ + * @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. - * MESSAGE provides access to entire protocol message, - * PAYLOAD to protocol message payload only. - */ + * The orientation of a dynamic client or service. MESSAGE provides + * access to entire protocol message, PAYLOAD to protocol message + * payload only. + **/ public enum Mode { - MESSAGE, PAYLOAD; - } + MESSAGE, PAYLOAD + }; - private ServiceDelegate delegate; - - protected Service(URL wsdlDocumentLocation, QName serviceName) + protected Service(java.net.URL wsdlDocumentLocation, QName serviceName) { - delegate = Provider.provider().createServiceDelegate(wsdlDocumentLocation, serviceName, getClass()); + delegate = Provider.provider().createServiceDelegate(wsdlDocumentLocation, serviceName, this.getClass()); } + /** + * The getPort method returns a proxy. A service client + * uses this proxy to invoke operations on the target + * service endpoint. The <code>serviceEndpointInterface</code> + * 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. + * @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</code> + * or <code>portName</code> is specified. + * </UL> + * @see java.lang.reflect.Proxy + * @see java.lang.reflect.InvocationHandler + **/ public <T> T getPort(QName portName, Class<T> serviceEndpointInterface) { - T port = null; - try - { - port = delegate.getPort(portName, serviceEndpointInterface); - } - catch (Exception ex) - { - handleServiceGetPortFailure(ex); - } - return port; + return delegate.getPort(portName, serviceEndpointInterface); } + /** + * The getPort method returns a proxy. A service client + * uses this proxy to invoke operations on the target + * service endpoint. The <code>serviceEndpointInterface</code> + * 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. + * @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</code> + * or <code>portName</code> 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 JAX-WS 2.1 + **/ + public <T> T getPort(QName portName, Class<T> serviceEndpointInterface, WebServiceFeature... features) + { + return delegate.getPort(portName, serviceEndpointInterface, features); + } + + /** + * The getPort method returns a proxy. The parameter + * <code>serviceEndpointInterface</code> 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. + * @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> + * is specified. + * </UL> + **/ public <T> T getPort(Class<T> serviceEndpointInterface) { - T port = null; - try - { - port = delegate.getPort(serviceEndpointInterface); - } - catch (Exception ex) - { - handleServiceGetPortFailure(ex); - } - return port; + return delegate.getPort(serviceEndpointInterface); } + /** + * The getPort method returns a proxy. The parameter + * <code>serviceEndpointInterface</code> 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. + * @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> + * is specified. + * <LI>If a feature is enabled that is not compatible + * with this port or is unsupported. + * </UL> + * + * @see WebServiceFeature + * + * @since JAX-WS 2.1 + **/ + public <T> T getPort(Class<T> serviceEndpointInterface, WebServiceFeature... features) + { + return delegate.getPort(serviceEndpointInterface, features); + } + + /** + * The getPort method returns a proxy. + * The parameter <code>endpointReference</code> 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 + * 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 + * for invocations on the endpoint. + * The parameter <code>serviceEndpointInterface</code> 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 WSDL Metadata from the <code>endpointReference</code>. + * If this <code>Service</code> instance has a WSDL and + * the <code>endpointReference</code> + * also has a WSDL, then the WSDL from this instance will 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> will be used. + * The returned proxy should not be reconfigured by the client. + * If this <code>Service</code> 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> + * port = service.getPort(portName, serviceEndpointInterface); + * </pre> + * where the <code>portName</code> is retrieved from the + * <code>wsaw:EndpontName</code> attribute of the + * <code>wsaw:ServiceName</code> element in the + * metadata of the <code>endpointReference</code> or from the + * <code>serviceEndpointInterface</code> and the WSDL + * associated with this <code>Service</code> instance. + * <br> + * See <a href="http://www.w3.org/TR/2006/CR-ws-addr-wsdl-20060529/">W... - WSDL 1.0 + * </a>. + * + * @param endpointReference The <code>EndpointReference</code> + * for the target service endpoint that will be invoked by the + * returned proxy. + * @param serviceEndpointInterface Service endpoint interface. + * @param features An array of WebServiceFeatures to configure on the + * proxy. Supported features not in the <code>features + * </code> 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>wsaw:EndpointName</code> is + * missing from the <code>endpointReference</code> + * or does not match a wsdl:Port + * in the WSDL metadata. + * <LI>If the <code>wsaw:ServiceName</code> in the + * <code>endpointReference</code> metadata does not + * match the <code>serviceName</code> of this + * <code>Service</code> instance. + * <LI>If an invalid + * <code>endpointReference</code> + * is specified. + * <LI>If an invalid + * <code>serviceEndpointInterface</code> + * is specified. + * <LI>If a feature is enabled that is not compatible + * with this port or is unsupported. + * </UL> + * + * @since 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</code>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</code> instance for use with objects of + * the users 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 + * the binding in use. + * @param mode Controls whether the created dispatch instance is message + * or payload oriented, i.e. whether the user will work with complete + * protocol messages or message payloads. E.g. when using the SOAP + * protocol, this parameter controls whether the user 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. + * + * @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 + * the users 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 + * javax.xml.transform.Source and javax.xml.soap.SOAPMessage. + * @param mode Controls whether the created dispatch instance is message + * or payload oriented, i.e. whether the user will work with complete + * protocol messages or message payloads. E.g. when using the SOAP + * protocol, this parameter controls whether the user will work with + * SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE + * when type is SOAPMessage. + * @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. + * + * @return Dispatch instance. + * @throws WebServiceException If any error in the creation of + * the <code>Dispatch</code> 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 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</code> instance for use with objects of + * the users choosing. If there + * are any reference parameters in the + * <code>endpointReference</code>, 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 + * 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 WSDL Metadata from the <code>endpointReference</code>. + * If this <code>Service</code> instance has a WSDL and + * the <code>endpointReference</code> + * also has a WSDL, then the WSDL from this instance will 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> will be used. + * <p> + * This method behaves the same as calling + * <pre> + * dispatch = service.createDispatch(portName, type, mode, features); + * </pre> + * where the <code>portName</code> is retrieved from the + * <code>wsaw:EndpointName</code> attribute of the <code>wsaw:ServiceName</code> + * element in the + * metadata of the <code>endpointReference</code>. + * <br> + * See <a href="http://www.w3.org/TR/2006/CR-ws-addr-wsdl-20060529/">W... - WSDL 1.0 + * </a>. + * + * @param endpointReference The <code>EndpointReference</code> + * for the target service endpoint that will be invoked by the + * returned <code>Dispatch</code> object. + * @param type The class of object used to messages or message + * payloads. Implementations are required to support + * javax.xml.transform.Source and javax.xml.soap.SOAPMessage. + * @param mode Controls whether the created dispatch instance is message + * or payload oriented, i.e. whether the user will work with complete + * protocol messages or message payloads. E.g. when using the SOAP + * protocol, this parameter controls whether the user will work with + * SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE + * when type is SOAPMessage. + * @param features An array of WebServiceFeatures to configure on the + * proxy. Supported features not in the <code>features + * </code> 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>wsaw:ServiceName</code> element + * or the <code>wsaw:EndpointName</code> attribute + * is missing in the metdata of the + * <code>endpointReference</code>. + * <li>If the <code>wsaw:ServiceName</code> does not + * match the <code>serviceName</code> of this instance. + * <li>If the <code>wsaw:EndpointName</code> does not + * match a valid wsdl:Port in the WSDL metadata. + * <li>If any error in the creation of + * the <code>Dispatch</code> 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 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</code> 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 user will work with complete + * protocol messages or message payloads. E.g. when using the SOAP + * protocol, this parameter controls whether the user 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. + * + * @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 + * 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 user will work with complete + * protocol messages or message payloads. E.g. when using the SOAP + * protocol, this parameter controls whether the user will work with + * SOAP messages or the contents of a SOAP body. + * @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. + * + * @return Dispatch instance. + * @throws WebServiceException If any error in the creation of + * the <code>Dispatch</code> 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 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</code> instance for use with JAXB + * generated objects. If there + * are any reference parameters in the + * <code>endpointReference</code>, 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 + * 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 WSDL Metadata from the <code>endpointReference</code>. + * If this <code>Service</code> instance has a WSDL and + * the <code>endpointReference</code> + * also has a WSDL, then the WSDL from this instance will 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> will be used. + * <p> + * This method behavies the same as calling + * <pre> + * dispatch = service.createDispatch(portName, context, mode, features); + * </pre> + * where the <code>portName</code> is retrieved from the + * <code>wsaw:EndpointName</code> attribute of the <code>wsaw:ServiceName</code> + * element in the + * metadata of the <code>endpointReference</code>. + * <br> + * See <a href="http://www.w3.org/TR/2006/CR-ws-addr-wsdl-20060529/">W... - WSDL 1.0 + * </a>. + * + * @param endpointReference The <code>EndpointReference</code> + * for the target service endpoint that will be invoked by the + * returned <code>Dispatch</code> 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 user will work with complete + * protocol messages or message payloads. E.g. when using the SOAP + * protocol, this parameter controls whether the user will work with + * SOAP messages or the contents of a SOAP body. + * @param features An array of WebServiceFeatures to configure on the + * proxy. Supported features not in the <code>features + * </code> parameter will have their default values. + * + * @return Dispatch instance + * @throws WebServiceException + * @throws WebServiceException + * <UL> + * <li>If there is any missing WSDL metadata + * as required by this method. + * <li>If the <code>wsaw:ServiceName</code> element + * or the <code>wsaw:EndpointName</code> attribute + * is missing in the metdata of the + * <code>endpointReference</code>. + * <li>If the <code>wsaw:ServiceName</code> does not + * match the <code>serviceName</code> of this instance. + * <li>If the <code>wsaw:EndpointName</code> does not + * match a valid wsdl:Port in the WSDL metadata. + * <li>If any error in the creation of + * the <code>Dispatch</code> 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 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(); } - public Iterator getPorts() + /** + * Returns an <code>Iterator</code> for the list of + * <code>QName</code>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>. + * @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(); } - public URL getWSDLDocumentLocation() + /** + * 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</code> being + * used by this <code>Service</code> instance, or <code>null</code> + * if there isn't one. + **/ public HandlerResolver getHandlerResolver() { return delegate.getHandlerResolver(); } + /** + * Sets the <code>HandlerResolver</code> for this <code>Service</code> + * 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 + * for all subsequently created proxy/dispatch objects. + * + * @see javax.xml.ws.handler.HandlerResolver + **/ public void setHandlerResolver(HandlerResolver handlerResolver) { delegate.setHandlerResolver(handlerResolver); } - public Executor getExecutor() + /** + * Returns the executor for this <code>Service</code>instance. + * + * The executor is used for all asynchronous invocations that + * require callbacks. + * + * @return The <code>java.util.concurrent.Executor</code> to be + * used to invoke a callback. + * + * @see java.util.concurrent.Executor + **/ + public java.util.concurrent.Executor getExecutor() { return delegate.getExecutor(); } - public void setExecutor(Executor executor) + /** + * Sets the executor for this <code>Service</code> instance. + * + * The executor is used for all asynchronous invocations that + * require callbacks. + * + * @param executor The <code>java.util.concurrent.Executor</code> + * 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); } /** - * Create a Service instance. The specified WSDL document location and service qualified name must uniquely identify a wsdl:service element. - */ - public static Service create(URL wsdlDocumentLocation, QName serviceName) + * Create a <code>Service</code> instance. + * + * The specified WSDL document location and service qualified name MUST + * uniquely identify a <code>wsdl:service</code> element. + * + * @param wsdlDocumentLocation URL for the WSDL document location + * for the service + * @param serviceName 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) { - Service service = null; - try - { - service = new Service(wsdlDocumentLocation, serviceName); - } - catch (Exception ex) - { - handleServiceCreationFailure(ex); - } - return service; + return new Service(wsdlDocumentLocation, serviceName); } /** - * Create a Service instance. + * Create a <code>Service</code> instance. + * + * @param serviceName QName for the service + * @throws WebServiceException If any error in creation of the + * specified service */ public static Service create(QName serviceName) { - Service service = null; - try - { - service = new Service(null, serviceName); - } - catch (Exception ex) - { - handleServiceCreationFailure(ex); - } - return service; + return new Service(null, serviceName); } - - // 4.12 Conformance (Service.getPort failure): If creation of a proxy fails, an implementation MUST throw - // javax.xml.ws.WebServiceException. The cause of that exception SHOULD be set to an exception - // that provides more information on the cause of the error (e.g. an IOException). - private static void handleServiceGetPortFailure(Exception ex) - { - if (ex instanceof WebServiceException) - { - throw (WebServiceException)ex; - } - throw new WebServiceException(ex); - } - - // 4.2 Conformance (Service Creation Failure): If a create method fails to create a service object, it MUST - // throw WebServiceException. The cause of that exception SHOULD be set to an exception that provides - // more information on the cause of the error (e.g. an IOException). - private static void handleServiceCreationFailure(Exception ex) - { - if (ex instanceof WebServiceException) - { - throw (WebServiceException)ex; - } - throw new WebServiceException(ex); - } -} \ No newline at end of file +} Modified: trunk/src/main/java/javax/xml/ws/ServiceMode.java =================================================================== --- trunk/src/main/java/javax/xml/ws/ServiceMode.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/ServiceMode.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,6 +21,8 @@ */ package javax.xml.ws; +// $Id$ + import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Inherited; @@ -28,19 +30,17 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; -/** - * Used to indicate whether a Provider implementation wishes to work with entire - * protocol messages or just with protocol message payloads. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ +/** + * Used to indicate whether a Provider implementation wishes to work + * with entire protocol messages or just with protocol message payloads. + * + * @since JAX-WS 2.0 + **/ @Target( { ElementType.TYPE }) @Retention(RetentionPolicy.RUNTIME) @Inherited @Documented -public @interface ServiceMode -{ +public @interface ServiceMode { /** * Service mode. PAYLOAD indicates that the Provider implementation * wishes to work with protocol message payloads only. MESSAGE indicates Modified: trunk/src/main/java/javax/xml/ws/WebEndpoint.java =================================================================== --- trunk/src/main/java/javax/xml/ws/WebEndpoint.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/WebEndpoint.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,29 +21,32 @@ */ package javax.xml.ws; +// $Id$ + import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; -/** - * Used to annotate the getPortName() methods of a generated service interface. - * - * The information specified in this annotation is sufficient to uniquely - * identify a wsdl:port element inside a wsdl:service. - * - * The latter is determined based on the value of the WebServiceClient annotation - * on the generated service interface itself. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ +/** + * Used to annotate the <code>get<em>PortName</em>()</code> + * methods of a generated service interface. + * + * <p>The information specified in this annotation is sufficient + * to uniquely identify a <code>wsdl:port</code> element + * inside a <code>wsdl:service</code>. The latter is + * determined based on the value of the <code>WebServiceClient</code> + * annotation on the generated service interface itself. + * + * @since JAX-WS 2.0 + * + * @see javax.xml.ws.WebServiceClient + **/ @Target( { ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @Documented -public @interface WebEndpoint -{ +public @interface WebEndpoint { /** * The local name of the endpoint. **/ Modified: trunk/src/main/java/javax/xml/ws/WebFault.java =================================================================== --- trunk/src/main/java/javax/xml/ws/WebFault.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/WebFault.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,24 +21,25 @@ */ package javax.xml.ws; +// $Id$ + import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; -/** - * Used to annotate service specific exception classes to customize to the local - * and namespace name of the fault element and the name of the fault bean. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ +/** + * Used to annotate service specific exception classes to customize + * to the local and namespace name of the fault element and the name + * of the fault bean. + * + * @since JAX-WS 2.0 + **/ @Target( { ElementType.TYPE }) @Retention(RetentionPolicy.RUNTIME) @Documented -public @interface WebFault -{ +public @interface WebFault { /** * Elements local name. **/ Modified: trunk/src/main/java/javax/xml/ws/WebServiceClient.java =================================================================== --- trunk/src/main/java/javax/xml/ws/WebServiceClient.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/WebServiceClient.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,29 +21,29 @@ */ package javax.xml.ws; +// $Id$ + import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; -/** - * Used to annotate a generated service interface. - * - * The information specified in this annotation is sufficient to uniquely identify - * a wsdl:service element inside a WSDL document. - * - * This wsdl:service element represents the Web service for which the generated - * service interface provides a client view. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ +/** + * Used to annotate a generated service interface. + * + * <p>The information specified in this annotation is sufficient + * to uniquely identify a <code>wsdl:service</code> + * element inside a WSDL document. This <code>wsdl:service</code> + * element represents the Web service for which the generated + * service interface provides a client view. + * + * @since JAX-WS 2.0 + **/ @Target( { ElementType.TYPE }) @Retention(RetentionPolicy.RUNTIME) @Documented -public @interface WebServiceClient -{ +public @interface WebServiceClient { /** * The local name of the Web service. **/ Modified: trunk/src/main/java/javax/xml/ws/WebServiceContext.java =================================================================== --- trunk/src/main/java/javax/xml/ws/WebServiceContext.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/WebServiceContext.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,70 +21,153 @@ */ package javax.xml.ws; +// $Id$ + import java.security.Principal; import javax.xml.ws.handler.MessageContext; +import javax.xml.ws.wsaddressing.W3CEndpointReference; +import org.w3c.dom.Element; + /** - * A WebServiceContext makes it possible for a web service endpoint implementation - * class to access message context and security information relative to a request - * being served. Typically a WebServiceContext is injected into an endpoint implementation - * class using the Resource annotation. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ + * A <code>WebServiceContext</code> makes it possible for + * a web service endpoint implementation class to access + * message context and security information relative to + * a request being served. + * + * Typically a <code>WebServiceContext</code> is injected + * into an endpoint implementation class using the + * <code>Resource</code> annotation. + * + * @since JAX-WS 2.0 + * + * @see javax.annotation.Resource + **/ public interface WebServiceContext { /** - * Returns the MessageContext for the request being served - * at the time this method is called. Only properties with - * APPLICATION scope will be visible to the application. + * Returns the MessageContext for the request being served + * at the time this method is called. Only properties with + * APPLICATION scope will be visible to the application. * - * @return MessageContext The message context. - * - * @throws IllegalStateException This exception is thrown - * if the method is called while no request is - * being serviced. + * @return MessageContext The message context. * - * @see javax.xml.ws.handler.MessageContext - * @see javax.xml.ws.handler.MessageContext.Scope - * @see java.lang.IllegalStateException + * @throws IllegalStateException This exception is thrown + * if the method is called while no request is + * being serviced. + * + * @see javax.xml.ws.handler.MessageContext + * @see javax.xml.ws.handler.MessageContext.Scope + * @see java.lang.IllegalStateException **/ public MessageContext getMessageContext(); /** - * Returns the Principal that identifies the sender - * of the request currently being serviced. If the - * sender has not been authenticated, the method - * returns <code>null</code>. + * Returns the Principal that identifies the sender + * of the request currently being serviced. If the + * sender has not been authenticated, the method + * returns <code>null</code>. * - * @return Principal The principal object. - * - * @throws IllegalStateException This exception is thrown - * if the method is called while no request is - * being serviced. + * @return Principal The principal object. * - * @see java.security.Principal - * @see java.lang.IllegalStateException + * @throws IllegalStateException This exception is thrown + * if the method is called while no request is + * being serviced. + * + * @see java.security.Principal + * @see java.lang.IllegalStateException **/ public Principal getUserPrincipal(); /** - * Returns a boolean indicating whether the - * authenticated user is included in the specified - * logical role. If the user has not been - * authenticated, the method returns </code>false</code>. + * Returns a boolean indicating whether the + * authenticated user is included in the specified + * logical role. If the user has not been + * authenticated, the method returns </code>false</code>. * - * @param role A <code>String</code> specifying the name of the role + * @param role A <code>String</code> specifying the name of the role * - * @return a <code>boolean</code> indicating whether - * the sender of the request belongs to a given role - * - * @throws IllegalStateException This exception is thrown - * if the method is called while no request is - * being serviced. + * @return a <code>boolean</code> indicating whether + * the sender of the request belongs to a given role + * + * @throws IllegalStateException This exception is thrown + * if the method is called while no request is + * being serviced. **/ public boolean isUserInRole(String role); + + /** + * Returns the <code>WEndpointReference</code> for this + * endpoint. + * <p> + * If the Binding for this <code>bindingProvider</code> is + * either SOAP1.1/HTTP or SOAP1.2/HTTP, then a + * <code>W3CEndpointReference</code> MUST be returned. + * If the returned <code>EndpointReference</code> is a + * <code>W3CEndpointReference</code> it MUST contain + * the <code>wsaw:ServiceName</code> element and the + * <code>wsaw:EndpointName</code> attribute on the + * <code>wsaw:ServiceName</code>. It SHOULD contain + * the embedded WSDL in the <code>wsa:Metadata</code> element + * if there is an associated WSDL. The + * <code>wsaw:InterfaceName</code> MAY also be present. + * <br> + * See <a href="http://www.w3.org/TR/2006/CR-ws-addr-wsdl-20060529/"> + * WS-Addressing - WSDL 1.0</a>. + * + * @param referenceParameters Reference parameters to be associated with the + * returned <code>EndpointReference</code> instance. + * @return EndpointReference of the endpoint associated with this + * <code>WebServiceContext</code>. + * If the returned <code>EndpointReference</code> is of type + * <code>W3CEndpointReference</code> then it MUST contain the + * the specified <code>referenceParameters</code>. + * + * @throws IllegalStateException This exception is thrown + * if the method is called while no request is + * being serviced. + * + * @see W3CEndpointReference + * + * @since JAX-WS 2.1 + */ + public EndpointReference getEndpointReference(Element... referenceParameters); + + /** + * Returns the <code>EndpointReference</code> associated with + * this endpoint. + * <p> + * If the returned <code>EndpointReference</code> is a + * <code>W3CEndpointReference</code> it MUST contain + * the <code>wsaw:ServiceName</code> element and the + * <code>wsaw:EndpointName</code> attribute on the + * <code>wsaw:ServiceName</code>. It SHOULD contain + * the embedded WSDL in the <code>wsa:Metadata</code> element + * if there is an associated WSDL. The + * <code>wsaw:InterfaceName</code> MAY also be present. + * <br> + * See <a href="http://www.w3.org/TR/2006/CR-ws-addr-wsdl-20060529/"> + * WS-Addressing - WSDL 1.0</a>. + * + * @param clazz The type of <code>EndpointReference</code> that + * MUST be returned. + * @param referenceParameters Reference parameters to be associated with the + * returned <code>EndpointReference</code> instance. + * @return EndpointReference of type <code>clazz</code> of the endpoint + * associated with this <code>WebServiceContext</code> instance. + * If the returned <code>EndpointReference</code> is of type + * <code>W3CEndpointReference</code> then it MUST contain the + * the specified <code>referenceParameters</code>. + * + * @throws IllegalStateException This exception is thrown + * if the method is called while no request is + * being serviced. + * @throws WebServiceException If the <code>clazz</code> type of + * <code>EndpointReference</code> is not supported. + * + * @since JAX-WS 2.1 + **/ + public abstract <T extends EndpointReference> T getEndpointReference(Class<T> clazz, Element... referenceParameters); } Modified: trunk/src/main/java/javax/xml/ws/WebServiceException.java =================================================================== --- trunk/src/main/java/javax/xml/ws/WebServiceException.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/WebServiceException.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -23,15 +23,15 @@ // $Id$ -/** - * The WebServiceException class is the base exception class for all JAX-WS - * API runtime exceptions. +/** The <code>WebServiceException</code> class is the base + * exception class for all JAX-WS API runtime exceptions. * - * @author Thomas.Diesler(a)jboss.org - * @since 14-Nov-2005 - */ -public class WebServiceException extends RuntimeException + * @since JAX-WS 2.0 + **/ + +public class WebServiceException extends java.lang.RuntimeException { + /** Constructs a new exception with <code>null</code> as its * detail message. The cause is not initialized. **/ @@ -78,4 +78,5 @@ { super(cause); } + } Added: trunk/src/main/java/javax/xml/ws/WebServiceFeature.java =================================================================== --- trunk/src/main/java/javax/xml/ws/WebServiceFeature.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/WebServiceFeature.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -0,0 +1,79 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package javax.xml.ws; + +// $Id$ + +/** + * A WebServiceFeature is used to represent a feature that can be + * enabled or disabled for a web service. + * <p> + * The JAX-WS specification will define some standard features and + * JAX-WS implementors are free to define additional features if + * necessary. Vendor specific features may not be portable so + * caution should be used when using them. Each Feature definition + * MUST define a <code>public static final String ID</code> + * that can be used in the Feature annotation to refer + * to the feature. This ID MUST be unique across all features + * of all vendors. When defining a vendor specific feature ID, + * use a vendor specific namespace in the ID string. + * + * @see javax.xml.ws.RespectBindingFeature + * @see javax.xml.ws.soap.AddressingFeature + * @see javax.xml.ws.soap.MTOMFeature + * + * @since 2.1 + */ +public abstract class WebServiceFeature +{ + /** + * Each Feature definition MUST define a public static final + * String ID that can be used in the Feature annotation to refer + * to the feature. + */ + // public static final String ID = "some unique feature Identifier"; + /** + * Get the unique identifier for this WebServiceFeature. + * + * @return the unique identifier for this feature. + */ + public abstract String getID(); + + /** + * Specifies if the feature is enabled or disabled + */ + protected boolean enabled = false; + + protected WebServiceFeature() + { + } + + /** + * Returns <code>true</code> if this feature is enabled. + * + * @return <code>true</code> if and only if the feature is enabled . + */ + public boolean isEnabled() + { + return enabled; + } +} Property changes on: trunk/src/main/java/javax/xml/ws/WebServiceFeature.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Modified: trunk/src/main/java/javax/xml/ws/WebServicePermission.java =================================================================== --- trunk/src/main/java/javax/xml/ws/WebServicePermission.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/WebServicePermission.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,6 +21,8 @@ */ package javax.xml.ws; +// $Id$ + import java.security.BasicPermission; /** @@ -40,13 +42,17 @@ * web service endpoint using the <code>publish</code> methods * defined by the <code>javax.xml.ws.Endpoint</code> class. * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 + * @see javax.xml.ws.Endpoint + * @see java.security.BasicPermission + * @see java.security.Permission + * @see java.security.Permissions + * @see java.lang.SecurityManager */ public final class WebServicePermission extends BasicPermission { - private static final long serialVersionUID = 0xfdf79e1746fde514L; + private static final long serialVersionUID = -146474640053770988L; + /** * Creates a new permission with the specified name. * @@ -70,4 +76,5 @@ { super(name, actions); } + } Modified: trunk/src/main/java/javax/xml/ws/WebServiceProvider.java =================================================================== --- trunk/src/main/java/javax/xml/ws/WebServiceProvider.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/WebServiceProvider.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,6 +21,8 @@ */ package javax.xml.ws; +// $Id$ + import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; @@ -29,15 +31,14 @@ /** * Used to annotate a Provider implementation class. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 + * + * @since JAX-WS 2.0 + * @see javax.xml.ws.Provider */ @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented -public @interface WebServiceProvider -{ +public @interface WebServiceProvider { /** * Location of the WSDL description for the service. */ Modified: trunk/src/main/java/javax/xml/ws/WebServiceRef.java =================================================================== --- trunk/src/main/java/javax/xml/ws/WebServiceRef.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/WebServiceRef.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,6 +21,8 @@ */ package javax.xml.ws; +// $Id$ + import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; @@ -28,25 +30,28 @@ import java.lang.annotation.Target; /** - * The WebServiceRef annotation is used to define a reference to a web service and - * (optionally) an injection target for it. - * - * Web service references are resources in the Java EE 5 sense. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ + * The <code>WebServiceRef</code> annotation is used to + * define a reference to a web service and + * (optionally) an injection target for it. + * + * Web service references are resources in the Java EE 5 sense. + * + * @see javax.annotation.Resource + * + * @since JAX-WS 2.0 + * + **/ + @Target( { ElementType.TYPE, ElementType.METHOD, ElementType.FIELD }) @Retention(RetentionPolicy.RUNTIME) @Documented -public @interface WebServiceRef -{ +public @interface WebServiceRef { /** * The JNDI name of the resource. For field annotations, * the default is the field name. For method annotations, * the default is the JavaBeans property name corresponding * to the method. For class annotations, there is no default - * and this must be specified. + * and this MUST be specified. */ String name() default ""; @@ -54,7 +59,7 @@ * The Java type of the resource. For field annotations, * the default is the type of the field. For method annotations, * the default is the type of the JavaBeans property. - * For class annotations, there is no default and this must be + * For class annotations, there is no default and this MUST be * specified. */ Class type() default Object.class; @@ -78,7 +83,7 @@ /** * The service class, always a type extending - * <code>javax.xml.ws.Service</code>. This element must be specified + * <code>javax.xml.ws.Service</code>. This element MUST be specified * whenever the type of the reference is a service endpoint interface. */ Class value() default Object.class; Modified: trunk/src/main/java/javax/xml/ws/WebServiceRefs.java =================================================================== --- trunk/src/main/java/javax/xml/ws/WebServiceRefs.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/WebServiceRefs.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,6 +21,8 @@ */ package javax.xml.ws; +// $Id$ + import static java.lang.annotation.ElementType.TYPE; import static java.lang.annotation.RetentionPolicy.RUNTIME; @@ -33,14 +35,14 @@ * multiple web service references to be declared at the * class level. * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 + * @see javax.xml.ws.WebServiceRef + * @since 2.0 */ + @Documented @Retention(RUNTIME) @Target(TYPE) -public @interface WebServiceRefs -{ +public @interface WebServiceRefs { /** * Array used for multiple web service reference declarations. */ Modified: trunk/src/main/java/javax/xml/ws/handler/Handler.java =================================================================== --- trunk/src/main/java/javax/xml/ws/handler/Handler.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/handler/Handler.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,29 +21,65 @@ */ package javax.xml.ws.handler; -/** - * The Handler interface is the base interface for JAX-WS handlers. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ -public interface Handler<C extends MessageContext> -{ - /** - * The handleMessage method is invoked for normal processing of inbound and outbound messages. - * Refer to the description of the handler framework in the JAX-WS specification for full details. - */ - boolean handleMessage(C msgContext); +// $Id$ - /** - * The handleFault method is invoked for fault message processing. Refer to the description of the - * handler framework in the JAX-WS specification for full details. - */ - boolean handleFault(C msgContext); +import javax.xml.ws.ProtocolException; +import javax.xml.ws.handler.MessageContext; - /** - * Called at the conclusion of a message exchange pattern just prior to the JAX-WS runtime disptaching a message, - * fault or exception. Refer to the description of the handler framework in the JAX-WS specification for full details. - */ - void close(C msgContext); -} \ No newline at end of file +/** The <code>Handler</code> interface + * is the base interface for JAX-WS handlers. + * + * @since JAX-WS 2.0 +**/ +public interface Handler<C extends MessageContext> { + + /** The <code>handleMessage</code> method is invoked for normal processing + * of inbound and outbound messages. Refer to the description of the handler + * framework in the JAX-WS specification for full details. + * + * @param context the message context. + * @return An indication of whether handler processing should continue for + * the current message + * <ul> + * <li>Return <code>true</code> to continue + * processing.</li> + * <li>Return <code>false</code> to block + * processing.</li> + * </ul> + * @throws RuntimeException Causes the JAX-WS runtime to cease + * handler processing and generate a fault. + * @throws ProtocolException Causes the JAX-WS runtime to switch to + * fault message processing. + **/ + public boolean handleMessage(C context); + + /** The <code>handleFault</code> method is invoked for fault message + * processing. Refer to the description of the handler + * framework in the JAX-WS specification for full details. + * + * @param context the message context + * @return An indication of whether handler fault processing should continue + * for the current message + * <ul> + * <li>Return <code>true</code> to continue + * processing.</li> + * <li>Return <code>false</code> to block + * processing.</li> + * </ul> + * @throws RuntimeException Causes the JAX-WS runtime to cease + * handler fault processing and dispatch the fault. + * @throws ProtocolException Causes the JAX-WS runtime to cease + * handler fault processing and dispatch the fault. + **/ + public boolean handleFault(C context); + + /** + * Called at the conclusion of a message exchange pattern just prior to + * the JAX-WS runtime disptaching a message, fault or exception. Refer to + * the description of the handler + * framework in the JAX-WS specification for full details. + * + * @param context the message context + **/ + public void close(MessageContext context); +} Modified: trunk/src/main/java/javax/xml/ws/handler/HandlerResolver.java =================================================================== --- trunk/src/main/java/javax/xml/ws/handler/HandlerResolver.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/handler/HandlerResolver.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -19,24 +19,33 @@ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * 02110-1301 USA, or see the FSF site: http://www.fsf.org. */ - package javax.xml.ws.handler; -import java.util.List; +// $Id$ -/** - * HandlerResolver is an interface implemented by an application to get control over - * the handler chain set on proxy/dispatch objects at the time of their creation. - * - * A HandlerResolver may be set on a Service using the setHandlerResolver method. - * - * When the runtime invokes a HandlerResolver, it will pass it a PortInfo object - * containing information about the port that the proxy/dispatch object will be accessing. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ -public interface HandlerResolver -{ - List<Handler> getHandlerChain(PortInfo portInfo); -} \ No newline at end of file +/** + * <code>HandlerResolver</code> is an interface implemented + * by an application to get control over the handler chain + * set on proxy/dispatch objects at the time of their creation. + * <p> + * A <code>HandlerResolver</code> may be set on a <code>Service</code> + * using the <code>setHandlerResolver</code> method. + * <p> + * When the runtime invokes a <code>HandlerResolver</code>, it will + * pass it a <code>PortInfo</code> object containing information + * about the port that the proxy/dispatch object will be accessing. + * + * @see javax.xml.ws.Service#setHandlerResolver + * + * @since JAX-WS 2.0 +**/ +public interface HandlerResolver { + + /** + * Gets the handler chain for the specified port. + * + * @param portInfo Contains information about the port being accessed. + * @return java.util.List Handler chain + **/ + public java.util.List<Handler> getHandlerChain(PortInfo portInfo); +} Modified: trunk/src/main/java/javax/xml/ws/handler/LogicalHandler.java =================================================================== --- trunk/src/main/java/javax/xml/ws/handler/LogicalHandler.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/handler/LogicalHandler.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,13 +21,12 @@ */ package javax.xml.ws.handler; -/** - * The LogicalHandler extends Handler to provide typesafety for the message - * context parameter. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ -public interface LogicalHandler<C extends LogicalMessageContext> extends Handler<C> -{ -} \ No newline at end of file +// $Id$ + +/** The <code>LogicalHandler</code> extends + * Handler to provide typesafety for the message context parameter. + * + * @since JAX-WS 2.0 +**/ +public interface LogicalHandler<C extends LogicalMessageContext> extends Handler<C> { +} Modified: trunk/src/main/java/javax/xml/ws/handler/LogicalMessageContext.java =================================================================== --- trunk/src/main/java/javax/xml/ws/handler/LogicalMessageContext.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/handler/LogicalMessageContext.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,17 +21,24 @@ */ package javax.xml.ws.handler; +// $Id$ + import javax.xml.ws.LogicalMessage; -/** - * The LogicalMessageContext interface extends MessageContext to provide - * access to a the contained message as a protocol neutral LogicalMessage - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ -public interface LogicalMessageContext extends MessageContext -{ +/** The <code>LogicalMessageContext</code> interface extends + * <code>MessageContext</code> to + * provide access to a the contained message as a protocol neutral + * LogicalMessage + * + * @since JAX-WS 2.0 +**/ +public interface LogicalMessageContext + extends MessageContext { - LogicalMessage getMessage(); -} \ No newline at end of file + /** Gets the message from this message context + * + * @return The contained message; returns null if no + * message is present in this message context + **/ + public LogicalMessage getMessage(); +} Modified: trunk/src/main/java/javax/xml/ws/handler/MessageContext.java =================================================================== --- trunk/src/main/java/javax/xml/ws/handler/MessageContext.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/handler/MessageContext.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,46 +21,184 @@ */ package javax.xml.ws.handler; +// $Id$ + import java.util.Map; /** - * The interface MessageContext abstracts the message context that is processed by a - * handler in the handle method. - * - * The MessageContext interface provides methods to manage a property set. - * MessageContext properties enable handlers in a handler chain to share - * processing related state. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 + * The interface <code>MessageContext</code> abstracts the message + * context that is processed by a handler in the <code>handle</code> + * method. + * + * <p>The <code>MessageContext</code> interface provides methods to + * manage a property set. <code>MessageContext</code> properties + * enable handlers in a handler chain to share processing related + * state. + * + * @since JAX-WS 2.0 */ -public interface MessageContext extends Map<String, Object> -{ - public static final String MESSAGE_OUTBOUND_PROPERTY = "javax.xml.ws.handler.message.outbound"; - public static final String INBOUND_MESSAGE_ATTACHMENTS = "javax.xml.ws.binding.attachments.inbound"; - public static final String OUTBOUND_MESSAGE_ATTACHMENTS = "javax.xml.ws.binding.attachments.outbound"; - public static final String WSDL_DESCRIPTION = "javax.xml.ws.wsdl.description"; - public static final String WSDL_SERVICE = "javax.xml.ws.wsdl.service"; - public static final String WSDL_PORT = "javax.xml.ws.wsdl.port"; - public static final String WSDL_INTERFACE = "javax.xml.ws.wsdl.interface"; - public static final String WSDL_OPERATION = "javax.xml.ws.wsdl.operation"; - public static final String HTTP_RESPONSE_CODE = "javax.xml.ws.http.response.code"; - public static final String HTTP_REQUEST_HEADERS = "javax.xml.ws.http.request.headers"; - public static final String HTTP_RESPONSE_HEADERS = "javax.xml.ws.http.response.headers"; - public static final String HTTP_REQUEST_METHOD = "javax.xml.ws.http.request.method"; - public static final String SERVLET_REQUEST = "javax.xml.ws.servlet.request"; - public static final String SERVLET_RESPONSE = "javax.xml.ws.servlet.response"; - public static final String SERVLET_SESSION = "javax.xml.ws.servlet.session"; - public static final String SERVLET_CONTEXT = "javax.xml.ws.servlet.context"; - public static final String QUERY_STRING = "javax.xml.ws.http.request.querystring"; - public static final String PATH_INFO = "javax.xml.ws.http.request.pathinfo"; - - public enum Scope - { - APPLICATION, HANDLER; - } - - void setScope(String s, Scope scope); - - Scope getScope(String s); -} \ No newline at end of file +public interface MessageContext extends Map<String, Object> { + + /** + * Standard property: message direction, <code>true</code> for + * outbound messages, <code>false</code> for inbound. + * <p>Type: boolean + */ + public static final String MESSAGE_OUTBOUND_PROPERTY = + "javax.xml.ws.handler.message.outbound"; + + /** + * Standard property: Map of attachments to a message for the inbound + * message, key is the MIME Content-ID, value is a DataHandler. + * <p>Type: java.util.Map<String,DataHandler> + */ + public static final String INBOUND_MESSAGE_ATTACHMENTS = + "javax.xml.ws.binding.attachments.inbound"; + + /** + * Standard property: Map of attachments to a message for the outbound + * message, key is the MIME Content-ID, value is a DataHandler. + * <p>Type: java.util.Map<String,DataHandler> + */ + public static final String OUTBOUND_MESSAGE_ATTACHMENTS = + "javax.xml.ws.binding.attachments.outbound"; + + /** + * Standard property: input source for WSDL document. + * <p>Type: org.xml.sax.InputSource + */ + public static final String WSDL_DESCRIPTION = + "javax.xml.ws.wsdl.description"; + + /** + * Standard property: name of WSDL service. + * <p>Type: javax.xml.namespace.QName + */ + public static final String WSDL_SERVICE = + "javax.xml.ws.wsdl.service"; + + /** + * Standard property: name of WSDL port. + * <p>Type: javax.xml.namespace.QName + */ + public static final String WSDL_PORT = + "javax.xml.ws.wsdl.port"; + + /** + * Standard property: name of wsdl interface (2.0) or port type (1.1). + * <p>Type: javax.xml.namespace.QName + */ + public static final String WSDL_INTERFACE = + "javax.xml.ws.wsdl.interface"; + + /** + * Standard property: name of WSDL operation. + * <p>Type: javax.xml.namespace.QName + */ + public static final String WSDL_OPERATION = + "javax.xml.ws.wsdl.operation"; + + /** + * Standard property: HTTP response status code. + * <p>Type: java.lang.Integer + */ + public static final String HTTP_RESPONSE_CODE = + "javax.xml.ws.http.response.code"; + + /** + * Standard property: HTTP request headers. + * <p>Type: java.util.Map<java.lang.String, java.util.List<java.lang.String>> + */ + public static final String HTTP_REQUEST_HEADERS = + "javax.xml.ws.http.request.headers"; + + /** + * Standard property: HTTP response headers. + * <p>Type: java.util.Map<java.lang.String, java.util.List<java.lang.String>> + */ + public static final String HTTP_RESPONSE_HEADERS = + "javax.xml.ws.http.response.headers"; + + /** + * Standard property: HTTP request method. + * <p>Type: java.lang.String + */ + public static final String HTTP_REQUEST_METHOD = + "javax.xml.ws.http.request.method"; + + /** + * Standard property: servlet request object. + * <p>Type: javax.servlet.http.HttpServletRequest + */ + public static final String SERVLET_REQUEST = + "javax.xml.ws.servlet.request"; + + /** + * Standard property: servlet response object. + * <p>Type: javax.servlet.http.HttpServletResponse + */ + public static final String SERVLET_RESPONSE = + "javax.xml.ws.servlet.response"; + + /** + * Standard property: servlet context object. + * <p>Type: javax.servlet.ServletContext + */ + public static final String SERVLET_CONTEXT = + "javax.xml.ws.servlet.context"; + + /** + * Standard property: Query string for request. + * <p>Type: String + **/ + public static final String QUERY_STRING = + "javax.xml.ws.http.request.querystring"; + + /** + * Standard property: Request Path Info + * <p>Type: String + */ + public static final String PATH_INFO = + "javax.xml.ws.http.request.pathinfo"; + + /** + * Standard property: WS Addressing Reference Parameters. + * The list MUST include all SOAP headers marked with the + * wsa:IsReferenceParameter="true" attribute. + * <p>Type: List<Element> + * + * @since JAX-WS 2.1 + */ + public static final String REFERENCE_PARAMETERS = + "javax.xml.ws.reference.parameters"; + + /** + * Property scope. Properties scoped as <code>APPLICATION</code> are + * visible to handlers, + * client applications and service endpoints; properties scoped as + * <code>HANDLER</code> + * are only normally visible to handlers. + */ + public enum Scope {APPLICATION, HANDLER}; + + /** + * Sets the scope of a property. + * + * @param name Name of the property associated with the + * <code>MessageContext</code> + * @param scope Desired scope of the property + * @throws java.lang.IllegalArgumentException if an illegal + * property name is specified + */ + public void setScope(String name, Scope scope); + + /** + * Gets the scope of a property. + * + * @param name Name of the property + * @return Scope of the property + * @throws java.lang.IllegalArgumentException if a non-existant + * property name is specified + */ + public Scope getScope(String name); +} Modified: trunk/src/main/java/javax/xml/ws/handler/PortInfo.java =================================================================== --- trunk/src/main/java/javax/xml/ws/handler/PortInfo.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/handler/PortInfo.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,22 +21,44 @@ */ package javax.xml.ws.handler; +// $Id$ + import javax.xml.namespace.QName; -/** - * The PortInfo interface is used by a HandlerResolver to query information about the - * port it is being asked to create a handler chain for. - * - * This interface is never implemented by an application, only by a JAX-WS implementation. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ -public interface PortInfo -{ - QName getServiceName(); +/** + * The <code>PortInfo</code> interface is used by a + * <code>HandlerResolver</code> to query information about + * the port it is being asked to create a handler chain for. + * <p> + * This interface is never implemented by an application, + * only by a JAX-WS implementation. + * + * @since JAX-WS 2.0 +**/ +public interface PortInfo { - QName getPortName(); + /** + * Gets the qualified name of the WSDL service name containing + * the port being accessed. + * + * @return javax.xml.namespace.QName The qualified name of the WSDL service. + **/ + public QName getServiceName(); - String getBindingID(); -} \ No newline at end of file + /** + * Gets the qualified name of the WSDL port being accessed. + * + * @return javax.xml.namespace.QName The qualified name of the WSDL port. + **/ + public QName getPortName(); + + /** + * Gets the URI identifying the binding used by the port being accessed. + * + * @return String The binding identifier for the port. + * + * @see javax.xml.ws.Binding + **/ + public String getBindingID(); + +} Modified: trunk/src/main/java/javax/xml/ws/handler/soap/SOAPHandler.java =================================================================== --- trunk/src/main/java/javax/xml/ws/handler/soap/SOAPHandler.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/handler/soap/SOAPHandler.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,21 +21,27 @@ */ package javax.xml.ws.handler.soap; -import java.util.Set; +// $Id$ import javax.xml.namespace.QName; import javax.xml.ws.handler.Handler; +import java.util.Set; -/** - * The SOAPHandler class extends Handler to provide typesafety for the - * message context parameter and add a method to obtain access to the - * headers that may be processed by the handler. +/** The <code>SOAPHandler</code> class extends <code>Handler</code> + * to provide typesafety for the message context parameter and add a method + * to obtain access to the headers that may be processed by the handler. * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ -public interface SOAPHandler<T> extends Handler -{ + * @since JAX-WS 2.0 +**/ +public interface SOAPHandler<T extends SOAPMessageContext> + extends Handler<T> { - Set<QName> getHeaders(); -} \ No newline at end of file + /** Gets the header blocks that can be processed by this Handler + * instance. + * + * @return Set of QNames of header blocks processed by this + * handler instance. <code>QName</code> is the qualified + * name of the outermost element of the Header block. + **/ + Set<QName> getHeaders(); +} Modified: trunk/src/main/java/javax/xml/ws/handler/soap/SOAPMessageContext.java =================================================================== --- trunk/src/main/java/javax/xml/ws/handler/soap/SOAPMessageContext.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/handler/soap/SOAPMessageContext.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,30 +21,77 @@ */ package javax.xml.ws.handler.soap; -import java.net.URI; -import java.util.Set; +// $Id$ +import javax.xml.soap.SOAPMessage; import javax.xml.bind.JAXBContext; import javax.xml.namespace.QName; -import javax.xml.soap.SOAPMessage; -import javax.xml.ws.handler.MessageContext; +import java.util.Set; -/** - * The interface SOAPMessageContext provides access to the SOAP message for either - * RPC request or response. The javax.xml.soap.SOAPMessage specifies the standard - * Java API for the representation of a SOAP 1.1 message with attachments. +/** The interface <code>SOAPMessageContext</code> + * provides access to the SOAP message for either RPC request or + * response. The <code>javax.xml.soap.SOAPMessage</code> specifies + * the standard Java API for the representation of a SOAP 1.1 message + * with attachments. + * + * @see javax.xml.soap.SOAPMessage * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ -public interface SOAPMessageContext extends MessageContext -{ + * @since JAX-WS 2.0 +**/ +public interface SOAPMessageContext + extends javax.xml.ws.handler.MessageContext { - SOAPMessage getMessage(); + /** Gets the SOAPMessage from this message context. Modifications + * to the returned SOAPMessage change the message in-place, there + * is no need to susequently call <code>setMessage</code>. + * + * @return Returns the SOAPMessage; returns null if no + * SOAPMessage is present in this message context + **/ + public SOAPMessage getMessage(); - void setMessage(SOAPMessage soapmessage); + /** Sets the SOAPMessage in this message context + * + * @param message SOAP message + * @throws WebServiceException If any error during the setting + * of the SOAPMessage in this message context + * @throws java.lang.UnsupportedOperationException If this + * operation is not supported + **/ + public void setMessage(SOAPMessage message); - Object[] getHeaders(QName qname, JAXBContext jaxbcontext, boolean flag); + /** Gets headers that have a particular qualified name from the message in the + * message context. Note that a SOAP message can contain multiple headers + * with the same qualified name. + * + * @param header The XML qualified name of the SOAP header(s). + * @param context The JAXBContext that should be used to unmarshall the + * header + * @param allRoles If <code>true</code> then returns headers for all SOAP + * roles, if <code>false</code> then only returns headers targetted + * at the roles currently being played by this SOAP node, see + * <code>getRoles</code>. + * @return An array of unmarshalled headers; returns an empty array if no + * message is present in this message context or no headers match + * the supplied qualified name. + * @throws WebServiceException If an error occurs when using the supplied + * JAXBContext to unmarshall. The cause of + * the WebServiceException is the original JAXBException. + **/ + public Object[] getHeaders(QName header, JAXBContext context, + boolean allRoles); - Set<URI> getRoles(); -} \ No newline at end of file + /** Gets the SOAP actor roles associated with an execution + * of the handler chain. + * Note that SOAP actor roles apply to the SOAP node and + * are managed using <code>SOAPBinding.setRoles</code> and + * <code>SOAPBinding.getRoles</code>. Handler instances in + * the handler chain use this information about the SOAP actor + * roles to process the SOAP header blocks. Note that the + * SOAP actor roles are invariant during the processing of + * SOAP message through the handler chain. + * + * @return Array of String for SOAP actor roles + **/ + public Set<String> getRoles(); +} Modified: trunk/src/main/java/javax/xml/ws/http/HTTPBinding.java =================================================================== --- trunk/src/main/java/javax/xml/ws/http/HTTPBinding.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/http/HTTPBinding.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,16 +21,19 @@ */ package javax.xml.ws.http; +// $Id$ + import javax.xml.ws.Binding; -/** - * The HTTPBinding interface is an abstraction for the XML/HTTP binding. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ -public interface HTTPBinding extends Binding -{ +/** The <code>HTTPBinding</code> interface is an + * abstraction for the XML/HTTP binding. + * + * @since JAX-WS 2.0 +**/ +public interface HTTPBinding extends Binding { - public static final String HTTP_BINDING = "http://www.w3.org/2004/08/wsdl/http"; -} \ No newline at end of file + /** + * A constant representing the identity of the XML/HTTP binding. + */ + public static final String HTTP_BINDING = "http://www.w3.org/2004/08/wsdl/http"; +} Modified: trunk/src/main/java/javax/xml/ws/http/HTTPException.java =================================================================== --- trunk/src/main/java/javax/xml/ws/http/HTTPException.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/http/HTTPException.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,28 +21,34 @@ */ package javax.xml.ws.http; -import javax.xml.ws.ProtocolException; +// $Id$ -/** - * The HTTPException exception represents a XML/HTTP fault. + +/** The <code>HTTPException</code> exception represents a + * XML/HTTP fault. + * + * <p>Since there is no standard format for faults or exceptions + * in XML/HTTP messaging, only the HTTP status code is captured. * - * Since there is no standard format for faults or exceptions in XML/HTTP messaging, - * only the HTTP status code is captured. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ -public class HTTPException extends ProtocolException -{ - private int statusCode; + * @since JAX-WS 2.0 +**/ +public class HTTPException extends javax.xml.ws.ProtocolException { + + private int statusCode; - public HTTPException(int statusCode) - { - this.statusCode = statusCode; - } + /** Constructor for the HTTPException + * @param statusCode <code>int</code> for the HTTP status code + **/ + public HTTPException(int statusCode) { + super(); + this.statusCode = statusCode; + } - public int getStatusCode() - { - return statusCode; - } -} \ No newline at end of file + /** Gets the HTTP status code. + * + * @return HTTP status code + **/ + public int getStatusCode() { + return statusCode; + } +} Added: trunk/src/main/java/javax/xml/ws/soap/Addressing.java =================================================================== --- trunk/src/main/java/javax/xml/ws/soap/Addressing.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/soap/Addressing.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -0,0 +1,90 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package javax.xml.ws.soap; + +// $Id$ + +import java.lang.annotation.Documented; +import java.lang.annotation.Target; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; + +import javax.xml.ws.spi.WebServiceFeatureAnnotation; + +/** + * This feature represents the use of WS-Addressing with either + * the SOAP 1.1/HTTP or SOAP 1.2/HTTP binding. Using this feature + * with any other binding is NOT required. + * <p> + * Enabling this feature will result in the + * <code>wsaw:UsingAddressing</code> element being added to the + * <code>wsdl:Binding</code> for + * the endpoint and in the runtime being capable of responding to + * WS-Addressing headers. + * <p> + * The following describes the affects of this feature with respect + * to be enabled or disabled: + * <ul> + * <li> ENABLED: In this Mode, Addressing will be enabled. + * If there is not a WSDL associated with the Endpoint and + * a WSDL is to be generated, it MUST be generated with the + * wsaw:UsingAddressing element. At runtime, Addressing headers + * MUST be consumed by the receiver and generated by the + * sender even if the WSDL declares otherwise. The + * mustUnderstand="0" attribute MUST be used on the Addressing + * headers. + * <li> DISABLED: In this Mode, Addressing will be disabled + * even if an associated WSDL specifies otherwise. At runtime, + * Addressing headers MUST NOT be used. + * </ul> + * <p> + * The {@link #required} property can be used to + * specify if the <code>required</code> attribute on the + * <code>wsaw:UsingAddressing</code> element should + * be <code>true</code> or <code>false</code>. By default the + * <code>wsdl:required</code> parameter is <code>false</code>. + * + * See <a href="http://www.w3.org/TR/2006/REC-ws-addr-core-20060509/">... + * for more information on WS-Addressing. + * See <a href="http://www.w3.org/TR/2006/CR-ws-addr-wsdl-20060529/">W... - WSDL 1.0 + * </a> for more information on <code>wsaw:UsingAddressing</code>. + * + * @since JAX-WS 2.1 + */ +(a)Target(ElementType.TYPE) +(a)Retention(RetentionPolicy.RUNTIME) +@Documented +(a)WebServiceFeatureAnnotation(id=AddressingFeature.ID,bean=AddressingFeature.class) +public @interface Addressing { + /** + * Specifies if this feature is enabled or disabled. + */ + boolean enabled() default true; + + /** + * Property to determine the value of the + * <code>wsdl:required</code> attribute on + * <code>wsaw:UsingAddressing</code> element in the WSDL. + */ + boolean required() default false; +} Property changes on: trunk/src/main/java/javax/xml/ws/soap/Addressing.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Added: trunk/src/main/java/javax/xml/ws/soap/AddressingFeature.java =================================================================== --- trunk/src/main/java/javax/xml/ws/soap/AddressingFeature.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/soap/AddressingFeature.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -0,0 +1,145 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package javax.xml.ws.soap; + +// $Id$ + +import javax.xml.ws.WebServiceFeature; +import javax.xml.ws.WebServiceException; +import javax.xml.ws.spi.Provider; + +/** + * This feature represents the use of WS-Addressing with either + * the SOAP 1.1/HTTP or SOAP 1.2/HTTP binding. Using this feature + * with any other binding is NOT required. + * <p> + * Enabling this feature on the server will result in the + * <code>wsaw:UsingAddressing</code> element being added to the + * <code>wsdl:Binding</code> for + * the endpoint and in the runtime being capable of responding to + * WS-Addressing headers. + * <p> + * Enabling this feature on the client will cause the JAX-WS runtime + * to include WS-Addressing headers in SOAP messages. + * <p> + * If the web service developer has not explicitly enabled this feature, + * it may be automatically enabled if the associated WSDL enables + * WS-Addressing via the <code>wsaw:UsingAddressing</code> element with + * the <code>wsdl:required</code> attribute set to <code>true</code>. + * <br> + * See {@link javax.xml.ws.RespectBindingFeature} for more information + * on required WSDL extensions. + * <p> + * The following describes the affects of this feature with respect + * to be enabled or disabled: + * <ul> + * <li> ENABLED: In this Mode, Addressing will be enabled. + * If there is not a WSDL associated with the Endpoint and + * a WSDL is to be generated, it MUST be generated with the + * wsaw:UsingAddressing element. At runtime, Addressing headers + * MUST be consumed by the receiver and generated by the + * sender even if the WSDL declares otherwise. The + * mustUnderstand="0" attribute MUST be used on the Addressing + * headers. + * <li> DISABLED: In this Mode, Addressing will be disabled + * even if an associated WSDL specifies otherwise. At runtime, + * Addressing headers MUST NOT be used. + * </ul> + * <p> + * The {@link #required} property can be used to + * specify if the <code>required</code> attribute on the + * <code>wsaw:UsingAddressing</code> element should + * be <code>true</code> or <code>false</code>. By default the + * <code>wsdl:required</code> parameter is <code>false</code>. + * + * See <a href="http://www.w3.org/TR/2006/REC-ws-addr-core-20060509/">... + * for more information on WS-Addressing. + * See <a href="http://www.w3.org/TR/2006/CR-ws-addr-wsdl-20060529/">W... - WSDL 1.0 + * </a> for more information on <code>wsaw:UsingAddressing</code>. + * + * @since JAX-WS 2.1 + */ +public final class AddressingFeature extends WebServiceFeature { + /** + * Constant value identifying the AddressingFeature + */ + public static final String ID = "http://www.w3.org/2005/08/addressing/module"; + + /** + * Property for <code>required</code> feature parameter. When Addressing + * is enabled, the value of this property will be set to the + * <code>wsdl:required</code> attribute on + * <code>wsaw:UsingAddressing</code> element in the WSDL. + */ + protected boolean required = false; + + /** + * Create an <code>AddressingFeature</code>. + * The instance created will be enabled. + */ + public AddressingFeature() { + this.enabled = true; + } + + /** + * Create an <code>AddressingFeature</code> + * + * @param enabled specifies whether this feature should + * be enabled or not. + */ + public AddressingFeature(boolean enabled) { + this.enabled = enabled; + } + + /** + * Create an <code>AddressingFeature</code> + * + * @param enabled specifies whether this feature should + * be enabled or not. + * @param required specifies the value that will be used + * for the <code>wsdl:required</code> attribute on the + * <code>wsaw:UsingAddressing</code> element. + */ + public AddressingFeature(boolean enabled, boolean required) { + this.enabled = enabled; + this.required = required; + } + + /** + * {@inheritDoc} + */ + public String getID() { + return ID; + } + + /** + * Gets the boolean value used to set the + * <code>wsdl:required</code> attribute on + * <code>wsaw:UsingAddressing</code> element + * in the WSDL. + * + * @return the current required value + */ + public boolean isRequired() { + return required; + } +} Property changes on: trunk/src/main/java/javax/xml/ws/soap/AddressingFeature.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Added: trunk/src/main/java/javax/xml/ws/soap/MTOM.java =================================================================== --- trunk/src/main/java/javax/xml/ws/soap/MTOM.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/soap/MTOM.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -0,0 +1,67 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package javax.xml.ws.soap; + +// $Id$ + +import java.lang.annotation.Documented; +import java.lang.annotation.Target; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; + +import javax.xml.ws.spi.WebServiceFeatureAnnotation; + +/** + * This feature represents the use of MTOM with a + * web service. + * + * <p> + * The following describes the affects of this feature with respect + * to being enabled or disabled: + * <ul> + * <li> ENABLED: In this Mode, MTOM will be enabled. + * <li> DISABLED: In this Mode, MTOM will be disabled + * </ul> + * <p> + * The {@link #threshold} property can be used to set the threshold + * value used to determine when binary data should be XOP encoded. + * + * @since JAX-WS 2.1 + */ +(a)Target(ElementType.TYPE) +(a)Retention(RetentionPolicy.RUNTIME) +@Documented +(a)WebServiceFeatureAnnotation(id=MTOMFeature.ID,bean=MTOMFeature.class) +public @interface MTOM { + /** + * Specifies if this feature is enabled or disabled. + */ + boolean enabled() default true; + + /** + * Property for MTOM threshold value. When MTOM is enabled, binary data above this + * size in bytes will be XOP encoded or sent as attachment. The value of this property + * MUST always be >= 0. Default value is 0. + */ + int threshold() default 0; +} Property changes on: trunk/src/main/java/javax/xml/ws/soap/MTOM.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Added: trunk/src/main/java/javax/xml/ws/soap/MTOMFeature.java =================================================================== --- trunk/src/main/java/javax/xml/ws/soap/MTOMFeature.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/soap/MTOMFeature.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -0,0 +1,132 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package javax.xml.ws.soap; + +// $Id$ + +import javax.xml.ws.Binding; +import javax.xml.ws.BindingType; +import javax.xml.ws.WebServiceFeature; +import javax.xml.ws.WebServiceException; +import javax.xml.ws.spi.Provider; + + +/** + * This feature represents the use of MTOM with a + * web service. + * + * <p> + * The following describes the affects of this feature with respect + * to being enabled or disabled: + * <ul> + * <li> ENABLED: In this Mode, MTOM will be enabled. + * <li> DISABLED: In this Mode, MTOM will be disabled + * </ul> + * <p> + * The {@link #threshold} property can be used to set the threshold + * value used to determine when binary data should be XOP encoded. + * + * @since JAX-WS 2.1 + */ +public final class MTOMFeature extends WebServiceFeature { + /** + * Constant value identifying the MTOMFeature + */ + public static final String ID = "http://www.w3.org/2004/08/soap/features/http-optimization"; + + + /** + * Property for MTOM threshold value. This property serves as a hint when + * MTOM is enabled, binary data above this size in bytes SHOULD be sent + * as attachment. + * The value of this property MUST always be >= 0. Default value is 0. + */ + protected int threshold = 0; + + + /** + * Create an <code>MTOMFeature</code>. + * The instance created will be enabled. + */ + public MTOMFeature() { + this.enabled = true; + } + + /** + * Creates an <code>MTOMFeature</code>. + * + * @param enabled specifies if this feature should be enabled or not + */ + public MTOMFeature(boolean enabled) { + this.enabled = enabled; + } + + + /** + * Creates an <code>MTOMFeature</code>. + * The instance created will be enabled. + * + * @param threshold the size in bytes that binary data SHOULD be before + * being sent as an attachment. + * + * @throws WebServiceException if threshold is < 0 + */ + public MTOMFeature(int threshold) { + if (threshold < 0) + throw new WebServiceException("MTOMFeature.threshold must be >= 0, actual value: "+threshold); + this.enabled = true; + this.threshold = threshold; + } + + /** + * Creates an <code>MTOMFeature</code>. + * + * @param enabled specifies if this feature should be enabled or not + * @param threshold the size in bytes that binary data SHOULD be before + * being sent as an attachment. + * + * @throws WebServiceException if threshold is < 0 + */ + public MTOMFeature(boolean enabled, int threshold) { + if (threshold < 0) + throw new WebServiceException("MTOMFeature.threshold must be >= 0, actual value: "+threshold); + this.enabled = enabled; + this.threshold = threshold; + } + + /** + * {@inheritDoc} + */ + public String getID() { + return ID; + } + + /** + * Gets the threshold value used to determine when binary data + * should be sent as an attachment. + * + * @return the current threshold size in bytes + */ + public int getThreshold() { + return threshold; + } +} Property changes on: trunk/src/main/java/javax/xml/ws/soap/MTOMFeature.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Modified: trunk/src/main/java/javax/xml/ws/soap/SOAPBinding.java =================================================================== --- trunk/src/main/java/javax/xml/ws/soap/SOAPBinding.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/soap/SOAPBinding.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,54 +21,87 @@ */ package javax.xml.ws.soap; -import java.net.URI; +// $Id$ + import java.util.Set; - +import javax.xml.ws.Binding; +import javax.xml.soap.SOAPFactory; import javax.xml.soap.MessageFactory; -import javax.xml.soap.SOAPFactory; -import javax.xml.ws.Binding; -/** - * The SOAPBinding interface is an abstraction for the SOAP binding. +/** The <code>SOAPBinding</code> interface is an abstraction for + * the SOAP binding. * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ -public interface SOAPBinding extends Binding -{ - /** - * A constant representing the identity of the SOAP 1.1 over HTTP binding. - */ - public static final String SOAP11HTTP_BINDING = "http://schemas.xmlsoap.org/wsdl/soap/http"; + * @since JAX-WS 2.0 +**/ +public interface SOAPBinding extends Binding { - /** - * A constant representing the identity of the SOAP 1.2 over HTTP binding. - */ - public static final String SOAP12HTTP_BINDING = "http://www.w3.org/2003/05/soap/bindings/HTTP/"; + /** + * A constant representing the identity of the SOAP 1.1 over HTTP binding. + */ + public static final String SOAP11HTTP_BINDING = "http://schemas.xmlsoap.org/wsdl/soap/http"; - /** - * A constant representing the identity of the SOAP 1.1 over HTTP binding - * with MTOM enabled by default. - */ - public static final String SOAP11HTTP_MTOM_BINDING = "http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true"; + /** + * A constant representing the identity of the SOAP 1.2 over HTTP binding. + */ + public static final String SOAP12HTTP_BINDING = "http://www.w3.org/2003/05/soap/bindings/HTTP/"; - /** - * A constant representing the identity of the SOAP 1.2 over HTTP binding - * with MTOM enabled by default. - */ - public static final String SOAP12HTTP_MTOM_BINDING = "http://www.w3.org/2003/05/soap/bindings/HTTP/?mtom=true"; + /** + * A constant representing the identity of the SOAP 1.1 over HTTP binding + * with MTOM enabled by default. + */ + public static final String SOAP11HTTP_MTOM_BINDING = "http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true"; + /** + * A constant representing the identity of the SOAP 1.2 over HTTP binding + * with MTOM enabled by default. + */ + public static final String SOAP12HTTP_MTOM_BINDING = "http://www.w3.org/2003/05/soap/bindings/HTTP/?mtom=true"; + + + /** Gets the roles played by the SOAP binding instance. + * + * @return Set<String> The set of roles played by the binding instance. + **/ + public Set<String> getRoles(); - public abstract Set<URI> getRoles(); + /** Sets the roles played by the SOAP binding instance. + * + * @param roles The set of roles played by the binding instance. + * @throws WebServiceException On an error in the configuration of + * the list of roles. + **/ + public void setRoles(Set<String> roles); - public abstract void setRoles(Set<URI> set); - - public abstract boolean isMTOMEnabled(); - - public abstract void setMTOMEnabled(boolean flag); - - public abstract SOAPFactory getSOAPFactory(); - - public abstract MessageFactory getMessageFactory(); - -} \ No newline at end of file + /** + * Returns <code>true</code> if the use of MTOM is enabled. + * + * @return <code>true</code> if and only if the use of MTOM is enabled. + **/ + + public boolean isMTOMEnabled(); + + /** + * Enables or disables use of MTOM. + * + * @param flag A <code>boolean</code> specifying whether the use of MTOM should + * be enabled or disabled. + * @throws WebServiceException If the specified setting is not supported + * by this binding instance. + * * + **/ + public void setMTOMEnabled(boolean flag); + + /** + * Gets the SAAJ <code>SOAPFactory</code> instance used by this SOAP binding. + * + * @return SOAPFactory instance used by this SOAP binding. + **/ + public SOAPFactory getSOAPFactory(); + + /** + * Gets the SAAJ <code>MessageFactory</code> instance used by this SOAP binding. + * + * @return MessageFactory instance used by this SOAP binding. + **/ + public MessageFactory getMessageFactory(); +} Modified: trunk/src/main/java/javax/xml/ws/soap/SOAPFaultException.java =================================================================== --- trunk/src/main/java/javax/xml/ws/soap/SOAPFaultException.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/soap/SOAPFaultException.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,30 +21,43 @@ */ package javax.xml.ws.soap; +// $Id$ + import javax.xml.soap.SOAPFault; -import javax.xml.ws.ProtocolException; -/** - * The SOAPFaultException exception represents a SOAP 1.1 or 1.2 fault. - * - * A SOAPFaultException wraps a SAAJ SOAPFault that manages the SOAP-specific - * representation of faults. The createFault method of javax.xml.soap.SOAPFactory - * may be used to create an instance of javax.xml.soap.SOAPFault for use with the - * constructor. SOAPBinding contains an accessor for the SOAPFactory used by the - * binding instance. - * - * Note that the value of getFault is the only part of the exception used when - * searializing a SOAP fault. - * - * Refer to the SOAP specification for a complete description of SOAP faults. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 - */ -public class SOAPFaultException extends ProtocolException +/** The <code>SOAPFaultException</code> exception represents a + * SOAP 1.1 or 1.2 fault. + * + * <p>A <code>SOAPFaultException</code> wraps a SAAJ <code>SOAPFault</code> + * that manages the SOAP-specific representation of faults. + * The <code>createFault</code> method of + * <code>javax.xml.soap.SOAPFactory</code> may be used to create an instance + * of <code>javax.xml.soap.SOAPFault</code> for use with the + * constructor. <code>SOAPBinding</code> contains an accessor for the + * <code>SOAPFactory</code> used by the binding instance. + * + * <p>Note that the value of <code>getFault</code> is the only part of the + * exception used when searializing a SOAP fault. + * + * <p>Refer to the SOAP specification for a complete + * description of SOAP faults. + * + * @see javax.xml.soap.SOAPFault + * @see javax.xml.ws.soap.SOAPBinding#getSOAPFactory + * @see javax.xml.ws.ProtocolException + * + * @since JAX-WS 2.0 + **/ +public class SOAPFaultException extends javax.xml.ws.ProtocolException { + private SOAPFault fault; + /** Constructor for SOAPFaultException + * @param fault <code>SOAPFault</code> representing the fault + * + * @see javax.xml.soap.SOAPFactory#createFault + **/ public SOAPFaultException(SOAPFault fault) { super(fault.getFaultString()); @@ -56,8 +69,13 @@ super(ex); } - public SOAPFault getFault() + /** Gets the embedded <code>SOAPFault</code> instance. + * + * @return <code>javax.xml.soap.SOAPFault</code> SOAP + * fault element + **/ + public javax.xml.soap.SOAPFault getFault() { - return fault; + return this.fault; } -} \ No newline at end of file +} Modified: trunk/src/main/java/javax/xml/ws/spi/Provider.java =================================================================== --- trunk/src/main/java/javax/xml/ws/spi/Provider.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/spi/Provider.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -23,13 +23,18 @@ // $Id$ -import java.net.URL; +import java.util.List; import javax.xml.namespace.QName; +import javax.xml.transform.Source; import javax.xml.ws.Endpoint; +import javax.xml.ws.EndpointReference; import javax.xml.ws.WebServiceException; +import javax.xml.ws.WebServiceFeature; +import javax.xml.ws.wsaddressing.W3CEndpointReference; import org.jboss.ws.core.jaxws.util.FactoryFinder; +import org.w3c.dom.Element; /** * Service provider for ServiceDelegate and Endpoint objects. @@ -42,46 +47,258 @@ public static final String JAXWSPROVIDER_PROPERTY = "javax.xml.ws.spi.Provider"; private static final String DEFAULT_JAXWSPROVIDER = "org.jboss.ws.core.jaxws.spi.ProviderImpl"; - protected Provider() - { - } - - /** - * The algorithm used to locate the provider subclass to use consists of the following steps: - * - * - If a resource with the name of META-INF/services/javax.xml.ws.spi.Provider exists, then its first line, if present, is used as the UTF-8 encoded name of the implementation class. - * - If the $java.home/lib/jaxws.properties file exists and it is readable by the java.util.Properties.load(InputStream) method and it contains an entry whose key is javax.xml.ws.spi.Provider, then the value of that entry is used as the name of the implementation class. - * - If a system property with the name javax.xml.ws.spi.Provider is defined, then its value is used as the name of the implementation class. - * - * Finally, a default implementation class name is used. - */ - public static Provider provider() - { - try - { - return (Provider)FactoryFinder.find(JAXWSPROVIDER_PROPERTY, DEFAULT_JAXWSPROVIDER); - } - catch (Exception ex) - { - throw new WebServiceException((new StringBuilder()).append("Unable to create Provider: ").append(ex.getMessage()).toString()); - } - } - - public abstract ServiceDelegate createServiceDelegate(URL url, QName serviceName, Class class1); - - /** - * Creates an endpoint object with the provided binding and implementation object. - * - * @param bindingId A URI specifying the desired binding (e.g. SOAP/HTTP) - * @param 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. - */ - public abstract Endpoint createEndpoint(String bindingId, Object implementor); - - /** - * Creates and publishes an endpoint object with the specified address and implementation object. - * @param bindingId 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. - * @param 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. - */ - public abstract Endpoint createAndPublishEndpoint(String bindingId, Object implementor); -} \ No newline at end of file + /** + * Creates a new instance of Provider + */ + protected Provider() { + } + + /** + * + * Creates a new provider object. + * <p> + * The algorithm used to locate the provider subclass to use consists + * of the following steps: + * <p> + * <ul> + * <li> + * If a resource with the name of + * <code>META-INF/services/javax.xml.ws.spi.Provider</code> + * exists, then its first line, if present, is used as the UTF-8 encoded + * name of the implementation class. + * </li> + * <li> + * If the $java.home/lib/jaxws.properties file exists and it is readable by + * the <code>java.util.Properties.load(InputStream)</code> method and it contains + * an entry whose key is <code>javax.xml.ws.spi.Provider</code>, then the value of + * that entry is used as the name of the implementation class. + * </li> + * <li> + * If a system property with the name <code>javax.xml.ws.spi.Provider</code> + * is defined, then its value is used as the name of the implementation class. + * </li> + * <li> + * Finally, a default implementation class name is used. + * </li> + * </ul> + * + */ + public static Provider provider() { + try { + return (Provider) + FactoryFinder.find(JAXWSPROVIDER_PROPERTY, + DEFAULT_JAXWSPROVIDER); + } catch (WebServiceException ex) { + throw ex; + } catch (Exception ex) { + throw new WebServiceException("Unable to createEndpointReference Provider: "+ + ex.getMessage()); + } + + } + + /** + * Creates a service delegate object. + * <p> + * @param wsdlDocumentLocation A URL pointing to the WSDL document + * for the service, or <code>null</code> if there isn't one. + * @param serviceName The qualified name of the service. + * @param serviceClass The service class, which MUST be either + * <code>javax.xml.ws.Service</code> or a subclass thereof. + * @return The newly created service delegate. + */ + public abstract ServiceDelegate createServiceDelegate( + java.net.URL wsdlDocumentLocation, + QName serviceName, Class serviceClass); + + + /** + * + * Creates an endpoint object with the provided binding and implementation + * object. + * + * @param bindingId A URI specifying the desired binding (e.g. SOAP/HTTP) + * @param 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. + * @return The newly created endpoint. + */ + public abstract Endpoint createEndpoint(String bindingId, + Object implementor); + + + /** + * Creates and publishes an endpoint object with the specified + * address and implementation object. + * + * @param 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. + * @param 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. + * @return The newly created endpoint. + */ + public abstract Endpoint createAndPublishEndpoint(String address, + Object implementor); + /** + * read an EndpointReference from the infoset contained in + * <code>eprInfoset</code>. + * + * @returns the <code>EndpointReference</code> unmarshalled from + * <code>eprInfoset</code>. This method never returns <code>null</code>. + * + * @throws WebServiceException If there is an error creating the + * <code>EndpointReference</code> from the specified <code>eprInfoset</code>. + * + * @throws NullPointerException If the <code>null</code> + * <code>eprInfoset</code> value is given. + * + * @since JAX-WS 2.1 + **/ + public abstract EndpointReference readEndpointReference(javax.xml.transform.Source eprInfoset); + + /** + * Create an EndpointReference for <code>serviceName</code> + * service and <code>portName</code> port from the WSDL <code>wsdlDocumentLocation</code>. The instance + * returned will be of type <code>clazz</code> and contain the <code>referenceParameters</code> + * reference parameters. This method delegates to the vendor specific + * implementation of the {@link javax.xml.ws.spi.Provider#createEndpointReference(Class<T>, javax.xml.namespace.QName, javax.xml.namespace.QName, javax.xml.transform.Source, org.w3c.dom.Element...)} method. + * + * @param clazz Specifies the type of <code>EndpointReference</code> that MUST be returned. + * @param serviceName Qualified name of the service in the WSDL. + * @param portName Qualified name of the endpoint in the WSDL. + * @param wsdlDocumentLocation URL for the WSDL document location for the service. + * @param referenceParameters Reference parameters to be associated with the + * returned <code>EndpointReference</code> instance. + * + * @return the EndpointReference created from <code>serviceName</code>, <code>portName</code>, + * <code>wsdlDocumentLocation</code> and <code>referenceParameters</code>. This method + * never returns <code>null</code>. + * @throws WebServiceException + * <UL> + * <li>If the <code>serviceName</code> service is not present in the WSDL. + * <li>If the <code>portName</code> port is not present in <code>serviceName</code> service in the WSDL. + * <li>If the <code>wsdlDocumentLocation</code> does not represent a valid WSDL. + * <li>If an error occurs while creating the <code>EndpointReference</code>. + * <li>If the Class <code>clazz</code> is not supported by this implementation. + * </UL> + * @throws java.lang.IllegalArgumentException + * if any of the <code>clazz</code>, <code>serviceName</code>, <code>portName</code> and <code>wsdlDocumentLocation</code> is null. + */ + public abstract <T extends EndpointReference> T createEndpointReference(Class<T> clazz, QName serviceName, QName portName, Source wsdlDocumentLocation, Element... referenceParameters); + + + /** + * The getPort method returns a proxy. If there + * are any reference parameters in the + * <code>endpointReference</code>, then those reference + * parameters MUST appear as SOAP headers, indicating them to be + * reference parameters, on all messages sent to the endpoint. + * The parameter <code>serviceEndpointInterface</code> specifies + * the service endpoint interface that is supported by the + * returned proxy. + * The parameter <code>endpointReference</code> specifies the + * endpoint that will be invoked 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 Metadata from the <code>EndpointReference</code>. + * + * + * @param endpointReference the EndpointReference that will + * be invoked by the returned proxy. + * @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. + * @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 this + * <code>endpointReference</code> + * is illegal + * <LI>If an illegal + * <code>serviceEndpointInterface</code> + * is specified + * <LI>If feature is enabled that is not compatible with + * this port or is unsupported. + * </UL> + * + * @see WebServiceFeature + * + * @since JAX-WS 2.1 + **/ + public abstract <T> T getPort(EndpointReference endpointReference, + Class<T> serviceEndpointInterface, + WebServiceFeature... features); + + /** + * Factory method to create a <code>W3CEndpointReference</code>. + * + * <p> + * This method can be used to create a <code>W3CEndpointReference</code> + * for any endpoint by specifying the <code>address</code> property along + * with any other desired properties. This method + * can also be used to create a <code>W3CEndpointReference</code> for + * an endpoint that is published by the same Java EE application. + * To do so the <code>address</code> property can be provided or this + * method can automatically determine the <code>address</code> of + * an endpoint that is published by the same Java EE application and is + * identified by the <code>serviceName</code> and + * <code>portName</code> propeties. If the <code>address</code> is + * <code>null</code> and the <code>serviceName</code> and + * <code>portName</code> do not identify an endpoint published by the + * same Java EE application, a + * <code>javax.lang.IllegalArgumentException</code> MUST be thrown. + * + * @param address Specifies the address of the target endpoint + * @param serviceName Qualified name of the service in the WSDL. + * @param portName Qualified name of the endpoint in the WSDL. + * @param metadata A list of elements that should be added to the + * <code>W3CEndpointReference</code> instances <code>wsa:metadata</code> + * element. + * @param wsdlDocumentLocation URL for the WSDL document location for + * the service. + * @param referenceParameters Reference parameters to be associated + * with the returned <code>EndpointReference</code> instance. + * + * @return the <code>W3CEndpointReference<code> created from + * <code>serviceName</code>, <code>portName</code>, + * <code>metadata</code>, <code>wsdlDocumentLocation</code> + * and <code>referenceParameters</code>. This method + * never returns <code>null</code>. + * + * @throws javax.lang.IllegalArgumentException + * <ul> + * <li>If the <code>address</code>, <code>serviceName</code> and + * <code>portName</code> are all <code>null</code>. + * <li>If the <code>serviceName</code> service is <code>null</code> and the + * <code>portName> is NOT <code>null</code>. + * <li>If the <code>address</code> property is <code>null</code> and + * the <code>serviceName</code> and <code>portName</code> do not + * specify a valid endpoint published by the same Java EE + * application. + * <li>If the <code>serviceName</code>is NOT <code>null</code> + * and is not present in the specified WSDL. + * <li>If the <code>portName</code> port is not <code>null<code> and it + * is not present in <code>serviceName</code> service in the WSDL. + * <li>If the <code>wsdlDocumentLocation</code> is NOT <code>null</code> + * and does not represent a valid WSDL. + * </ul> + * @throws WebServiceException If an error occurs while creating the + * <code>W3CEndpointReference</code>. + * + * @since JAX-WS 2.1 + */ + public abstract W3CEndpointReference createW3CEndpointReference(String address, QName serviceName, QName portName, + List<Element> metadata, String wsdlDocumentLocation, List<Element> referenceParameters); +} Modified: trunk/src/main/java/javax/xml/ws/spi/ServiceDelegate.java =================================================================== --- trunk/src/main/java/javax/xml/ws/spi/ServiceDelegate.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/spi/ServiceDelegate.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,67 +21,618 @@ */ package javax.xml.ws.spi; -import java.net.URL; +// $Id$ + import java.util.Iterator; -import java.util.concurrent.Executor; - -import javax.xml.bind.JAXBContext; import javax.xml.namespace.QName; import javax.xml.ws.Dispatch; import javax.xml.ws.Service; import javax.xml.ws.handler.HandlerResolver; +import javax.xml.ws.WebServiceFeature; +import javax.xml.bind.JAXBContext; +import javax.xml.ws.EndpointReference; /** - * Service delegates are used internally by Service objects to allow pluggability - * of JAX-WS implementations. - * - * Every Service object has its own delegate, created using the - * Provider#createServiceDelegate method. A Service object - * delegates all of its instance methods to its delegate. - * - * @author Thomas.Diesler(a)jboss.com - * @since 03-May-2006 + * Service delegates are used internally by <code>Service</code> objects + * to allow pluggability of JAX-WS implementations. + * <p> + * Every <code>Service</code> object has its own delegate, created using + * the javax.xml.ws.Provider#createServiceDelegate method. A <code>Service</code> + * object delegates all of its instance methods to its delegate. + * + * @see javax.xml.ws.Service + * @see javax.xml.ws.spi.Provider + * + * @since JAX-WS 2.0 */ -public abstract class ServiceDelegate -{ - protected ServiceDelegate() - { - } +public abstract class ServiceDelegate { + + protected ServiceDelegate() { + } + + /** + * The getPort method returns a proxy. A service client + * uses this proxy to invoke operations on the target + * service endpoint. The <code>serviceEndpointInterface</code> + * 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 + * @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</code> + * or <code>portName</code> is specified + * </UL> + * @see java.lang.reflect.Proxy + * @see java.lang.reflect.InvocationHandler + **/ + public abstract <T> T getPort(QName portName, + Class<T> serviceEndpointInterface); + + /** + * The getPort method returns a proxy. A service client + * uses this proxy to invoke operations on the target + * service endpoint. The <code>serviceEndpointInterface</code> + * 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 or 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. + * @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</code> + * or <code>portName</code> 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 JAX-WS 2.1 + **/ + public abstract <T> T getPort(QName portName, + Class<T> serviceEndpointInterface, WebServiceFeature... features); + + /** + * The getPort method returns a proxy. + * The parameter <code>endpointReference</code> 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 + * 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 + * for invocations on the endpoint. + * The parameter <code>serviceEndpointInterface</code> 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 WSDL Metadata from the <code>endpointReference</code>. + * If this <code>Service</code> instance has a WSDL and + * the <code>endpointReference</code> + * also has a WSDL, then the WSDL from this instance will 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> will be used. + * The returned proxy should not be reconfigured by the client. + * If this <code>Service</code> 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> + * port = service.getPort(portName, serviceEndpointInterface); + * </pre> + * where the <code>portName</code> is retrieved from the + * <code>wsaw:EndpontName</code> attribute of the + * <code>wsaw:ServiceName</code> element in the + * metadata of the <code>endpointReference</code> or from the + * <code>serviceEndpointInterface</code> and the WSDL + * associated with this <code>Service</code> instance. + * <br> + * See <a href="http://www.w3.org/TR/2006/CR-ws-addr-wsdl-20060529/">W... - WSDL 1.0 + * </a>. + * + * @param endpointReference The <code>EndpointReference</code> + * for the target service endpoint that will be invoked by the + * returned proxy. + * @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. + * @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>wsaw:EndpointName</code> is + * missing from the <code>endpointReference</code> + * or does not match a wsdl:Port + * in the WSDL metadata. + * <LI>If the <code>wsaw:ServiceName</code> in the + * <code>endpointReference</code> metadata does not + * match the <code>serviceName</code> of this + * <code>Service</code> instance. + * <LI>If an invalid + * <code>endpointReference</code> + * is specified. + * <LI>If an invalid + * <code>serviceEndpointInterface</code> + * is specified. + * <LI>If a feature is enabled that is not compatible + * with this port or is unsupported. + * </UL> + * + * @since JAX-WS 2.1 + **/ + public abstract <T> T getPort(EndpointReference endpointReference, + Class<T> serviceEndpointInterface, WebServiceFeature... features); - public abstract <T> T getPort(QName qname, Class<T> sei); + + /** + * The getPort method returns a proxy. The parameter + * <code>serviceEndpointInterface</code> 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 + * @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> + * is specified + * </UL> + **/ + public abstract <T> T getPort(Class<T> serviceEndpointInterface); - public abstract <T> T getPort(Class<T> sei); + + /** + * The getPort method returns a proxy. The parameter + * <code>serviceEndpointInterface</code> 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 An array of WebServiceFeatures to configure on the + * proxy. Supported features not in the <code>features + * </code> 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> + * is specified + * <LI>If a feature is enabled that is not compatible + * with this port or is unsupported. + * </UL> + * + * @see WebServiceFeature + * + * @since JAX-WS 2.1 + **/ + public abstract <T> T getPort(Class<T> serviceEndpointInterface, + WebServiceFeature... 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 Dispatchinstances. - */ - public abstract void addPort(QName qname, String bindingId, String endpointAddress); + + + /** + * Creates a new port for the service. Ports created in this way contain + * no WSDL port type information and can only be used for creating + * <code>Dispatch</code>instances. + * + * @param portName Qualified name for the target service endpoint + * @param bindingId A URI 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 abstract void addPort(QName portName, String bindingId, + String endpointAddress); + + + + /** + * Creates a <code>Dispatch</code> instance for use with objects of + * the users 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 + * javax.xml.transform.Source and javax.xml.soap.SOAPMessage. + * @param mode Controls whether the created dispatch instance is message + * or payload oriented, i.e. whether the user will work with complete + * protocol messages or message payloads. E.g. when using the SOAP + * protocol, this parameter controls whether the user 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 + * @see javax.xml.transform.Source + * @see javax.xml.soap.SOAPMessage + **/ + public abstract <T> Dispatch<T> createDispatch(QName portName, Class<T> type, + Service.Mode mode); + + /** + * Creates a <code>Dispatch</code> instance for use with objects of + * the users 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 + * javax.xml.transform.Source and javax.xml.soap.SOAPMessage. + * @param mode Controls whether the created dispatch instance is message + * or payload oriented, i.e. whether the user will work with complete + * protocol messages or message payloads. E.g. when using the SOAP + * protocol, this parameter controls whether the user will work with + * SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE + * when type is SOAPMessage. + * @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. + * + * @return Dispatch instance + * @throws WebServiceException If any error in the creation of + * the <code>Dispatch</code> 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 JAX-WS 2.1 + **/ + public abstract <T> Dispatch<T> createDispatch(QName portName, Class<T> type, + Service.Mode mode, WebServiceFeature... features); + + + /** + * Creates a <code>Dispatch</code> instance for use with objects of + * the users choosing. If there + * are any reference parameters in the + * <code>endpointReference</code>, 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 + * 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 WSDL Metadata from the <code>endpointReference</code>. + * If this <code>Service</code> instance has a WSDL and + * the <code>endpointReference</code> + * also has a WSDL, then the WSDL from this instance will 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> will be used. + * <p> + * This method behaves the same as calling + * <pre> + * dispatch = service.createDispatch(portName, type, mode, features); + * </pre> + * where the <code>portName</code> is retrieved from the + * <code>wsaw:EndpointName</code> attribute of the <code>wsaw:ServiceName</code> + * element in the + * metadata of the <code>endpointReference</code>. + * <br> + * See <a href="http://www.w3.org/TR/2006/CR-ws-addr-wsdl-20060529/">W... - WSDL 1.0 + * </a>. + * + * @param endpointReference The <code>EndpointReference</code> + * for the target service endpoint that will be invoked by the + * returned <code>Dispatch</code> object. + * @param type The class of object used to messages or message + * payloads. Implementations are required to support + * javax.xml.transform.Source and javax.xml.soap.SOAPMessage. + * @param mode Controls whether the created dispatch instance is message + * or payload oriented, i.e. whether the user will work with complete + * protocol messages or message payloads. E.g. when using the SOAP + * protocol, this parameter controls whether the user will work with + * SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE + * when type is SOAPMessage. + * @param features An array of WebServiceFeatures to configure on the + * proxy. Supported features not in the <code>features + * </code> 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>wsaw:ServiceName</code> element + * or the <code>wsaw:EndpointName</code> attribute + * is missing in the metdata of the + * <code>endpointReference</code>. + * <li>If the <code>wsaw:ServiceName</code> does not + * match the <code>serviceName</code> of this instance. + * <li>If the <code>wsaw:EndpointName</code> does not + * match a valid wsdl:Port in the WSDL metadata. + * <li>If any error in the creation of + * the <code>Dispatch</code> 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 JAX-WS 2.1 + **/ + public abstract <T> Dispatch<T> createDispatch(EndpointReference endpointReference, + Class<T> type, Service.Mode mode, + WebServiceFeature... features); - /** - * Creates a Dispatch instance for use with objects of the users choosing. - * @param type The class of object used to messages or message payloads. - * Implementations are required to support javax.xml.transform.Source and javax.xml.soap.SOAPMessage. - */ - public abstract <T> Dispatch<T> createDispatch(QName portName, Class<T> type, Service.Mode mode); - /** - * Creates a Dispatch instance for use with JAXB generated objects. - */ - public abstract Dispatch<Object> createDispatch(QName portName, JAXBContext jaxbcontext, Service.Mode mode); + + /** + * Creates a <code>Dispatch</code> 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 user will work with complete + * protocol messages or message payloads. E.g. when using the SOAP + * protocol, this parameter controls whether the user will work with + * SOAP messages or the contents of a SOAP body. + * + * @return Dispatch instance + * @throws ServiceException If any error in the creation of + * the <code>Dispatch</code> object + * + * @see javax.xml.bind.JAXBContext + **/ + public abstract Dispatch<Object> createDispatch(QName portName, + JAXBContext context, Service.Mode mode); + - public abstract QName getServiceName(); - - public abstract Iterator getPorts(); - - public abstract URL getWSDLDocumentLocation(); - - public abstract HandlerResolver getHandlerResolver(); - - public abstract void setHandlerResolver(HandlerResolver handlerResolver); - - public abstract Executor getExecutor(); - - public abstract void setExecutor(Executor executor); -} \ No newline at end of file + /** + * Creates a <code>Dispatch</code> 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 user will work with complete + * protocol messages or message payloads. E.g. when using the SOAP + * protocol, this parameter controls whether the user will work with + * SOAP messages or the contents of a SOAP body. + * @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. + * + * @return Dispatch instance + * @throws WebServiceException If any error in the creation of + * the <code>Dispatch</code> 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 JAX-WS 2.1 + **/ + public abstract Dispatch<Object> createDispatch(QName portName, + JAXBContext context, Service.Mode mode, WebServiceFeature... features); + + /** + * Creates a <code>Dispatch</code> instance for use with JAXB + * generated objects. If there + * are any reference parameters in the + * <code>endpointReference</code>, 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 + * 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 WSDL Metadata from the <code>endpointReference</code>. + * If this <code>Service</code> instance has a WSDL and + * the <code>endpointReference</code> + * also has a WSDL, then the WSDL from this instance will 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> will be used. + * <p> + * This method behavies the same as calling + * <pre> + * dispatch = service.createDispatch(portName, context, mode, features); + * </pre> + * where the <code>portName</code> is retrieved from the + * <code>wsaw:EndpointName</code> attribute of the <code>wsaw:ServiceName</code> + * element in the + * metadata of the <code>endpointReference</code>. + * <br> + * See <a href="http://www.w3.org/TR/2006/CR-ws-addr-wsdl-20060529/">W... - WSDL 1.0 + * </a>. + * + * @param endpointReference The <code>EndpointReference</code> + * for the target service endpoint that will be invoked by the + * returned <code>Dispatch</code> 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 user will work with complete + * protocol messages or message payloads. E.g. when using the SOAP + * protocol, this parameter controls whether the user will work with + * SOAP messages or the contents of a SOAP body. + * @param features An array of WebServiceFeatures to configure on the + * proxy. Supported features not in the <code>features + * </code> parameter will have their default values. + * + * @return Dispatch instance + * @throws WebServiceException + * @throws WebServiceException + * <UL> + * <li>If there is any missing WSDL metadata + * as required by this method. + * <li>If the <code>wsaw:ServiceName</code> element + * or the <code>wsaw:EndpointName</code> attribute + * is missing in the metdata of the + * <code>endpointReference</code>. + * <li>If the <code>wsaw:ServiceName</code> does not + * match the <code>serviceName</code> of this instance. + * <li>If the <code>wsaw:EndpointName</code> does not + * match a valid wsdl:Port in the WSDL metadata. + * <li>If any error in the creation of + * the <code>Dispatch</code> 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 JAX-WS 2.1 + **/ + public abstract Dispatch<Object> createDispatch(EndpointReference endpointReference, + JAXBContext context, Service.Mode mode, + WebServiceFeature... features); + + + /** + * Gets the name of this service. + * @return Qualified name of this service + **/ + public abstract QName getServiceName(); + + /** + * Returns an <code>Iterator</code> for the list of + * <code>QName</code>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> + * @throws WebServiceException If this Service class does not + * have access to the required WSDL metadata + **/ + public abstract Iterator<javax.xml.namespace.QName> getPorts(); + + /** + * Gets the location of the WSDL document for this Service. + * + * @return URL for the location of the WSDL document for + * this service + **/ + public abstract java.net.URL getWSDLDocumentLocation(); + + /** + * Returns the configured handler resolver. + * + * @return HandlerResolver The <code>HandlerResolver</code> being + * used by this <code>Service</code> instance, or <code>null</code> + * if there isn't one. + **/ + public abstract HandlerResolver getHandlerResolver(); + + /** + * Sets the <code>HandlerResolver</code> for this <code>Service</code> + * 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 + * for all subsequently created proxy/dispatch objects. + * + * @see javax.xml.ws.handler.HandlerResolver + **/ + public abstract void setHandlerResolver(HandlerResolver handlerResolver); + + /** + * Returns the executor for this <code>Service</code>instance. + * + * The executor is used for all asynchronous invocations that + * require callbacks. + * + * @return The <code>java.util.concurrent.Executor</code> to be + * used to invoke a callback. + * + * @see java.util.concurrent.Executor + **/ + public abstract java.util.concurrent.Executor getExecutor(); + + /** + * Sets the executor for this <code>Service</code> instance. + * + * The executor is used for all asynchronous invocations that + * require callbacks. + * + * @param executor The <code>java.util.concurrent.Executor</code> + * 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 abstract void setExecutor(java.util.concurrent.Executor executor); + +} Added: trunk/src/main/java/javax/xml/ws/spi/WebServiceFeatureAnnotation.java =================================================================== --- trunk/src/main/java/javax/xml/ws/spi/WebServiceFeatureAnnotation.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/spi/WebServiceFeatureAnnotation.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -0,0 +1,70 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package javax.xml.ws.spi; + +// $Id$ + +import java.lang.annotation.Documented; +import java.lang.annotation.Target; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import javax.xml.ws.WebServiceFeature; + +/** + * Annotation used to identify other annotations + * as a <code>WebServiceFeature</code>. + * + * Each <code>WebServiceFeature</code> annotation annotated with + * this annotation MUST contain an + * <code>enabled</code> property of type + * <code>boolean</code> with a default value of <code>true</code>. + * JAX-WS defines the following + * <code>WebServiceFeature</code> annotations, however, an implementation + * may define vendors specific annotations for other features. + * If a JAX-WS implementation encounters an annotation annotated + * with the <code>WebServiceFeatureAnnotation</code> that is does not + * recognize/support an error MUST be given. + * + * @see javax.xml.ws.soap.WSAddressing + * @see javax.xml.ws.soap.MTOM + * @see javax.xml.ws.RespectBinding + * + * @since JAX-WS 2.1 + */ +(a)Target(ElementType.ANNOTATION_TYPE) +(a)Retention(RetentionPolicy.RUNTIME) +@Documented +public @interface WebServiceFeatureAnnotation { + /** + * Unique identifier for the WebServiceFeature. This + * identifier MUST be unique across all implementations + * of JAX-WS. + */ + String id(); + + /** + * The <code>WebServiceFeature</code> bean that is associated + * with the <code>WebServiceFeature</code> annotation + */ + Class<? extends WebServiceFeature> bean(); +} Property changes on: trunk/src/main/java/javax/xml/ws/spi/WebServiceFeatureAnnotation.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Added: trunk/src/main/java/javax/xml/ws/wsaddressing/W3CEndpointReference.java =================================================================== --- trunk/src/main/java/javax/xml/ws/wsaddressing/W3CEndpointReference.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/wsaddressing/W3CEndpointReference.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -0,0 +1,152 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package javax.xml.ws.wsaddressing; + +// $Id$ + +import org.w3c.dom.Element; + +import javax.xml.bind.JAXBContext; +import javax.xml.bind.JAXBException; +import javax.xml.bind.Marshaller; +import javax.xml.bind.annotation.XmlAnyAttribute; +import javax.xml.bind.annotation.XmlAnyElement; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; +import javax.xml.bind.annotation.XmlValue; +import javax.xml.namespace.QName; +import javax.xml.transform.Result; +import javax.xml.transform.Source; +import javax.xml.ws.EndpointReference; +import javax.xml.ws.WebServiceException; +import java.util.List; +import java.util.Map; + + +/** + * This class represents a W3C Addressing EndpointReferece which is + * a remote reference to a web service endpoint that supports the + * W3C WS-Addressing 1.0 - Core Recommendation. + * <p> + * Developers should use this class in their SEIs if they want to + * pass/return endpoint references that represent the W3C WS-Addressing + * recommendation. + * <p> + * JAXB will use the JAXB annotations and bind this class to XML infoset + * that is consistent with that defined by WS-Addressing. See + * <a href="http://www.w3.org/TR/2006/REC-ws-addr-core-20060509/"> + * WS-Addressing</a> + * for more information on WS-Addressing EndpointReferences. + * + * @since JAX-WS 2.1 + */ + +// XmlRootElement allows this class to be marshalled on its own +@XmlRootElement(name="EndpointReference",namespace=W3CEndpointReference.NS) +@XmlType(name="EndpointReferenceType",namespace=W3CEndpointReference.NS) +public final class W3CEndpointReference extends EndpointReference { + + private final static JAXBContext w3cjc = getW3CJaxbContext(); + + protected W3CEndpointReference() { + } + + /** + * construct an EPR from infoset representation + * + * @param source A source object containing valid XmlInfoset + * instance consistent with the W3C WS-Addressing Core + * recommendation. + * + * @throws WebServiceException + * If the source does NOT contain a valid W3C WS-Addressing + * EndpointReference. + * @throws NullPointerException + * If the <code>null</code> <code>source</code> value is given + */ + public W3CEndpointReference(Source source) { + try { + W3CEndpointReference epr = w3cjc.createUnmarshaller().unmarshal(source,W3CEndpointReference.class).getValue(); + this.address = epr.address; + this.metadata = epr.metadata; + this.referenceParameters = epr.referenceParameters; + } catch (JAXBException e) { + throw new WebServiceException("Error unmarshalling W3CEndpointReference " ,e); + } catch (ClassCastException e) { + throw new WebServiceException("Source did not contain W3CEndpointReference", e); + } + } + + /** + * {@inheritDoc} + */ + public void writeTo(Result result){ + try { + Marshaller marshaller = w3cjc.createMarshaller(); + marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true); + marshaller.marshal(this, result); + } catch (JAXBException e) { + throw new WebServiceException("Error marshalling W3CEndpointReference. ", e); + } + } + + private static JAXBContext getW3CJaxbContext() { + try { + return JAXBContext.newInstance(W3CEndpointReference.class); + } catch (JAXBException e) { + throw new WebServiceException("Error creating JAXBContext for W3CEndpointReference. ", e); + } + } + + // private but necessary properties for databinding + @XmlElement(name="Address",namespace=NS) + private Address address; + @XmlElement(name="ReferenceParameters",namespace=NS) + private Elements referenceParameters; + @XmlElement(name="Metadata",namespace=NS) + private Elements metadata; + @XmlAnyAttribute + Map<QName,String> attributes; + @XmlAnyElement + List<Element> elements; + + + private static class Address { + protected Address() {} + @XmlValue + String uri; + @XmlAnyAttribute + Map<QName,String> attributes; + } + + + private static class Elements { + protected Elements() {} + @XmlAnyElement + List<Element> elements; + @XmlAnyAttribute + Map<QName,String> attributes; + } + + protected static final String NS = "http://www.w3.org/2005/08/addressing"; +} Property changes on: trunk/src/main/java/javax/xml/ws/wsaddressing/W3CEndpointReference.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Added: trunk/src/main/java/javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.java =================================================================== --- trunk/src/main/java/javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -0,0 +1,261 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package javax.xml.ws.wsaddressing; + +// $Id$ + + +import org.w3c.dom.Element; + +import java.util.ArrayList; +import java.util.List; +import javax.xml.namespace.QName; +import javax.xml.ws.WebServiceException; +import javax.xml.ws.spi.Provider; + + +/** + * This class is used to build <code>W3CEndpointReference</code> + * instances. The intended use of this clsss is for + * an application component, for example a factory component, + * to create an <code>W3CEndpointReference</code> for a + * web service endpoint published by the same + * Java EE application. It can also be used to create + * <code>W3CEndpointReferences</code> for an Java SE based + * endpoint by providing the <code>address</code> property. + * <p> + * When creating a <code>W3CEndpointReference</code> for an + * endpoint that is not published by the same Java EE application, + * the <code>address</code> property MUST be specified. + * <p> + * When creating a <code>W3CEndpointReference</code> for an endpoint + * published by the same Java EE application, the <code>address</code> + * property MAY be <code>null</code> but then the <code>serviceName</code> + * and <code>endpointName</code> MUST specify an endpoint published by + * the same Java EE application. + * <p> + * When the <code>wsdlDocumentLocation</code> is specified it MUST refer + * to a valid WSDL document and the <code>serviceName</code> and + * <code>endpointName</code> (if specified) MUST match a service and port + * in the WSDL document. + * + * @since JAX-WS 2.1 + */ +public final class W3CEndpointReferenceBuilder { + + public W3CEndpointReferenceBuilder() { + referenceParameters = new ArrayList<Element>(); + metadata = new ArrayList<Element>(); + } + + /** + * Sets the <code>address</code> to the + * <code>W3CEndpointReference</code> instance's + * <code>wsa:Address</code>. + * <p> + * The <code>address</code> MUST be set to a non-<code>null</code> + * value when building a <code>W3CEndpointReference</code> for a + * web service endpoint that is not published by the same + * Java EE application or when running on Java SE. + * + * @param address The address of the endpoint to be targeted + * by the returned <code>W3CEndpointReference<code>. + * + * @return A <code>W3CEndpointReferenceBuilder</code> instance with + * the <code>address</code> set to the <code>wsa:Address</code>. + */ + public W3CEndpointReferenceBuilder address(String adddress) { + this.address = address; + return this; + } + + /** + * Sets the <code>serviceName</code> as the + * <code>wsaw:ServiceName</code> element in the + * <code>wsa:Metadata</code> element. + * + * @param serviceName The service name of the endpoint to be targeted + * by the returned <code>W3CEndpointReference<code>. This property + * may also be used with the <code>endpointName</code> (portName) + * property to lookup the <code>address</code> of a web service + * endpoint that is published by the same Java EE application. + * + * @return A <code>W3CEndpointReferenceBuilder</code> instance with + * the <code>serviceName</code> element added to the + * <code>wsa:Metadata</code> element. + * + */ + public W3CEndpointReferenceBuilder serviceName(QName serviceName) { + this.serviceName = serviceName; + return this; + } + + /** + * Sets the <code>endpointName</code> as and attribute on + * <code>wsaw:ServiceName</code> element in the + * <code>wsa:Metadata</code> element. This method can only + * be called after the {@link #serviceName} method has been called. + * + * @param endpointName The name of the endpoint to be targeted + * by the returned <code>W3CEndpointReference<code>. The + * <code>endpointName</code> (portName) property may also be + * used with the <code>serviceName</code> property to lookup + * the <code>address</code> of a web service + * endpoint published by the same Java EE application. + * + * @return A <code>W3CEndpointReferenceBuilder</code> instance with + * the <code>endpointName</code> atrribute added to the + * <code>wsaw:ServiceName</code> element in the + * <code>wsa:Metadata</code> element. + * + * @throws javax.lang.IllegalStateException If the <code>serviceName</code> has not + * been set. + */ + public W3CEndpointReferenceBuilder endpointName(QName endpointName) { + if (serviceName == null) { + throw new IllegalStateException("The W3CEndpointReferenceBuilder's serviceName must be set before setting the endpointName: "+endpointName); + } + + this.endpointName = endpointName; + return this; + } + + /** + * Sets the <code>wsdlDocumentLocation</code> that will be inlined + * in the <code>W3CEndpointReferenc</code> instance's + * <code>wsa:Metadata</code>. + * + * @param wsdlDocumentLocation The location of the WSDL document to + * be inlined in the <code>wsa:Metadata</code> of the + * <code>W3CEndpointReference<code>. + * + * @return A <code>W3CEndpointReferenceBuilder</code> instance with + * the <code>wsdlDocumentLocation</code> that is to be inlined. + * + */ + public W3CEndpointReferenceBuilder wsdlDocumentLocation(String wsdlDocumentLocation) { + this.wsdlDocumentLocation = wsdlDocumentLocation; + return this; + } + + /** + * Adds the <code>referenceParameter</code> to the + * <code>W3CEndpointReference</code> instance + * <code>wsa:ReferenceParameters</code> element. + * + * @param referenceParameter The element to be added to the + * <code>wsa:ReferenceParameters</code> element. + * + * @return A <code>W3CEndpointReferenceBuilder</code> instance with + * the <code>referenceParameter</code> added to the + * <code>wsa:ReferenceParameters</code> element. + * + * @throws java.lang.IllegalArgumentException if <code>referenceParameter</code> + * is <code>null</code>. + */ + public W3CEndpointReferenceBuilder referenceParameter(Element referenceParameter) { + if (referenceParameter == null) + throw new java.lang.IllegalArgumentException("The referenceParameter cannot be null."); + referenceParameters.add(referenceParameter); + return this; + } + + /** + * Adds the <code>metadataElement</code> to the + * <code>W3CEndpointReference</code> instance's + * <code>wsa:Metadata</code> element. + * + * @param metadataElement The element to be added to the + * <code>wsa:Metadata</code> element. + * + * @return A <code>W3CEndpointReferenceBuilder</code> instance with + * the <code>metadataElement</code> added to the + * <code>wsa:Metadata</code> element. + * + * @throws java.lang.IllegalArgumentException if <code>metadataElement</code> + * is <code>null</code>. + */ + public W3CEndpointReferenceBuilder metadata(Element metadataElement) { + if (metadataElement == null) + throw new java.lang.IllegalArgumentException("The metadataElement cannot be null."); + metadata.add(metadataElement); + return this; + } + + /** + * Builds a <code>W3CEndpointReference</code> from the accumulated + * properties set on this <code>W3CEndpointReferenceBuilder</code> + * instance. + * <p> + * This method can be used to create a <code>W3CEndpointReference</code> + * for any endpoint by specifying the <code>address</code> property along + * with any other desired properties. This method + * can also be used to create a <code>W3CEndpointReference</code> for + * an endpoint that is published by the same Java EE application. + * This method can automatically determine the <code>address</code> of + * an endpoint published by the same Java EE application that is identified by the + * <code>serviceName</code> and + * <code>endpointName</code> properties. If the <code>address</code> is + * <code>null</code> and the <code>serviceName</code> and + * <code>endpointName</code> + * do not identify an endpoint published by the same Java EE application, a + * <code>javax.lang.IllegalStateException</code> MUST be thrown. + * + * + * @return <code>W3CEndpointReference</code> from the accumulated + * properties set on this <code>W3CEndpointReferenceBuilder</code> + * instance. This method never returns <code>null</code>. + * + * @throws javax.lang.IllegalStateException + * <ul> + * <li>If the <code>address</code>, <code>serviceName</code> and + * <code>endpointName</code> are all <code>null</code>. + * <li>If the <code>serviceName</code> service is <code>null</code> and the + * <code>endpointName</code> is NOT <code>null</code>. + * <li>If the <code>address</code> property is <code>null</code> and + * the <code>serviceName</code> and <code>endpointName</code> do not + * specify a valid endpoint published by the same Java EE + * application. + * <li>If the <code>serviceName</code>is NOT <code>null</code> + * and is not present in the specified WSDL. + * <li>If the <code>endpointName</code> port is not <code>null<code> and it + * is not present in <code>serviceName</code> service in the WSDL. + * <li>If the <code>wsdlDocumentLocation</code> is NOT <code>null</code> + * and does not represent a valid WSDL. + * </ul> + * @throws WebServiceException If an error occurs while creating the + * <code>W3CEndpointReference</code>. + * + */ + public W3CEndpointReference build() { + return Provider.provider().createW3CEndpointReference(address, + serviceName, endpointName, metadata, wsdlDocumentLocation, + referenceParameters); + } + + private String address; + private List<Element> referenceParameters; + private List<Element> metadata; + private QName serviceName; + private QName endpointName; + private String wsdlDocumentLocation; +} Property changes on: trunk/src/main/java/javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Modified: trunk/src/main/java/org/jboss/ws/core/jaxws/WebServiceContextImpl.java =================================================================== --- trunk/src/main/java/org/jboss/ws/core/jaxws/WebServiceContextImpl.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/org/jboss/ws/core/jaxws/WebServiceContextImpl.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -23,10 +23,12 @@ import java.security.Principal; +import javax.xml.ws.EndpointReference; import javax.xml.ws.WebServiceContext; import javax.xml.ws.handler.MessageContext; import org.jboss.util.NotImplementedException; +import org.w3c.dom.Element; /** * A WebServiceContext makes it possible for a web service endpoint implementation @@ -61,4 +63,14 @@ { throw new NotImplementedException(); } + + public EndpointReference getEndpointReference(Element... referenceParameters) + { + throw new NotImplementedException(); + } + + public <T extends EndpointReference> T getEndpointReference(Class<T> clazz, Element... referenceParameters) + { + throw new NotImplementedException(); + } } \ No newline at end of file Modified: trunk/src/main/java/org/jboss/ws/core/jaxws/binding/BindingImpl.java =================================================================== --- trunk/src/main/java/org/jboss/ws/core/jaxws/binding/BindingImpl.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/org/jboss/ws/core/jaxws/binding/BindingImpl.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -30,6 +30,7 @@ import javax.xml.ws.handler.Handler; import org.jboss.logging.Logger; +import org.jboss.util.NotImplementedException; import org.jboss.ws.metadata.umdm.HandlerMetaData.HandlerType; /** @@ -74,4 +75,9 @@ log.debug("setHandlerChain: " + handlerChain); this.jaxwsHandlerChain = handlerChain; } + + public String getBindingID() + { + throw new NotImplementedException(); + } } Modified: trunk/src/main/java/org/jboss/ws/core/jaxws/binding/BindingProviderImpl.java =================================================================== --- trunk/src/main/java/org/jboss/ws/core/jaxws/binding/BindingProviderImpl.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/org/jboss/ws/core/jaxws/binding/BindingProviderImpl.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -28,11 +28,13 @@ import javax.xml.ws.Binding; import javax.xml.ws.BindingProvider; +import javax.xml.ws.EndpointReference; import javax.xml.ws.WebServiceException; import javax.xml.ws.Service.Mode; import javax.xml.ws.http.HTTPBinding; import javax.xml.ws.soap.SOAPBinding; +import org.jboss.util.NotImplementedException; import org.jboss.ws.core.CommonBindingProvider; import org.jboss.ws.metadata.umdm.EndpointMetaData; import org.jboss.ws.metadata.umdm.EndpointMetaData.Type; @@ -110,4 +112,14 @@ { return (Binding)binding; } + + public EndpointReference getEndpointReference() + { + throw new NotImplementedException(); + } + + public <T extends EndpointReference> T getEndpointReference(Class<T> clazz) + { + throw new NotImplementedException(); + } } Modified: trunk/src/main/java/org/jboss/ws/core/jaxws/binding/HTTPBindingJAXWS.java =================================================================== --- trunk/src/main/java/org/jboss/ws/core/jaxws/binding/HTTPBindingJAXWS.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/org/jboss/ws/core/jaxws/binding/HTTPBindingJAXWS.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -82,4 +82,9 @@ { delegate.setHandlerChain(handlerChain); } + + public String getBindingID() + { + throw new NotImplementedException(); + } } Modified: trunk/src/main/java/org/jboss/ws/core/jaxws/binding/MessageBinding.java =================================================================== --- trunk/src/main/java/org/jboss/ws/core/jaxws/binding/MessageBinding.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/org/jboss/ws/core/jaxws/binding/MessageBinding.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -146,4 +146,8 @@ throw new BindingException(ex); } + public String getBindingID() + { + throw new NotImplementedException(); + } } Modified: trunk/src/main/java/org/jboss/ws/core/jaxws/binding/PayloadBinding.java =================================================================== --- trunk/src/main/java/org/jboss/ws/core/jaxws/binding/PayloadBinding.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/org/jboss/ws/core/jaxws/binding/PayloadBinding.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -160,4 +160,9 @@ throw new BindingException(ex); } + + public String getBindingID() + { + throw new NotImplementedException(); + } } Modified: trunk/src/main/java/org/jboss/ws/core/jaxws/binding/SOAP11BindingJAXWS.java =================================================================== --- trunk/src/main/java/org/jboss/ws/core/jaxws/binding/SOAP11BindingJAXWS.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/org/jboss/ws/core/jaxws/binding/SOAP11BindingJAXWS.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -23,7 +23,6 @@ // $Id: SOAPBindingImpl.java 716 2006-08-09 16:42:10Z thomas.diesler(a)jboss.com $ -import java.net.URI; import java.util.HashSet; import java.util.List; import java.util.Set; @@ -32,6 +31,7 @@ import javax.xml.ws.handler.Handler; import javax.xml.ws.soap.SOAPBinding; +import org.jboss.util.NotImplementedException; import org.jboss.ws.Constants; import org.jboss.ws.core.CommonSOAP11Binding; import org.jboss.ws.core.jaxws.SOAPFaultHelperJAXWS; @@ -66,17 +66,17 @@ delegate.setSOAPActionHeader(opMetaData, reqMessage); } - public Set<URI> getRoles() + public Set<String> getRoles() { // 10.3 Conformance (Default role visibility): An implementation MUST include the required next and ultimate // receiver roles in the Set returned from SOAPBinding.getRoles. // In SOAP 1.1 the ultimate receiver role is identified by omission of the actor attribute from a SOAP header. - Set<URI> soap11Roles = new HashSet<URI>(delegate.getRoles()); - soap11Roles.add(URI.create(Constants.URI_SOAP11_NEXT_ACTOR)); + Set<String> soap11Roles = new HashSet<String>(delegate.getRoles()); + soap11Roles.add(Constants.URI_SOAP11_NEXT_ACTOR); return soap11Roles; } - public void setRoles(Set<URI> roles) + public void setRoles(Set<String> roles) { delegate.setRoles(roles); } @@ -107,4 +107,9 @@ { return SOAPFaultHelperJAXWS.exceptionToFaultMessage(ex); } + + public String getBindingID() + { + throw new NotImplementedException(); + } } Modified: trunk/src/main/java/org/jboss/ws/core/jaxws/binding/SOAP12BindingJAXWS.java =================================================================== --- trunk/src/main/java/org/jboss/ws/core/jaxws/binding/SOAP12BindingJAXWS.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/org/jboss/ws/core/jaxws/binding/SOAP12BindingJAXWS.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -23,7 +23,6 @@ // $Id: SOAPBindingImpl.java 716 2006-08-09 16:42:10Z thomas.diesler(a)jboss.com $ -import java.net.URI; import java.util.HashSet; import java.util.List; import java.util.Set; @@ -33,6 +32,7 @@ import javax.xml.ws.handler.Handler; import javax.xml.ws.soap.SOAPBinding; +import org.jboss.util.NotImplementedException; import org.jboss.ws.Constants; import org.jboss.ws.core.CommonSOAP12Binding; import org.jboss.ws.core.jaxws.SOAPFaultHelperJAXWS; @@ -66,21 +66,21 @@ delegate.setSOAPActionHeader(opMetaData, reqMessage); } - public Set<URI> getRoles() + public Set<String> getRoles() { // 10.3 Conformance (Default role visibility): An implementation MUST include the required next and ultimate // receiver roles in the Set returned from SOAPBinding.getRoles. - Set<URI> soap12Roles = new HashSet<URI>(delegate.getRoles()); - soap12Roles.add(URI.create(Constants.URI_SOAP12_ROLE_NEXT)); - soap12Roles.add(URI.create(Constants.URI_SOAP12_ROLE_ULTIMATE_RECEIVER)); + Set<String> soap12Roles = new HashSet<String>(delegate.getRoles()); + soap12Roles.add(Constants.URI_SOAP12_ROLE_NEXT); + soap12Roles.add(Constants.URI_SOAP12_ROLE_ULTIMATE_RECEIVER); return soap12Roles; } - public void setRoles(Set<URI> roles) + public void setRoles(Set<String> roles) { // 10.5 Conformance (None role error): An implementation MUST throw WebServiceException if a client // attempts to configure the binding to play the none role via SOAPBinding.setRoles. - for (URI role : roles) + for (String role : roles) { if (role.equals(Constants.URI_SOAP12_ROLE_NONE)) throw new WebServiceException("Attempt to configure the binding to play the none role"); @@ -114,4 +114,9 @@ { return SOAPFaultHelperJAXWS.exceptionToFaultMessage(ex); } + + public String getBindingID() + { + throw new NotImplementedException(); + } } Modified: trunk/src/main/java/org/jboss/ws/core/jaxws/binding/SOAPBindingJAXWS.java =================================================================== --- trunk/src/main/java/org/jboss/ws/core/jaxws/binding/SOAPBindingJAXWS.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/org/jboss/ws/core/jaxws/binding/SOAPBindingJAXWS.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -23,7 +23,6 @@ // $Id$ -import java.net.URI; import java.util.HashSet; import java.util.Set; @@ -42,23 +41,23 @@ * @author Thomas.Diesler(a)jboss.com * @since 04-Jul-2006 */ -class SOAPBindingJAXWS extends BindingImpl +class SOAPBindingJAXWS extends BindingImpl { // provide logging private static Logger log = Logger.getLogger(SOAPBindingJAXWS.class); - - private Set<URI> roles = new HashSet<URI>(); - - public Set<URI> getRoles() + + private Set<String> roles = new HashSet<String>(); + + public Set<String> getRoles() { return roles; } - public void setRoles(Set<URI> roles) + public void setRoles(Set<String> roles) { this.roles = roles; } - + public void setSOAPActionHeader(OperationMetaData opMetaData, SOAPMessage reqMessage) { CommonMessageContext msgContext = MessageContextAssociation.peekMessageContext(); Modified: trunk/src/main/java/org/jboss/ws/core/jaxws/client/ClientImpl.java =================================================================== --- trunk/src/main/java/org/jboss/ws/core/jaxws/client/ClientImpl.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/org/jboss/ws/core/jaxws/client/ClientImpl.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -30,6 +30,7 @@ import javax.xml.namespace.QName; import javax.xml.ws.Binding; import javax.xml.ws.BindingProvider; +import javax.xml.ws.EndpointReference; import javax.xml.ws.WebServiceException; import javax.xml.ws.handler.Handler; import javax.xml.ws.handler.HandlerResolver; @@ -40,6 +41,7 @@ import javax.xml.ws.soap.SOAPFaultException; import org.jboss.logging.Logger; +import org.jboss.util.NotImplementedException; import org.jboss.ws.core.CommonBindingProvider; import org.jboss.ws.core.CommonClient; import org.jboss.ws.core.CommonMessageContext; @@ -247,4 +249,14 @@ { return (BindingProvider)getCommonBindingProvider(); } + + public EndpointReference getEndpointReference() + { + throw new NotImplementedException(); + } + + public <T extends EndpointReference> T getEndpointReference(Class<T> clazz) + { + throw new NotImplementedException(); + } } Modified: trunk/src/main/java/org/jboss/ws/core/jaxws/client/DispatchImpl.java =================================================================== --- trunk/src/main/java/org/jboss/ws/core/jaxws/client/DispatchImpl.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/org/jboss/ws/core/jaxws/client/DispatchImpl.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -46,11 +46,13 @@ import javax.xml.ws.Binding; import javax.xml.ws.BindingProvider; import javax.xml.ws.Dispatch; +import javax.xml.ws.EndpointReference; import javax.xml.ws.Response; import javax.xml.ws.WebServiceException; import javax.xml.ws.Service.Mode; import org.jboss.logging.Logger; +import org.jboss.util.NotImplementedException; import org.jboss.ws.core.jaxws.binding.BindingProviderImpl; import org.jboss.ws.core.soap.SOAPBodyImpl; import org.jboss.ws.core.soap.SOAPConnectionImpl; @@ -120,10 +122,10 @@ return retObj; } - public Response invokeAsync(Object obj) + public Response<T> invokeAsync(T msg) { ResponseImpl response = new ResponseImpl(); - Runnable task = new AsyncRunnable(response, null, obj); + Runnable task = new AsyncRunnable(response, null, msg); Future future = executor.submit(task); response.setFuture(future); return response; @@ -138,9 +140,9 @@ return response; } - public void invokeOneWay(Object obj) + public void invokeOneWay(T msg) { - SOAPMessage reqMsg = getRequestMessage(obj); + SOAPMessage reqMsg = getRequestMessage(msg); try { String targetAddress = epMetaData.getEndpointAddress(); @@ -358,4 +360,14 @@ response.setException(wsex); } } + + public EndpointReference getEndpointReference() + { + throw new NotImplementedException(); + } + + public <T extends EndpointReference> T getEndpointReference(Class<T> clazz) + { + throw new NotImplementedException(); + } } Modified: trunk/src/main/java/org/jboss/ws/core/jaxws/handler/SOAPMessageContextJAXWS.java =================================================================== --- trunk/src/main/java/org/jboss/ws/core/jaxws/handler/SOAPMessageContextJAXWS.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/org/jboss/ws/core/jaxws/handler/SOAPMessageContextJAXWS.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -49,7 +49,7 @@ public class SOAPMessageContextJAXWS extends MessageContextJAXWS implements SOAPMessageContext { // The SOAP actor roles - private Set<URI> roles = new HashSet<URI>(); + private Set<String> roles = new HashSet<String>(); /** Default ctor */ public SOAPMessageContextJAXWS() @@ -126,7 +126,7 @@ * Handler instances in the handler chain use this information about the SOAP actor roles to process the SOAP header blocks. * Note that the SOAP actor roles are invariant during the processing of SOAP message through the handler chain. */ - public Set<URI> getRoles() + public Set<String> getRoles() { return roles; } Modified: trunk/src/main/java/org/jboss/ws/core/jaxws/spi/EndpointImpl.java =================================================================== --- trunk/src/main/java/org/jboss/ws/core/jaxws/spi/EndpointImpl.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/org/jboss/ws/core/jaxws/spi/EndpointImpl.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -35,6 +35,7 @@ import javax.xml.ws.Binding; import javax.xml.ws.BindingProvider; import javax.xml.ws.Endpoint; +import javax.xml.ws.EndpointReference; import javax.xml.ws.WebServiceException; import javax.xml.ws.WebServicePermission; @@ -43,6 +44,7 @@ import org.jboss.ws.core.jaxws.binding.BindingProviderImpl; import org.jboss.ws.core.server.HttpContext; import org.jboss.ws.core.server.HttpServer; +import org.w3c.dom.Element; /** * A Web service endpoint implementation. @@ -226,4 +228,16 @@ sm.checkPermission(ENDPOINT_PUBLISH_PERMISSION); } } + + @Override + public EndpointReference getEndpointReference(Element... referenceParameters) + { + throw new NotImplementedException(); + } + + @Override + public <T extends EndpointReference> T getEndpointReference(Class<T> clazz, Element... referenceParameters) + { + throw new NotImplementedException(); + } } \ No newline at end of file Modified: trunk/src/main/java/org/jboss/ws/core/jaxws/spi/ProviderImpl.java =================================================================== --- trunk/src/main/java/org/jboss/ws/core/jaxws/spi/ProviderImpl.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/org/jboss/ws/core/jaxws/spi/ProviderImpl.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -23,13 +23,23 @@ // $Id$ +import java.net.MalformedURLException; import java.net.URL; +import java.util.List; import javax.xml.namespace.QName; +import javax.xml.transform.Source; import javax.xml.ws.Endpoint; +import javax.xml.ws.EndpointReference; +import javax.xml.ws.WebServiceFeature; +import javax.xml.ws.soap.SOAPBinding; import javax.xml.ws.spi.Provider; import javax.xml.ws.spi.ServiceDelegate; +import javax.xml.ws.wsaddressing.W3CEndpointReference; +import org.jboss.util.NotImplementedException; +import org.w3c.dom.Element; + /** * Service provider for ServiceDelegate and Endpoint objects. * @@ -67,9 +77,56 @@ // method with the binding ID appropriate to the URL scheme used by the address, then invoking the // publish(String address) method on the resulting endpoint. - String bindingId = Endpoint.getBindingFromAddress(address); + String bindingId = getBindingFromAddress(address); EndpointImpl endpoint = (EndpointImpl)createEndpoint(bindingId, implementor); endpoint.publish(address); return endpoint; } + + private String getBindingFromAddress(String address) + { + String bindingId; + try + { + URL url = new URL(address); + String protocol = url.getProtocol(); + if (protocol.startsWith("http")) + { + bindingId = SOAPBinding.SOAP11HTTP_BINDING; + } + else + { + throw new IllegalArgumentException("Unsupported protocol: " + address); + } + } + catch (MalformedURLException e) + { + throw new IllegalArgumentException("Invalid endpoint address: " + address); + } + return bindingId; + } + + @Override + public <T extends EndpointReference> T createEndpointReference(Class<T> clazz, QName serviceName, QName portName, Source wsdlDocumentLocation, Element... referenceParameters) + { + throw new NotImplementedException(); + } + + @Override + public W3CEndpointReference createW3CEndpointReference(String address, QName serviceName, QName portName, List<Element> metadata, String wsdlDocumentLocation, List<Element> referenceParameters) + { + throw new NotImplementedException(); + } + + @Override + public <T> T getPort(EndpointReference endpointReference, Class<T> serviceEndpointInterface, WebServiceFeature... features) + { + throw new NotImplementedException(); + } + + @Override + public EndpointReference readEndpointReference(Source eprInfoset) + { + throw new NotImplementedException(); + } } \ No newline at end of file Modified: trunk/src/main/java/org/jboss/ws/core/jaxws/spi/ServiceDelegateImpl.java =================================================================== --- trunk/src/main/java/org/jboss/ws/core/jaxws/spi/ServiceDelegateImpl.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/main/java/org/jboss/ws/core/jaxws/spi/ServiceDelegateImpl.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -38,12 +38,15 @@ import javax.xml.namespace.QName; import javax.xml.ws.BindingProvider; import javax.xml.ws.Dispatch; +import javax.xml.ws.EndpointReference; import javax.xml.ws.WebServiceException; +import javax.xml.ws.WebServiceFeature; import javax.xml.ws.Service.Mode; import javax.xml.ws.handler.HandlerResolver; import javax.xml.ws.spi.ServiceDelegate; import org.jboss.logging.Logger; +import org.jboss.util.NotImplementedException; import org.jboss.ws.Constants; import org.jboss.ws.core.jaxws.client.ClientImpl; import org.jboss.ws.core.jaxws.client.ClientProxy; @@ -332,4 +335,46 @@ return qname; } } + + @Override + public <T> Dispatch<T> createDispatch(QName portName, Class<T> type, Mode mode, WebServiceFeature... features) + { + throw new NotImplementedException(); + } + + @Override + public <T> Dispatch<T> createDispatch(EndpointReference endpointReference, Class<T> type, Mode mode, WebServiceFeature... features) + { + throw new NotImplementedException(); + } + + @Override + public Dispatch<Object> createDispatch(QName portName, JAXBContext context, Mode mode, WebServiceFeature... features) + { + throw new NotImplementedException(); + } + + @Override + public Dispatch<Object> createDispatch(EndpointReference endpointReference, JAXBContext context, Mode mode, WebServiceFeature... features) + { + throw new NotImplementedException(); + } + + @Override + public <T> T getPort(QName portName, Class<T> serviceEndpointInterface, WebServiceFeature... features) + { + throw new NotImplementedException(); + } + + @Override + public <T> T getPort(EndpointReference endpointReference, Class<T> serviceEndpointInterface, WebServiceFeature... features) + { + throw new NotImplementedException(); + } + + @Override + public <T> T getPort(Class<T> serviceEndpointInterface, WebServiceFeature... features) + { + throw new NotImplementedException(); + } } Modified: trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/EJB3Bean.java =================================================================== --- trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/EJB3Bean.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/EJB3Bean.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -26,14 +26,21 @@ import javax.jws.WebService; import javax.jws.soap.SOAPBinding; +import org.jboss.logging.Logger; +import org.jboss.ws.annotation.PortComponent; + @Stateless -@WebService +@WebService(name="TestEndpoint") @SOAPBinding(style = SOAPBinding.Style.RPC) +@PortComponent(contextRoot="/earejb3") public class EJB3Bean { + private static Logger log = Logger.getLogger(EJB3Bean.class); + @WebMethod public String echo(String input) { + log.info("echo: " + input); return input; } } Modified: trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/EarEjb3TestCase.java =================================================================== --- trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/EarEjb3TestCase.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/EarEjb3TestCase.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,6 +21,10 @@ */ package org.jboss.test.ws.jaxws.eardeployment; +import java.net.URL; + +import javax.xml.namespace.QName; + import junit.framework.Test; import org.jboss.test.ws.JBossWSTest; @@ -34,7 +38,7 @@ */ public class EarEjb3TestCase extends JBossWSTest { - public final String TARGET_ENDPOINT_ADDRESS = "http://" + getServerHost() + ":8080/jaxws-eardeployment"; + public final String TARGET_ENDPOINT_ADDRESS = "http://" + getServerHost() + ":8080/earejb3/EJB3Bean"; public static Test suite() { @@ -43,8 +47,13 @@ public void testWebService() throws Exception { + URL wsdlURL = new URL (TARGET_ENDPOINT_ADDRESS + "?wsdl"); + QName serviceName = new QName("http://eardeployment.jaxws.ws.test.jboss.org/";, "TestEndpointService"); + TestEndpointService service = new TestEndpointService(wsdlURL, serviceName); + TestEndpoint port = service.getTestEndpointPort(); + String helloWorld = "Hello world!"; -// Object retObj = port.echo(helloWorld); -// assertEquals(helloWorld, retObj); + String retObj = port.echo(helloWorld); + assertEquals(helloWorld, retObj); } } Modified: trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/EarJseTestCase.java =================================================================== --- trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/EarJseTestCase.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/EarJseTestCase.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -21,6 +21,10 @@ */ package org.jboss.test.ws.jaxws.eardeployment; +import java.net.URL; + +import javax.xml.namespace.QName; + import junit.framework.Test; import org.jboss.test.ws.JBossWSTest; @@ -34,10 +38,8 @@ */ public class EarJseTestCase extends JBossWSTest { - public final String TARGET_ENDPOINT_ADDRESS = "http://" + getServerHost() + ":8080/jaxws-samples-jsr181pojo"; + public final String TARGET_ENDPOINT_ADDRESS = "http://" + getServerHost() + ":8080/jaxws-eardeployment/JSEBean"; - private static EndpointInterface port; - public static Test suite() { return JBossWSTestSetup.newTestSetup(EarJseTestCase.class, "jaxws-eardeployment.war"); @@ -45,8 +47,13 @@ public void testWebService() throws Exception { + URL wsdlURL = new URL (TARGET_ENDPOINT_ADDRESS + "?wsdl"); + QName serviceName = new QName("http://eardeployment.jaxws.ws.test.jboss.org/";, "TestEndpointService"); + TestEndpointService service = new TestEndpointService(wsdlURL, serviceName); + TestEndpoint port = service.getTestEndpointPort(); + String helloWorld = "Hello world!"; - //Object retObj = port.echo(helloWorld); - //assertEquals(helloWorld, retObj); + String retObj = port.echo(helloWorld); + assertEquals(helloWorld, retObj); } } Deleted: trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/EndpointInterface.java =================================================================== --- trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/EndpointInterface.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/EndpointInterface.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -1,30 +0,0 @@ -/* - * JBoss, Home of Professional Open Source - * Copyright 2005, JBoss Inc., and individual contributors as indicated - * by the @authors tag. See the copyright.txt in the distribution for a - * full listing of individual contributors. - * - * This is free software; you can redistribute it and/or modify it - * under the terms of the GNU Lesser General Public License as - * published by the Free Software Foundation; either version 2.1 of - * the License, or (at your option) any later version. - * - * This software is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this software; if not, write to the Free - * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - * 02110-1301 USA, or see the FSF site: http://www.fsf.org. - */ -package org.jboss.test.ws.jaxws.eardeployment; - -import java.rmi.Remote; -import java.rmi.RemoteException; - -public interface EndpointInterface extends Remote -{ - String echo(String input) throws RemoteException; -} Modified: trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/JSEBean.java =================================================================== --- trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/JSEBean.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/JSEBean.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -25,13 +25,18 @@ import javax.jws.WebService; import javax.jws.soap.SOAPBinding; -@WebService +import org.jboss.logging.Logger; + +@WebService(name="TestEndpoint") @SOAPBinding(style = SOAPBinding.Style.RPC) public class JSEBean { + private static Logger log = Logger.getLogger(JSEBean.class); + @WebMethod public String echo(String input) { + log.info("echo: " + input); return input; } } Added: trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/TestEndpoint.java =================================================================== --- trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/TestEndpoint.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/TestEndpoint.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -0,0 +1,34 @@ + +package org.jboss.test.ws.jaxws.eardeployment; + +import javax.jws.WebMethod; +import javax.jws.WebParam; +import javax.jws.WebResult; +import javax.jws.WebService; +import javax.jws.soap.SOAPBinding; + + +/** + * This class was generated by the JAXWS SI. + * JAX-WS RI 2.1-11/15/2006 04:41 PM(vivek)-EA3 + * Generated source version: 2.1 + * + */ +@WebService(name = "TestEndpoint", targetNamespace = "http://eardeployment.jaxws.ws.test.jboss.org/") +@SOAPBinding(style = SOAPBinding.Style.RPC) +public interface TestEndpoint { + + + /** + * + * @param arg0 + * @return + * returns java.lang.String + */ + @WebMethod + @WebResult(partName = "return") + public String echo( + @WebParam(name = "arg0", partName = "arg0") + String arg0); + +} Property changes on: trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/TestEndpoint.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Added: trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/TestEndpointService.java =================================================================== --- trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/TestEndpointService.java 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/TestEndpointService.java 2006-12-11 11:06:03 UTC (rev 1622) @@ -0,0 +1,66 @@ + +package org.jboss.test.ws.jaxws.eardeployment; + +import java.net.MalformedURLException; +import java.net.URL; +import javax.xml.namespace.QName; +import javax.xml.ws.Service; +import javax.xml.ws.WebEndpoint; +import javax.xml.ws.WebServiceClient; +import javax.xml.ws.WebServiceFeature; + + +/** + * This class was generated by the JAXWS SI. + * JAX-WS RI 2.1-11/15/2006 04:41 PM(vivek)-EA3 + * Generated source version: 2.1 + * + */ +@WebServiceClient(name = "TestEndpointService", targetNamespace = "http://eardeployment.jaxws.ws.test.jboss.org/", wsdlLocation = "file:/home/tdiesler/svn/jbossws/trunk/src/test/resources/jaxws/eardeployment/META-INF/wsdl/TestEndpoint.wsdl") +public class TestEndpointService + extends Service +{ + + private final static URL TESTENDPOINTSERVICE_WSDL_LOCATION; + + static { + URL url = null; + try { + url = new URL("file:/home/tdiesler/svn/jbossws/trunk/src/test/resources/jaxws/eardeployment/META-INF/wsdl/TestEndpoint.wsdl"); + } catch (MalformedURLException e) { + e.printStackTrace(); + } + TESTENDPOINTSERVICE_WSDL_LOCATION = url; + } + + public TestEndpointService(URL wsdlLocation, QName serviceName) { + super(wsdlLocation, serviceName); + } + + public TestEndpointService() { + super(TESTENDPOINTSERVICE_WSDL_LOCATION, new QName("http://eardeployment.jaxws.ws.test.jboss.org/";, "TestEndpointService")); + } + + /** + * + * @return + * returns TestEndpoint + */ + @WebEndpoint(name = "TestEndpointPort") + public TestEndpoint getTestEndpointPort() { + return (TestEndpoint)super.getPort(new QName("http://eardeployment.jaxws.ws.test.jboss.org/";, "TestEndpointPort"), TestEndpoint.class); + } + + /** + * + * @param features + * A list of {@link javax.xml.ws.WebServiceFeature} to configure on the proxy. Supported features not in the <code>features</code> parameter will have their default values. + * @return + * returns TestEndpoint + */ + @WebEndpoint(name = "TestEndpointPort") + public TestEndpoint getTestEndpointPort(WebServiceFeature... features) { + return (TestEndpoint)super.getPort(new QName("http://eardeployment.jaxws.ws.test.jboss.org/";, "TestEndpointPort"), TestEndpoint.class, features); + } + +} Property changes on: trunk/src/test/java/org/jboss/test/ws/jaxws/eardeployment/TestEndpointService.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Added: trunk/src/test/resources/jaxws/eardeployment/META-INF/wsdl/TestEndpoint.wsdl =================================================================== --- trunk/src/test/resources/jaxws/eardeployment/META-INF/wsdl/TestEndpoint.wsdl 2006-12-11 08:22:29 UTC (rev 1621) +++ trunk/src/test/resources/jaxws/eardeployment/META-INF/wsdl/TestEndpoint.wsdl 2006-12-11 11:06:03 UTC (rev 1622) @@ -0,0 +1,40 @@ +<!-- + This wsdl is used for client artifact generation + + wsimport -keep -verbose -d ../../../java ./META-INF/wsdl/TestEndpoint.wsdl + + $Id$ +--> +<definitions name="TestEndpointService" targetNamespace="http://eardeployment.jaxws.ws.test.jboss.org/" xmlns="http://schemas.xmlsoap.org/wsdl/" + xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://eardeployment.jaxws.ws.test.jboss.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> + <types/> + <message name="TestEndpoint_echoResponse"> + <part name="return" type="xsd:string"/> + </message> + <message name="TestEndpoint_echo"> + <part name="arg0" type="xsd:string"/> + </message> + <portType name="TestEndpoint"> + <operation name="echo" parameterOrder="arg0"> + <input message="tns:TestEndpoint_echo"/> + <output message="tns:TestEndpoint_echoResponse"/> + </operation> + </portType> + <binding name="TestEndpointBinding" type="tns:TestEndpoint"> + <soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/> + <operation name="echo"> + <soap:operation soapAction=""/> + <input> + <soap:body namespace="http://eardeployment.jaxws.ws.test.jboss.org/" use="literal"/> + </input> + <output> + <soap:body namespace="http://eardeployment.jaxws.ws.test.jboss.org/" use="literal"/> + </output> + </operation> + </binding> + <service name="TestEndpointService"> + <port binding="tns:TestEndpointBinding" name="TestEndpointPort"> + <soap:address location="http://localhost.localdomain:8080/earejb3/EJB3Bean"/> + </port> + </service> +</definitions> \ No newline at end of file Property changes on: trunk/src/test/resources/jaxws/eardeployment/META-INF/wsdl/TestEndpoint.wsdl ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF