Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/javax/xml/ws/Provider.java@f453f4eaf8b4 (annotated)
src/share/jaxws_classes/javax/xml/ws/Provider.java
Tue, 07 Nov 2017 18:54:04 -0800
- author
- asaha
- date
- Tue, 07 Nov 2017 18:54:04 -0800
- changeset 1528
- f453f4eaf8b4
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
Added tag jdk8u162-b06 for changeset 6095742f8034
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package javax.xml.ws; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | /** |
| aoqi@0 | 29 | * <p>Service endpoints may implement the <code>Provider</code> |
| aoqi@0 | 30 | * interface as a dynamic alternative to an SEI. |
| aoqi@0 | 31 | * |
| aoqi@0 | 32 | * <p>Implementations are required to support <code>Provider<Source></code>, |
| aoqi@0 | 33 | * <code>Provider<SOAPMessage></code> and |
| aoqi@0 | 34 | * <code>Provider<DataSource></code>, depending on the binding |
| aoqi@0 | 35 | * in use and the service mode. |
| aoqi@0 | 36 | * |
| aoqi@0 | 37 | * <p>The <code>ServiceMode</code> annotation can be used to control whether |
| aoqi@0 | 38 | * the <code>Provider</code> instance will receive entire protocol messages |
| aoqi@0 | 39 | * or just message payloads. |
| aoqi@0 | 40 | * |
| aoqi@0 | 41 | * @since JAX-WS 2.0 |
| aoqi@0 | 42 | * |
| aoqi@0 | 43 | * @see javax.xml.transform.Source |
| aoqi@0 | 44 | * @see javax.xml.soap.SOAPMessage |
| aoqi@0 | 45 | * @see javax.xml.ws.ServiceMode |
| aoqi@0 | 46 | **/ |
| aoqi@0 | 47 | public interface Provider<T> { |
| aoqi@0 | 48 | |
| aoqi@0 | 49 | /** Invokes an operation occording to the contents of the request |
| aoqi@0 | 50 | * message. |
| aoqi@0 | 51 | * |
| aoqi@0 | 52 | * @param request The request message or message payload. |
| aoqi@0 | 53 | * @return The response message or message payload. May be <code>null</code> if |
| aoqi@0 | 54 | there is no response. |
| aoqi@0 | 55 | * @throws WebServiceException If there is an error processing request. |
| aoqi@0 | 56 | * The cause of the <code>WebServiceException</code> may be set to a subclass |
| aoqi@0 | 57 | * of <code>ProtocolException</code> to control the protocol level |
| aoqi@0 | 58 | * representation of the exception. |
| aoqi@0 | 59 | * @see javax.xml.ws.handler.MessageContext |
| aoqi@0 | 60 | * @see javax.xml.ws.ProtocolException |
| aoqi@0 | 61 | **/ |
| aoqi@0 | 62 | public T invoke(T request); |
| aoqi@0 | 63 | } |
