Java tutorial
/* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * * Copyright (c) 2005-2017 Oracle and/or its affiliates. All rights reserved. * * The contents of this file are subject to the terms of either the GNU * General Public License Version 2 only ("GPL") or the Common Development * and Distribution License("CDDL") (collectively, the "License"). You * may not use this file except in compliance with the License. You can * obtain a copy of the License at * https://oss.oracle.com/licenses/CDDL+GPL-1.1 * or LICENSE.txt. See the License for the specific * language governing permissions and limitations under the License. * * When distributing the software, include this License Header Notice in each * file and include the License file at LICENSE.txt. * * GPL Classpath Exception: * Oracle designates this particular file as subject to the "Classpath" * exception as provided by Oracle in the GPL Version 2 section of the License * file that accompanied this code. * * Modifications: * If applicable, add the following below the License Header, with the fields * enclosed by brackets [] replaced by your own identifying information: * "Portions Copyright [year] [name of copyright owner]" * * Contributor(s): * If you wish your version of this file to be governed by only the CDDL or * only the GPL Version 2, indicate your decision by adding "[Contributor] * elects to include this software in this distribution under the [CDDL or GPL * Version 2] license." If you don't indicate a single choice of license, a * recipient has the option to distribute your version of this file under * either the CDDL, the GPL Version 2 or to extend the choice of license to * its licensees as provided above. However, if you add GPL Version 2 code * and therefore, elected the GPL Version 2 license, then the option applies * only if the new code is made subject to such option by the copyright * holder. */ package javax.xml.ws; import java.util.concurrent.Future; /** The {@code Dispatch} interface provides support * for the dynamic invocation of a service endpoint operations. The * {@code javax.xml.ws.Service} * class acts as a factory for the creation of {@code Dispatch} * instances. * * @param <T> The type of the message or payload * @since 1.6, JAX-WS 2.0 **/ public interface Dispatch<T> extends BindingProvider { /** Invoke a service operation synchronously. * * The client is responsible for ensuring that the {@code msg} object * when marshalled is formed according to the requirements of the protocol * binding in use. * * @param msg An object that will form the message or payload of * the message used to invoke the operation. * @return The response message or message payload to the * operation invocation. * @throws WebServiceException If a fault occurs during communication with * the service * @throws WebServiceException If there is any error in the configuration of * the {@code Dispatch} instance **/ public T invoke(T msg); /** Invoke a service operation asynchronously. The * method returns without waiting for the response to the operation * invocation, the results of the operation are obtained by polling the * returned {@code Response}. * <p> * The client is responsible for ensuring that the {@code msg} object * when marshalled is formed according to the requirements of the protocol * binding in use. * * @param msg An object that will form the message or payload of * the message used to invoke the operation. * @return The response message or message payload to the * operation invocation. * @throws WebServiceException If there is any error in the configuration of * the {@code Dispatch} instance **/ public Response<T> invokeAsync(T msg); /** Invoke a service operation asynchronously. The * method returns without waiting for the response to the operation * invocation, the results of the operation are communicated to the client * via the passed in {@code handler}. * <p> * The client is responsible for ensuring that the {@code msg} object * when marshalled is formed according to the requirements of the protocol * binding in use. * * @param msg An object that will form the message or payload of * the message used to invoke the operation. * @param handler The handler object that will receive the * response to the operation invocation. * @return A {@code Future} object that may be used to check the status * 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()} is implementation dependent * and any use of it will result in non-portable behaviour. * @throws WebServiceException If there is any error in the configuration of * the {@code Dispatch} instance **/ public Future<?> invokeAsync(T msg, AsyncHandler<T> handler); /** Invokes a service operation using the one-way * 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 * an HTTP response code has been received or an error occurs. * <p> * The client is responsible for ensuring that the {@code msg} object * when marshalled is formed according to the requirements of the protocol * binding in use. * * @param msg An object that will form the message or payload of * the message used to invoke the operation. * @throws WebServiceException If there is any error in the configuration of * the {@code Dispatch} instance or if an error occurs during the * invocation. **/ public void invokeOneWay(T msg); }