Java tutorial
/* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * * Copyright (c) 2004-2017 Oracle and/or its affiliates. All rights reserved. * * The contents of this file are subject to the terms of either the GNU * General Public License Version 2 only ("GPL") or the Common Development * and Distribution License("CDDL") (collectively, the "License"). You * may not use this file except in compliance with the License. You can * obtain a copy of the License at * https://oss.oracle.com/licenses/CDDL+GPL-1.1 * or LICENSE.txt. See the License for the specific * language governing permissions and limitations under the License. * * When distributing the software, include this License Header Notice in each * file and include the License file at LICENSE.txt. * * GPL Classpath Exception: * Oracle designates this particular file as subject to the "Classpath" * exception as provided by Oracle in the GPL Version 2 section of the License * file that accompanied this code. * * Modifications: * If applicable, add the following below the License Header, with the fields * enclosed by brackets [] replaced by your own identifying information: * "Portions Copyright [year] [name of copyright owner]" * * Contributor(s): * If you wish your version of this file to be governed by only the CDDL or * only the GPL Version 2, indicate your decision by adding "[Contributor] * elects to include this software in this distribution under the [CDDL or GPL * Version 2] license." If you don't indicate a single choice of license, a * recipient has the option to distribute your version of this file under * either the CDDL, the GPL Version 2 or to extend the choice of license to * its licensees as provided above. However, if you add GPL Version 2 code * and therefore, elected the GPL Version 2 license, then the option applies * only if the new code is made subject to such option by the copyright * holder. */ package javax.xml.soap; /** * A point-to-point connection that a client can use for sending messages * directly to a remote party (represented by a URL, for instance). * <p> * The SOAPConnection class is optional. Some implementations may * not implement this interface in which case the call to * {@code SOAPConnectionFactory.newInstance()} (see below) will * throw an {@code UnsupportedOperationException}. * <p> * A client can obtain a {@code SOAPConnection} object using a * {@link SOAPConnectionFactory} object as in the following example: * <pre>{@code * SOAPConnectionFactory factory = SOAPConnectionFactory.newInstance(); * SOAPConnection con = factory.createConnection(); * }</pre> * A {@code SOAPConnection} object can be used to send messages * directly to a URL following the request/response paradigm. That is, * messages are sent using the method {@code call}, which sends the * message and then waits until it gets a reply. * * @since 1.6 */ public abstract class SOAPConnection { /** * Sends the given message to the specified endpoint and blocks until * it has returned the response. * * @param request the {@code SOAPMessage} object to be sent * @param to an {@code Object} that identifies * where the message should be sent. It is required to * support Objects of type * {@code java.lang.String}, * {@code java.net.URL}, and when JAXM is present * {@code javax.xml.messaging.URLEndpoint} * * @return the {@code SOAPMessage} object that is the response to the * message that was sent * @throws SOAPException if there is a SOAP error */ public abstract SOAPMessage call(SOAPMessage request, Object to) throws SOAPException; /** * Gets a message from a specific endpoint and blocks until it receives, * * @param to an {@code Object} that identifies where * the request should be sent. Objects of type * {@code java.lang.String} and * {@code java.net.URL} must be supported. * * @return the {@code SOAPMessage} object that is the response to the * get message request * @throws SOAPException if there is a SOAP error * @since 1.6, SAAJ 1.3 */ public SOAPMessage get(Object to) throws SOAPException { throw new UnsupportedOperationException("All subclasses of SOAPConnection must override get()"); } /** * Closes this {@code SOAPConnection} object. * * @throws SOAPException if there is a SOAP error */ public abstract void close() throws SOAPException; }