< prev index next >

jaxws/src/java.xml.ws/share/classes/javax/xml/ws/Dispatch.java

Print this page


   1 /*
   2  * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.xml.ws;
  27 
  28 import java.util.concurrent.Future;
  29 

  30 /** The {@code Dispatch} interface provides support
  31  *  for the dynamic invocation of a service endpoint operations. The
  32  *  {@code javax.xml.ws.Service}
  33  *  class acts as a factory for the creation of {@code Dispatch}
  34  *  instances.
  35  *

  36  *  @since 1.6, JAX-WS 2.0
  37 **/
  38 public interface Dispatch<T> extends BindingProvider {
  39 
  40     /** Invoke a service operation synchronously.
  41      *
  42      * The client is responsible for ensuring that the {@code msg} object
  43      * when marshalled is formed according to the requirements of the protocol
  44      * binding in use.
  45      *
  46      * @param msg An object that will form the message or payload of
  47      *     the message used to invoke the operation.
  48      * @return The response message or message payload to the
  49      *     operation invocation.
  50      * @throws WebServiceException If a fault occurs during communication with
  51      *     the service
  52      * @throws WebServiceException If there is any error in the configuration of
  53      *     the {@code Dispatch} instance
  54     **/
  55     public T invoke(T msg);


   1 /*
   2  * Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.xml.ws;
  27 
  28 import java.util.concurrent.Future;
  29 
  30 
  31 /** The {@code Dispatch} interface provides support
  32  *  for the dynamic invocation of a service endpoint operations. The
  33  *  {@code javax.xml.ws.Service}
  34  *  class acts as a factory for the creation of {@code Dispatch}
  35  *  instances.
  36  *
  37  * @param <T> The type of the message or payload
  38  *  @since 1.6, JAX-WS 2.0
  39 **/
  40 public interface Dispatch<T> extends BindingProvider {
  41 
  42     /** Invoke a service operation synchronously.
  43      *
  44      * The client is responsible for ensuring that the {@code msg} object
  45      * when marshalled is formed according to the requirements of the protocol
  46      * binding in use.
  47      *
  48      * @param msg An object that will form the message or payload of
  49      *     the message used to invoke the operation.
  50      * @return The response message or message payload to the
  51      *     operation invocation.
  52      * @throws WebServiceException If a fault occurs during communication with
  53      *     the service
  54      * @throws WebServiceException If there is any error in the configuration of
  55      *     the {@code Dispatch} instance
  56     **/
  57     public T invoke(T msg);


< prev index next >