FileDocCategorySizeDatePackage
SOAPConnection.javaAPI DocJava SE 6 API3835Tue Jun 10 00:27:10 BST 2008javax.xml.soap

SOAPConnection

public abstract class SOAPConnection extends Object
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.

Fields Summary
Constructors Summary
Methods Summary
public abstract javax.xml.soap.SOAPMessagecall(javax.xml.soap.SOAPMessage request, java.lang.Object to)
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 voidclose()
Closes this SOAPConnection object.

throws
SOAPException if there is a SOAP error

public javax.xml.soap.SOAPMessageget(java.lang.Object to)
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

        throw new UnsupportedOperationException("All subclasses of SOAPConnection must override get()");