javax.xml.soap.SOAPConnection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of saaj-api
There is a newer version: 1.3.5
/*
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License).  You may not use this file except in
 * compliance with the License.
 * 
 * You can obtain a copy of the license at
 * https://glassfish.dev.java.net/public/CDDLv1.0.html.
 * See the License for the specific language governing
 * permissions and limitations under the License.
 * 
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at https://glassfish.dev.java.net/public/CDDLv1.0.html.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * you own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 * 
 * Copyright 2006 Sun Microsystems Inc. All Rights Reserved
 */
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).
 * 
 * The SOAPConnection class is optional. Some implementations may
 * not implement this interface in which case the call to
 * SOAPConnectionFactory.newInstance() (see below) will
 * throw an UnsupportedOperationException.
 * 

 * A client can obtain a SOAPConnection object using a
 * {@link SOAPConnectionFactory} object as in the following example:
 * 
 *      SOAPConnectionFactory factory = SOAPConnectionFactory.newInstance();
 *      SOAPConnection con = factory.createConnection();
 * 
 * A 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 call, which sends the
 * message and then waits until it gets a reply.
 */
public abstract class SOAPConnection {

    /**
     * Sends the given message to the specified endpoint and blocks until
     * it has returned the response.
     *
     * @param request the SOAPMessage object to be sent
     * @param to an Object that identifies
     *         where the message should be sent. It is required to
     *         support Objects of type
     *         java.lang.String,
     *         java.net.URL, and when JAXM is present
     *         javax.xml.messaging.URLEndpoint
     *
     * @return the 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 Object that identifies where
     *                  the request should be sent. Objects of type
     *                 java.lang.String and
     *                 java.net.URL must be supported.
     *
     * @return the SOAPMessage object that is the response to the
     *                  get message request
     * @throws SOAPException if there is a SOAP error
     * @since SAAJ 1.3
     */
    public SOAPMessage get(Object to)
                                throws SOAPException {
        throw new UnsupportedOperationException("All subclasses of SOAPConnection must override get()");
    }
    
    /**
     * Closes this SOAPConnection object.
     *
     * @throws SOAPException if there is a SOAP error
     */
    public abstract void close() 
        throws SOAPException; 
}