src/share/jaxws_classes/javax/xml/ws/Provider.java

Print this page
rev 507 : 8047724: @since tag cleanup in jaxws
Reviewed-by:


  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</code>
  30  *  interface as a dynamic alternative to an SEI.
  31  *
  32  *  <p>Implementations are required to support <code>Provider&lt;Source&gt;</code>,
  33  *  <code>Provider&lt;SOAPMessage&gt;</code> and
  34  *  <code>Provider&lt;DataSource&gt;</code>, depending on the binding
  35  *  in use and the service mode.
  36  *
  37  *  <p>The <code>ServiceMode</code> annotation can be used to control whether
  38  *  the <code>Provider</code> instance will receive entire protocol messages
  39  *  or just message payloads.
  40  *
  41  *  @since 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</code> if
  54               there is no response.
  55    *  @throws WebServiceException If there is an error processing request.
  56    *          The cause of the <code>WebServiceException</code> may be set to a subclass
  57    *          of <code>ProtocolException</code> to control the protocol level
  58    *          representation of the exception.
  59    *  @see javax.xml.ws.handler.MessageContext
  60    *  @see javax.xml.ws.ProtocolException
  61   **/


  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</code>
  30  *  interface as a dynamic alternative to an SEI.
  31  *
  32  *  <p>Implementations are required to support <code>Provider&lt;Source&gt;</code>,
  33  *  <code>Provider&lt;SOAPMessage&gt;</code> and
  34  *  <code>Provider&lt;DataSource&gt;</code>, depending on the binding
  35  *  in use and the service mode.
  36  *
  37  *  <p>The <code>ServiceMode</code> annotation can be used to control whether
  38  *  the <code>Provider</code> 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</code> if
  54               there is no response.
  55    *  @throws WebServiceException If there is an error processing request.
  56    *          The cause of the <code>WebServiceException</code> may be set to a subclass
  57    *          of <code>ProtocolException</code> to control the protocol level
  58    *          representation of the exception.
  59    *  @see javax.xml.ws.handler.MessageContext
  60    *  @see javax.xml.ws.ProtocolException
  61   **/