aoqi@0: /* aoqi@0: * Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved. aoqi@0: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. aoqi@0: * aoqi@0: * This code is free software; you can redistribute it and/or modify it aoqi@0: * under the terms of the GNU General Public License version 2 only, as aoqi@0: * published by the Free Software Foundation. Oracle designates this aoqi@0: * particular file as subject to the "Classpath" exception as provided aoqi@0: * by Oracle in the LICENSE file that accompanied this code. aoqi@0: * aoqi@0: * This code is distributed in the hope that it will be useful, but WITHOUT aoqi@0: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or aoqi@0: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License aoqi@0: * version 2 for more details (a copy is included in the LICENSE file that aoqi@0: * accompanied this code). aoqi@0: * aoqi@0: * You should have received a copy of the GNU General Public License version aoqi@0: * 2 along with this work; if not, write to the Free Software Foundation, aoqi@0: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. aoqi@0: * aoqi@0: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA aoqi@0: * or visit www.oracle.com if you need additional information or have any aoqi@0: * questions. aoqi@0: */ aoqi@0: aoqi@0: package javax.xml.soap; aoqi@0: aoqi@0: aoqi@0: /** aoqi@0: * A point-to-point connection that a client can use for sending messages aoqi@0: * directly to a remote party (represented by a URL, for instance). aoqi@0: *
aoqi@0: * The SOAPConnection class is optional. Some implementations may
aoqi@0: * not implement this interface in which case the call to
aoqi@0: * SOAPConnectionFactory.newInstance()
(see below) will
aoqi@0: * throw an UnsupportedOperationException
.
aoqi@0: *
aoqi@0: * A client can obtain a SOAPConnection
object using a
aoqi@0: * {@link SOAPConnectionFactory} object as in the following example:
aoqi@0: *
aoqi@0: * SOAPConnectionFactory factory = SOAPConnectionFactory.newInstance(); aoqi@0: * SOAPConnection con = factory.createConnection(); aoqi@0: *aoqi@0: * A
SOAPConnection
object can be used to send messages
aoqi@0: * directly to a URL following the request/response paradigm. That is,
aoqi@0: * messages are sent using the method call
, which sends the
aoqi@0: * message and then waits until it gets a reply.
aoqi@0: */
aoqi@0: public abstract class SOAPConnection {
aoqi@0:
aoqi@0: /**
aoqi@0: * Sends the given message to the specified endpoint and blocks until
aoqi@0: * it has returned the response.
aoqi@0: *
aoqi@0: * @param request the SOAPMessage
object to be sent
aoqi@0: * @param to an Object
that identifies
aoqi@0: * where the message should be sent. It is required to
aoqi@0: * support Objects of type
aoqi@0: * java.lang.String
,
aoqi@0: * java.net.URL
, and when JAXM is present
aoqi@0: * javax.xml.messaging.URLEndpoint
aoqi@0: *
aoqi@0: * @return the SOAPMessage
object that is the response to the
aoqi@0: * message that was sent
aoqi@0: * @throws SOAPException if there is a SOAP error
aoqi@0: */
aoqi@0: public abstract SOAPMessage call(SOAPMessage request,
aoqi@0: Object to) throws SOAPException;
aoqi@0:
aoqi@0: /**
aoqi@0: * Gets a message from a specific endpoint and blocks until it receives,
aoqi@0: *
aoqi@0: * @param to an Object
that identifies where
aoqi@0: * the request should be sent. Objects of type
aoqi@0: * java.lang.String
and
aoqi@0: * java.net.URL
must be supported.
aoqi@0: *
aoqi@0: * @return the SOAPMessage
object that is the response to the
aoqi@0: * get message request
aoqi@0: * @throws SOAPException if there is a SOAP error
aoqi@0: * @since SAAJ 1.3
aoqi@0: */
aoqi@0: public SOAPMessage get(Object to)
aoqi@0: throws SOAPException {
aoqi@0: throw new UnsupportedOperationException("All subclasses of SOAPConnection must override get()");
aoqi@0: }
aoqi@0:
aoqi@0: /**
aoqi@0: * Closes this SOAPConnection
object.
aoqi@0: *
aoqi@0: * @throws SOAPException if there is a SOAP error
aoqi@0: */
aoqi@0: public abstract void close()
aoqi@0: throws SOAPException;
aoqi@0: }