1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/jaxws_classes/javax/xml/soap/SOAPConnection.java Tue Mar 06 16:09:35 2012 -0800
1.3 @@ -0,0 +1,95 @@
1.4 +/*
1.5 + * Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package javax.xml.soap;
1.30 +
1.31 +
1.32 +/**
1.33 + * A point-to-point connection that a client can use for sending messages
1.34 + * directly to a remote party (represented by a URL, for instance).
1.35 + * <p>
1.36 + * The SOAPConnection class is optional. Some implementations may
1.37 + * not implement this interface in which case the call to
1.38 + * <code>SOAPConnectionFactory.newInstance()</code> (see below) will
1.39 + * throw an <code>UnsupportedOperationException</code>.
1.40 + * <p>
1.41 + * A client can obtain a <code>SOAPConnection</code> object using a
1.42 + * {@link SOAPConnectionFactory} object as in the following example:
1.43 + * <PRE>
1.44 + * SOAPConnectionFactory factory = SOAPConnectionFactory.newInstance();
1.45 + * SOAPConnection con = factory.createConnection();
1.46 + * </PRE>
1.47 + * A <code>SOAPConnection</code> object can be used to send messages
1.48 + * directly to a URL following the request/response paradigm. That is,
1.49 + * messages are sent using the method <code>call</code>, which sends the
1.50 + * message and then waits until it gets a reply.
1.51 + */
1.52 +public abstract class SOAPConnection {
1.53 +
1.54 + /**
1.55 + * Sends the given message to the specified endpoint and blocks until
1.56 + * it has returned the response.
1.57 + *
1.58 + * @param request the <code>SOAPMessage</code> object to be sent
1.59 + * @param to an <code>Object</code> that identifies
1.60 + * where the message should be sent. It is required to
1.61 + * support Objects of type
1.62 + * <code>java.lang.String</code>,
1.63 + * <code>java.net.URL</code>, and when JAXM is present
1.64 + * <code>javax.xml.messaging.URLEndpoint</code>
1.65 + *
1.66 + * @return the <code>SOAPMessage</code> object that is the response to the
1.67 + * message that was sent
1.68 + * @throws SOAPException if there is a SOAP error
1.69 + */
1.70 + public abstract SOAPMessage call(SOAPMessage request,
1.71 + Object to) throws SOAPException;
1.72 +
1.73 + /**
1.74 + * Gets a message from a specific endpoint and blocks until it receives,
1.75 + *
1.76 + * @param to an <code>Object</code> that identifies where
1.77 + * the request should be sent. Objects of type
1.78 + * <code>java.lang.String</code> and
1.79 + * <code>java.net.URL</code> must be supported.
1.80 + *
1.81 + * @return the <code>SOAPMessage</code> object that is the response to the
1.82 + * get message request
1.83 + * @throws SOAPException if there is a SOAP error
1.84 + * @since SAAJ 1.3
1.85 + */
1.86 + public SOAPMessage get(Object to)
1.87 + throws SOAPException {
1.88 + throw new UnsupportedOperationException("All subclasses of SOAPConnection must override get()");
1.89 + }
1.90 +
1.91 + /**
1.92 + * Closes this <code>SOAPConnection</code> object.
1.93 + *
1.94 + * @throws SOAPException if there is a SOAP error
1.95 + */
1.96 + public abstract void close()
1.97 + throws SOAPException;
1.98 +}
