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