325N/A/*
325N/A * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/Apackage javax.xml.ws;
325N/A
325N/Aimport java.util.concurrent.Future;
325N/A
325N/A/** The <code>Dispatch</code> interface provides support
325N/A * for the dynamic invocation of a service endpoint operations. The
325N/A * <code>javax.xml.ws.Service</code>
325N/A * class acts as a factory for the creation of <code>Dispatch</code>
325N/A * instances.
325N/A *
325N/A * @since JAX-WS 2.0
325N/A**/
325N/Apublic interface Dispatch<T> extends BindingProvider {
325N/A
325N/A /** Invoke a service operation synchronously.
325N/A *
325N/A * The client is responsible for ensuring that the <code>msg</code> object
325N/A * when marshalled is formed according to the requirements of the protocol
325N/A * binding in use.
325N/A *
325N/A * @param msg An object that will form the message or payload of
325N/A * the message used to invoke the operation.
325N/A * @return The response message or message payload to the
325N/A * operation invocation.
325N/A * @throws WebServiceException If a fault occurs during communication with
325N/A * the service
325N/A * @throws WebServiceException If there is any error in the configuration of
325N/A * the <code>Dispatch</code> instance
325N/A **/
325N/A public T invoke(T msg);
325N/A
325N/A /** Invoke a service operation asynchronously. The
325N/A * method returns without waiting for the response to the operation
325N/A * invocation, the results of the operation are obtained by polling the
325N/A * returned <code>Response</code>.
325N/A * <p>
325N/A * The client is responsible for ensuring that the <code>msg</code> object
325N/A * when marshalled is formed according to the requirements of the protocol
325N/A * binding in use.
325N/A *
325N/A * @param msg An object that will form the message or payload of
325N/A * the message used to invoke the operation.
325N/A * @return The response message or message payload to the
325N/A * operation invocation.
325N/A * @throws WebServiceException If there is any error in the configuration of
325N/A * the <code>Dispatch</code> instance
325N/A **/
325N/A public Response<T> invokeAsync(T msg);
325N/A
325N/A /** Invoke a service operation asynchronously. The
325N/A * method returns without waiting for the response to the operation
325N/A * invocation, the results of the operation are communicated to the client
325N/A * via the passed in <code>handler</code>.
325N/A * <p>
325N/A * The client is responsible for ensuring that the <code>msg</code> object
325N/A * when marshalled is formed according to the requirements of the protocol
325N/A * binding in use.
325N/A *
325N/A * @param msg An object that will form the message or payload of
325N/A * the message used to invoke the operation.
325N/A * @param handler The handler object that will receive the
325N/A * response to the operation invocation.
325N/A * @return A <code>Future</code> object that may be used to check the status
325N/A * of the operation invocation. This object MUST NOT be used to try to
325N/A * obtain the results of the operation - the object returned from
325N/A * <code>Future&lt;?>.get()</code> is implementation dependent
325N/A * and any use of it will result in non-portable behaviour.
325N/A * @throws WebServiceException If there is any error in the configuration of
325N/A * the <code>Dispatch</code> instance
325N/A **/
325N/A public Future<?> invokeAsync(T msg, AsyncHandler<T> handler);
325N/A
325N/A /** Invokes a service operation using the one-way
325N/A * interaction mode. The operation invocation is logically non-blocking,
325N/A * subject to the capabilities of the underlying protocol, no results
325N/A * are returned. When
325N/A * the protocol in use is SOAP/HTTP, this method MUST block until
325N/A * an HTTP response code has been received or an error occurs.
325N/A * <p>
325N/A * The client is responsible for ensuring that the <code>msg</code> object
325N/A * when marshalled is formed according to the requirements of the protocol
325N/A * binding in use.
325N/A *
325N/A * @param msg An object that will form the message or payload of
325N/A * the message used to invoke the operation.
325N/A * @throws WebServiceException If there is any error in the configuration of
325N/A * the <code>Dispatch</code> instance or if an error occurs during the
325N/A * invocation.
325N/A **/
325N/A public void invokeOneWay(T msg);
325N/A}