Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/javax/xml/soap/SOAPConnection.java@0989ad8c0860 (annotated)
src/share/jaxws_classes/javax/xml/soap/SOAPConnection.java
Tue, 09 Apr 2013 14:51:13 +0100
- author
- alanb
- date
- Tue, 09 Apr 2013 14:51:13 +0100
- changeset 368
- 0989ad8c0860
- parent 286
- f50545b5e2f1
- child 637
- 9c07ef4934dd
- permissions
- -rw-r--r--
8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com
| ohair@286 | 1 | /* |
| alanb@368 | 2 | * Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved. |
| ohair@286 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| ohair@286 | 4 | * |
| ohair@286 | 5 | * This code is free software; you can redistribute it and/or modify it |
| ohair@286 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@286 | 7 | * published by the Free Software Foundation. Oracle designates this |
| ohair@286 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@286 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| ohair@286 | 10 | * |
| ohair@286 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| ohair@286 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| ohair@286 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| ohair@286 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| ohair@286 | 15 | * accompanied this code). |
| ohair@286 | 16 | * |
| ohair@286 | 17 | * You should have received a copy of the GNU General Public License version |
| ohair@286 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| ohair@286 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| ohair@286 | 20 | * |
| ohair@286 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@286 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@286 | 23 | * questions. |
| ohair@286 | 24 | */ |
| ohair@286 | 25 | |
| ohair@286 | 26 | package javax.xml.soap; |
| ohair@286 | 27 | |
| ohair@286 | 28 | |
| ohair@286 | 29 | /** |
| ohair@286 | 30 | * A point-to-point connection that a client can use for sending messages |
| ohair@286 | 31 | * directly to a remote party (represented by a URL, for instance). |
| ohair@286 | 32 | * <p> |
| ohair@286 | 33 | * The SOAPConnection class is optional. Some implementations may |
| ohair@286 | 34 | * not implement this interface in which case the call to |
| ohair@286 | 35 | * <code>SOAPConnectionFactory.newInstance()</code> (see below) will |
| ohair@286 | 36 | * throw an <code>UnsupportedOperationException</code>. |
| ohair@286 | 37 | * <p> |
| ohair@286 | 38 | * A client can obtain a <code>SOAPConnection</code> object using a |
| ohair@286 | 39 | * {@link SOAPConnectionFactory} object as in the following example: |
| ohair@286 | 40 | * <PRE> |
| ohair@286 | 41 | * SOAPConnectionFactory factory = SOAPConnectionFactory.newInstance(); |
| ohair@286 | 42 | * SOAPConnection con = factory.createConnection(); |
| ohair@286 | 43 | * </PRE> |
| ohair@286 | 44 | * A <code>SOAPConnection</code> object can be used to send messages |
| ohair@286 | 45 | * directly to a URL following the request/response paradigm. That is, |
| ohair@286 | 46 | * messages are sent using the method <code>call</code>, which sends the |
| ohair@286 | 47 | * message and then waits until it gets a reply. |
| ohair@286 | 48 | */ |
| ohair@286 | 49 | public abstract class SOAPConnection { |
| ohair@286 | 50 | |
| ohair@286 | 51 | /** |
| ohair@286 | 52 | * Sends the given message to the specified endpoint and blocks until |
| ohair@286 | 53 | * it has returned the response. |
| ohair@286 | 54 | * |
| ohair@286 | 55 | * @param request the <code>SOAPMessage</code> object to be sent |
| ohair@286 | 56 | * @param to an <code>Object</code> that identifies |
| ohair@286 | 57 | * where the message should be sent. It is required to |
| ohair@286 | 58 | * support Objects of type |
| ohair@286 | 59 | * <code>java.lang.String</code>, |
| ohair@286 | 60 | * <code>java.net.URL</code>, and when JAXM is present |
| ohair@286 | 61 | * <code>javax.xml.messaging.URLEndpoint</code> |
| ohair@286 | 62 | * |
| ohair@286 | 63 | * @return the <code>SOAPMessage</code> object that is the response to the |
| ohair@286 | 64 | * message that was sent |
| ohair@286 | 65 | * @throws SOAPException if there is a SOAP error |
| ohair@286 | 66 | */ |
| ohair@286 | 67 | public abstract SOAPMessage call(SOAPMessage request, |
| ohair@286 | 68 | Object to) throws SOAPException; |
| ohair@286 | 69 | |
| ohair@286 | 70 | /** |
| ohair@286 | 71 | * Gets a message from a specific endpoint and blocks until it receives, |
| ohair@286 | 72 | * |
| ohair@286 | 73 | * @param to an <code>Object</code> that identifies where |
| ohair@286 | 74 | * the request should be sent. Objects of type |
| ohair@286 | 75 | * <code>java.lang.String</code> and |
| ohair@286 | 76 | * <code>java.net.URL</code> must be supported. |
| ohair@286 | 77 | * |
| ohair@286 | 78 | * @return the <code>SOAPMessage</code> object that is the response to the |
| ohair@286 | 79 | * get message request |
| ohair@286 | 80 | * @throws SOAPException if there is a SOAP error |
| ohair@286 | 81 | * @since SAAJ 1.3 |
| ohair@286 | 82 | */ |
| ohair@286 | 83 | public SOAPMessage get(Object to) |
| ohair@286 | 84 | throws SOAPException { |
| ohair@286 | 85 | throw new UnsupportedOperationException("All subclasses of SOAPConnection must override get()"); |
| ohair@286 | 86 | } |
| ohair@286 | 87 | |
| ohair@286 | 88 | /** |
| ohair@286 | 89 | * Closes this <code>SOAPConnection</code> object. |
| ohair@286 | 90 | * |
| ohair@286 | 91 | * @throws SOAPException if there is a SOAP error |
| ohair@286 | 92 | */ |
| ohair@286 | 93 | public abstract void close() |
| ohair@286 | 94 | throws SOAPException; |
| ohair@286 | 95 | } |
