javax.xml.soap
Class SOAPConnection

java.lang.Object
  javax.xml.soap.SOAPConnection

Direct Known Subclasses:

SOAPConnectionImpl (src)

public abstract class SOAPConnection

extends java.lang.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 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.

SOAPConnection

public SOAPConnection()

call

public abstract SOAPMessage (src)  call(SOAPMessage (src)  request,
                                 java.lang.Object to)
                          throws SOAPException (src) 

Sends the given message to the specified endpoint and blocks until it has returned the response.

Parameters:

request - the SOAPMessage object to be sent

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

Returns:

the SOAPMessage object that is the response to the message that was sent

Throws:

SOAPException (src) - if there is a SOAP error

close

public abstract void close()
                    throws SOAPException (src) 

Closes this SOAPConnection object.

Throws:

SOAPException (src) - if there is a SOAP error