1 /*
   2  * Copyright (c) 2005, 2015, 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 /**
  29  *  <p>Service endpoints may implement the {@code Provider}
  30  *  interface as a dynamic alternative to an SEI.
  31  *
  32  *  <p>Implementations are required to support {@code Provider<Source>},
  33  *  {@code Provider<SOAPMessage>} and
  34  *  {@code Provider<DataSource>}, depending on the binding
  35  *  in use and the service mode.
  36  *
  37  *  <p>The {@code ServiceMode} annotation can be used to control whether
  38  *  the {@code Provider} instance will receive entire protocol messages
  39  *  or just message payloads.
  40  *
  41  *  @since 1.6, JAX-WS 2.0
  42  *
  43  *  @see javax.xml.transform.Source
  44  *  @see javax.xml.soap.SOAPMessage
  45  *  @see javax.xml.ws.ServiceMode
  46 **/
  47 public interface Provider<T> {
  48 
  49   /** Invokes an operation occording to the contents of the request
  50    *  message.
  51    *
  52    *  @param  request The request message or message payload.
  53    *  @return The response message or message payload. May be {@code null} if
  54               there is no response.
  55    *  @throws WebServiceException If there is an error processing request.
  56    *          The cause of the {@code WebServiceException} may be set to a subclass
  57    *          of {@code ProtocolException} to control the protocol level
  58    *          representation of the exception.
  59    *  @see javax.xml.ws.handler.MessageContext
  60    *  @see javax.xml.ws.ProtocolException
  61   **/
  62   public T invoke(T request);
  63 }